xpxValidateWhereRuleWithParameters



FUNCTION xpxValidateWhereRuleWithParameters    (currInst                   : GENERIC;
                                                whereRuleId                : GENERIC;
                                                userOutputFile             : STRING;
                                                VAR result                 : LOGICAL;  
                                                VAR returnValue            : GENERIC;
                                                numberOfParameters         : INTEGER;
                                                argument1, ... , argumentN : GENERIC)
                                                status                     : INTEGER;

Invokes the EDMmodelChecker to validate the specified instance against the specified local rule (Where rule). The specified local rule must be defined in the dictionary model (Express schema) that is the underlying schema of the data model that hosts the actual instance, or the local rule must be defined in an EDMruleSchema appropriate to the specified instance.  The validation process can return additional information to the application through the <returnValue> argument. The data model that hosts the specified instance must be open before this operation can be successfully performed. The expressions logging can be used to log (trace) the execution of the local rule in the EDMexpressVM. The EDMsupervisor and the interactive EDMdebugger can be used for testing and debugging local rules as well as getting detailed information of a validation process.

Arguments


TypeNameComment
GENERICcurrInstA numeric instanceID that uniquely identifies the instance in the EDMdatabase to be validated.
GENERICwhereRuleIdA numeric whereID that uniquely identifies a local rule (Where rule) in the EDMdatabase to use in the current validation process.
STRINGuserOutputFileSpecifies the name of a file that will be used to receive the result of executing the xpxPrintf and xpxOutputValue function during the validation operation. The specified file can be an existing file or the name of a file that will be created by the EDMmodelChecker. The default file extension is ".txt".  The output from the xpxPrintf and xpxOutputValue function during the validation process will be written to the EDMinterface current output device when the <userOutputFile> is set to NULL.
LOGICALresult

Address of a LOGICAL variable that will receive the result of the validation operation. The returned result is as follows:

  • TRUE: No local rule violation
  • FALSE: Actual instanceID violates specified local rule.
  • UNKNOWN: Unpredictable result due to unset values or error in operation.
GENERICreturnValueAddress of variable that will receive the value from the actual validation process. The actual value must be specified by invoking the xpxReturnValueToCaller procedure in the validation process in the EDMexpressVM
INTEGERnumberOfParametersSpecifies the number of parameters supplied in the actual invocation of the operation.
GENERICargument(n)Actual parameter value.

Return Value


Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'US:_r_XPX_Return_Value'.

Options


 

Example


<Missing Example>

 

See also

Filter by label

There are no items with the selected labels at this time.