XPRMgetnextdsoparam
XPRMgetnextdsoparam |
Purpose
Synopsis
void *XPRMgetnextdsoparam(XPRMdsolib dso, void *ref, const char **name, const char **desc, int *type);
Arguments
|
dso
|
Reference to a dynamic shared object loaded by Mosel or
NULL
|
|
ref
|
Reference pointer or
NULL
|
|
name
|
Returned name of the control parameter
|
|
desc
|
Returned description of the control parameter
|
|
type
|
Returned type of the control parameter
|
Return value
Reference pointer for the next call to
XPRMgetnextdsoparam.
Further information
This function returns the next control parameter of the given module. If the argument
dso is
NULL, the function returns Mosel control parameters. The second parameter is used to store the current location in the table of control parameters; if this parameter is
NULL, the first control parameter of the table is returned. This function returns
NULL if it is called with the reference to the last parameter of the given module. Otherwise, the returned value can be used as the input parameter
ref to get the following control parameter and so on. The type can be decoded using the macro
XPRM_TYP. Moreover, the bits
XPRM_CPAR_READ and
XPRM_CPAR_WRITE are set to indicate if the parameter can be read or written respectively (using
getparam and
setparam). The parameter
desc is a textual description of the function of the parameter — this information is not necessarily available (that is, it may be
NULL or an empty string). Note that not all modules implement the required functionality for enumerating control parameters.
Related topics