Initializing help system before first use

dsotyptostr

Purpose
Get a string representation from a module or union type reference.
Synopsis
int dsotyptostr(XPRMcontext ctx,int type, void *value, char *str, int size);
Arguments
ctx 
Mosel's execution context
type 
Code of the external type
value 
Entity to convert
str 
Destination buffer
size 
Size of str
Return value
Size of the generated string (excluding the terminating null byte) , -1 in case of error or -2 if the feature is not supported by the type.
Further information
1. This function calls directly the tostring routine of the module (see Section Table of types). It is therefore recommended to check whether the type supports this functionality before using this function (see gettypeprop).
2. The returned length might be larger than size-1. In this case this return value is the minimum buffer size (not including the terminating null byte) required to generate the text representation and the destination string str is not populated.
3. The flag XPRM_TFSTR_BIN might be added to the type code in order to retrieve a binary representation of the object.
4. This function may also be applied to a union type. In this case the current value stored in the union is converted to its textual representation. The symbol "?" will be returned if the union is not defined, and -2 will be returned if the value is not a scalar or if the corresponding type does not support conversion to string.
Related topics
gettypeprop, dsotypfromstr.

Parent Topic Module types access

© 2001-2025 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.