Initializing help system before first use

XPRMrunmod

Purpose
Run a model.
Synopsis
int XPRMrunmod(XPRMmodel model, int *exitcode, const char *parlist);
Arguments
model 
Reference to a model
exitcode 
Pointer to an area where the model exit code value is returned
parlist 
String composed of model parameter initializations separated by commas, may be NULL
Return value
Execution status. Possible values are:
XPRM_RT_OK 
Normal termination
XPRM_RT_ERROR 
An error occured during execution
XPRM_RT_MATHERR 
Mathematical error ( e.g. division by zero)
XPRM_RT_IOERR 
Input/output error ( e.g. cannot open file)
XPRM_RT_NULL 
A NULL reference error occurred
XPRM_RT_LICERR 
Execution could not start because no license was available
XPRM_RT_STOP 
Bit set if execution has been interrupted
XPRM_RT_BREAK 
Interruption because of a breakpoint (see Section Debugger interface)
Further information
1. This function executes the given model. The parameter parlist may be used to initialize the model parameters of the program as well as the control parameters of the modules and packages in use ( e.g. "PAR1=12,mypkg.par='tutu'"). The special model parameter workdir defines the initial working directory of the model.
2. In the return value, the bit XPRM_RT_STOP is set if the execution of the model has been interrupted by a call to the function XPRMstoprunmod.
3. The parameter exitcode receives the result of the execution ( i.e. parameter value of the ``exit'' procedure or 0 if the routine was not called), its value is meaningful only when the execution succeeded ( i.e. the status is XPRM_RT_OK).
Related topics
XPRMdbg_runmod, XPRMisrunmod, XPRMstoprunmod, XPRMaddparamstr.

Parent Topic General

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