edmiValidateWhereRule

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.
This operation is the same as the edmiValidateWhereRule except that the actual application can supply arguments to the validation process, hence making the validation process parameterized. 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.
Related functions: edmiValidateWhereRuleBN, edmiValidateWhereRuleWithParameters, edmiValidateWhereRuleWithParametersBN, edmiValidateGlobalRule , edmiValidateGlobalRuleBN , edmiValidateGlobalRuleWithParameters, edmiValidateGlobalRuleWithParametersBN, edmiValidateInstance , edmiValidateInstanceWithParameters, edmiValidateInstanceType , edmiValidateInstanceTypeBN , edmiValidateInstanceTypeWithParameters, edmiValidateInstanceTypeWithParametersBN, edmiValidateModel , edmiValidateModelBN , edmiValidateModelWithParameters, edmiValidateModelWithParametersBN, edmiDefineRuleSchema
Header:
#include "sdai.h"
Prototype:
EdmiError edmiValidateWhereRule(SdaiAppInstance instance,
                                 SdaiWhereRule   whereRuleId,
                                 SdaiString      userOutputFile,
                                 SdaiLogical     *result);
Arguments:

instance	A numeric instanceID that uniquely identifies the instance in the EDMdatabase to be validated. This instanceID is returned when the actual instance is created or it can be retrieved by an EDMinterface get operation. The specified instance must be located in an open data model.
whereRuleId	A numeric whereID that uniquely identifies a local rule (Where rule) in the EDMdatabase to use in the current validation process. The whereID can be found by invoking the edmiGetWhereRule operation.
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. The EDMinterface current output device can be defined by the edmiDefineOutputFunction operation.
result	Address of a SdaiLogical variable that will receive the result of the validation operation. The returned result is as follows: sdaiTRUE: No local rule violation sdaiFALSE: Actual instanceID violates specified local rule. sdaiUNKNOWN: Unpredictable result due to unset values or error in operation. Use sdaiErrorQuery to check for error in operation.

Returns:
A completion code of datatype EdmiError is the returned function value. The completion code has the following values:
Completion code = 0 : Operation successfully performed.
Completion code != 0: Error in operation. Completion code is an EDMinterface error code. Use edmiGetErrorText to get the error text corresponding to the error code.
EXAMPLE
EdmiError rstat;
SdaiWhereRule whereRuleId;
SdaiAppInstance instance;
SdaiLogical result;
. . .
if (rstat = edmiValidateWhereRule(
instance,
whereRuleId,
"/usr/hkd/AP214/data/validation_print.text",
&result)) {
/* Error in operation */
printf("\nError: %s in edmiValidateWhereRule\n",
edmiGetErrorText(rstat));
goto error;
}
switch (result) {
case sdaiTRUE:
. . . /* No violation in operation */
break;
case sdaiFALSE:
. . . /* Rule violation */
break;
default:
. . . /* Unpredictable result */
break;
}
. . .