Initializing help system before first use

getdsoctx

getdsoctx


Purpose
Get the running context and IMCI interface of a module.
Synopsis
void **getdsoctx(XPRMcontext ctx, XPRMdsolib dso, void **imci);
Arguments
ctx 
Mosel's execution context
dso 
Reference to a dynamic shared object loaded by Mosel
imci 
Reference to a pointer where to store the IMCI entry of the module (may be NULL)
Return value
The reference to the location where the context of the module is (will be) stored or NULL if the running model does not use this module.
Further information
1. This function may be used for inter-module communication. It returns the location where the module context is stored. The context may not be available when this function is called if the module has not yet been initialized, this is likely to happen when getdsoctx is called from within a reset function and no priority has been defined for the module (see Section Service ``Module priority''). In this case the return value is a valid pointer to NULL that will be updated after the requested module is initialized.
2. If the last parameter is not NULL, it is used to return the value of the service XPRM_SRV_IMCI of the given module. Note that the function will populate this parameter even if it returns NULL.