Initializing help system before first use

dsotypfromstr

Purpose
Initialise an object of a module or union type using a string.
Synopsis
int dsotypfromstr(XPRMcontext ctx,int type, void *ref,const char *str,const char **end);
Arguments
ctx 
Mosel's execution context
type 
Code of the external type
ref 
Entity to initialise (must not be NULL)
str 
Initialisation string
end 
Reference to return a pointer after the last character used (can be NULL)
Return value
0 if successful, 1 in case of error or 2 if the feature is not supported by the type.
Further information
1. This function calls directly the fromstring 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 flag XPRM_TFSTR_BIN might be added to the type code in order to process a binary representation of the object. In this mode the end pointer must reference the first byte after the data buffer (such that *end-str is the size of the buffer).
3. This function may also be used to initialize a union type. In this case the conversion is performed as if the union was of its first compatible type (the value of the union is switched to this type if necessary). The operation will fail if this type cannot be initialized from a string.
Related topics
gettypeprop, dsotyptostr.

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.