sdaiValidateWhereRuleBN

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 sdaiValidateWhereRuleBN(SdaiAppInstance instance,
SdaiString ruleName);
Arguments:

instance

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

ruleName

The name of the actual where rule. Where rule names are case insensitive.

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;
. . .
result = sdaiValidateWhereRuleBN (anInst, "Wr1");
switch (result) {
case sdaiTRUE:
. . . /* No violation in operation */
break;
case sdaiFALSE:
. . . /* Violation detected */
break;
default:
. . . /* Unpredictable result */
break;
}
. . .