Initializing help system before first use

dsotypfromstr

dsotypfromstr


Purpose
Initialise an object of a module 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 otherwise.
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).
Related topics