Initializing help system before first use

XPRMgetnextdsoparam

XPRMgetnextdsoparam

Purpose
Get the next control parameter in the list of the given module.
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
XPRMgetnextdsoconst, XPRMgetnextdsoproc, XPRMgetnextdsotype XPRMgetnextiodrv.

Parent Topic Handling of modules

© 2001-2020 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.