sdaiValidateWhereRule


Note: This function can only be used with the EDMmodelChecker license key fully installed.
This operation validates the specified where rule. The scope for this validation will be the data model that holds the instance specified by the <instance> argument.
This operation is applicable only to application instances.
The model that holds the actual instance must be open before this operation can be successfully performed.
Related functions: sdaiValidateInstance , edmiValidateInstance , edmiValidateInstanceType , edmiValidateInstanceTypeBN , edmiValidateModel , edmiValidateModelBN , edmiValidateWhereRule , edmiValidateWhereRuleBN
Header:
#include "sdai.h"
Prototype:
SdaiLogical sdaiValidateWhereRule(SdaiAppInstance   instance,
                                   SdaiWhereRule     rule); 
Arguments:

instance

A numeric instanceID that uniquely identifies the instance of interest in the EDMdatabase, that is the instance that defined the data model to be validated for violation of the specified where rule <rule>.
The instanceID is defined by a sdaiCreateInstance or a sdaiCreateInstanceBN function.

rule

A numeric ruleID that uniquely identifies the where rule in the EDMdatabase that will be validated by this operation.

Returns:
A SdaiLogical value that has the following value:
sdaiTRUE : No violation of the specified where rule..
sdaiFALSE: The specified where rule is violated in the actual model.
sdaiUNKNOWN: Use sdaiErrorQuery to check for error in operation.
EXAMPLE
SdaiAppInstance anInst;
SdaiLogical result;
SdaiWhereRule whereRuleId;
. . .
result = sdaiValidateWhereRule (anInst, whereRuleId);
switch (result) {
case sdaiTRUE: 
. . . /* No violation in operation */ 
break; 
case sdaiFALSE: 
. . . /* Violation detected */ 
break; 
default: 
. . . /* Unpredictable result */ 
break; 
}
. . .