xpfValidateWhereRuleWithParametersBN

FUNCTION xpfValidateWhereRuleWithParametersBN (currInst                   : GENERIC;
                                               whereRuleName              : STRING;
                                               ruleSchemaId               : GENERIC;
                                               userOutputFile             : STRING;
                                               VAR returnValue            : GENERIC;
                                               numberOfParameters         : INTEGER;
                                               argument1, ... , argumentN : GENERIC)
                                               result                     : INTEGER;

Invokes the EDMmodelCheckerTM 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. A number of arguments can be supplied to the "where rule validation process" in the arguments argument1, ?, argumentN. Hence the validation process can accept parameters. The validation process can return a value to the caller through the returnValue argument. The value to return must be set in the validation process by invoking the xpxReturnValueToCaller operation. The data model that hosts the specified instance must be open before this operation can be successfully performed.

See related functions: xpxGetNumberOfUserParameters, xpxGetUserParameter

 

Arguments


TypeNameComment
GENERIC

currInst

A numeric Id that uniquely identifies the instance in the EDMdatabase

STRING

whereRuleName

The name of the where rule

GENERICruleSchemaIdA numeric Id that uniquely identifies the rule schema in the EDMdatabase
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. 

GENERICreturnValue 
INTEGERnumberOfParametersNumber of arguments to be sent to the validation process
GENERICargument(n)Arguments to be sent to the validation process

Return Value


 

TypeNameComment
INTEGERresultcomments

Options


 

Example


<Missing Example>

 

See also

Filter by label

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

Â