EssVerifyFilter

Verifies the syntax of a series of filter row strings against a specified database.

Syntax

ESS_FUNC_M  EssVerifyFilter (hCtx, AppName, DbName);
ParameterData TypeDescription

hCtx

ESS_HCTX_T

API context handle.

AppName

ESS_STR_T

Application name.

DbName

ESS_STR_T

Database name.

Notes

Follow this call with successive calls to EssVerifyFilterRow() to verify all rows for the filter.

Return Value

None.

Access

This function requires the caller to have database designer privilege (ESS_PRIV_DBDESIGN) for the specified database.

Example

ESS_VOID_T 
ESS_VerifyFilter (ESS_HCTX_T hCtx)   
{
   ESS_FUNC_M        sts = ESS_STS_NOERR;
   ESS_STR_T        AppName;   
   ESS_STR_T        DbName; 
   ESS_USHORT_T     Count = 4;
   ESS_STR_T        RowString[4];
   ESS_USHORT_T     ind;   
   
   AppName = "Sample";
   DbName = "Basic";
   /* Initialize Filter Row */
   
   RowString[0] = "@IDESCENDANTS(Scenario)";
   RowString[1] = "@IDESCENDANTS(Product)";   
   RowString[2] = "Qtr1, @IDESCENDANTS(\"Colas\")";
   RowString[3] = "";
   
   /* Verify Filter */
   
   sts = EssVerifyFilter(hCtx, AppName, DbName);
   
   /* Verify Count Filter Rows */
   
   if(!sts)
   {
      for (ind = 0; ind < Count; ind++)     
         sts = EssVerifyFilterRow(hCtx,
               RowString[ind]); 
   }
}

See Also