...
SYNTAX:
xpxValidateGlobalRuleWithParametersBN (modelId : GENERIC;
globalRuleName : STRING; ruleSchemaId : GENERIC; userOutputFile : STRING;VAR result : LOGICAL;VAR returnValue : GENERIC; numberOfParameters : INTEGER; argument1 : GENERIC;... ... argumentN : GENERIC)status : INTEGER;
Invokes the EDMmodelChecker
| Code Block | ||||
|---|---|---|---|---|
| ||||
FUNCTION xpxValidateGlobalRuleWithParametersBN (modelId : GENERIC;
globalRuleName : 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 data model against the specified global rule. The specified global rule must be defined in the dictionary model (Express schema) that is the underlying schema of the specified data model, or the global rule must be defined in an EDMruleSchema appropriate to the specified data model.
A number of arguments can be supplied to the ?"global rule validation process? " in the arguments argument1, ?, argumentN . Hence the validation process can be made parameterized. 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 actual data model must be open before this operation can be successfully performed.
See related functions: xpxGetNumberOfUserParameters, xpxGetUserParameter
This function is equivalent to the EDMinterface function edmiValidateGlobalRuleWithParametersBN..
Arguments
...
| Type | Name | Comment |
| GENERIC | modelId | A numeric modelID that uniquely identifies the data model of interest in the EDMdatabase . |
| STRING | globalRuleName | Specifies the global rule to validate. Global rule names are case insensitive. Dependent of the <ruleSchemaId> argument, the actual global rule must be defined in the dictionary model (Express schema) that are the underlying schema of the <modelId> data model, or in the specified EDMruleSchema. |
| GENERIC | ruleSchemaId | A numeric ruleSchemaID that uniquely identifies the rule schema instance in the EDMdatabase that defines the global rule specified in the <globalRuleName> argument. The specified global rule must be defined in the dictionary model (Express schema) that is the underlying schema of the specified data model <modelId> if the <ruleSchemaId> is set to zero. The ruleSchemaID can be retrieved by the xpfGetRuleSchema operation. |
| STRING | userOutputFile | Specifies the name of a file that will be used to receive the result of executing the xpxPrintf and xpxOutputValue function in the actual global rule. 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 of the xpxPrintf and xpxOutputValue function in the actual global rule 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:
|
| GENERIC | returnValue | Address of a variable of type PrimitiveType that is used both as an input argument and an output argument:
|
| INTEGER | numberOfParameters | Specifies the number of parameters supplied in the actual invocation of the operation. For each parameter the following two arguments must be specified in this order: |
| GENERIC | argument/n) | Argument parameters |
Return Value
...
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
Options
...
Example
...
| Code Block | ||
|---|---|---|
| ||
<Missing Example> |
See also
| Filter by label (Content by label) | ||||||
|---|---|---|---|---|---|---|
|