xpxValidateWhereRuleWithParametersBN

FUNCTION xpxValidateWhereRuleWithParametersBN  (currInst                   : GENERIC;
                                                whereRuleName              : STRING;
                                                ruleSchemaId               : 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

Type	Name	Comment
GENERIC	currInst	A numeric instanceID that uniquely identifies the instance in the EDMdatabase to be validated.
STRING	whereRuleName	The name of the actual local rule (Where rule) to validate. Where rule names are case insensitive. When the <whereRuleName> is not unique within the specified instance, then the <whereRuleName> should be qualified with the name of the entity or defined type that declares the actual where rule.
GENERIC	ruleSchemaId	A numeric ruleSchemaID that uniquely identifies the rule schema instance in the EDMdatabase that defines the local rule specified in the <whereRuleName> argument. The specified where rule must be defined in the dictionary model (Express schema) that is the underlying schema of the data model that hosts the specified instance <instance> if the <ruleSchemaId> is set to zero.
STRING	userOutputFile	Specifies 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.
LOGICAL	result	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.
GENERIC	returnValue	Address 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
INTEGER	numberOfParameters	Specifies the number of parameters supplied in the actual invocation of the operation.
GENERIC	argument(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>

Arguments

Return Value

Options

Example

See also

Filter by label