EssDeleteFilter

Description

EssDeleteFilter() deletes an existing filter.

Syntax

ESS_FUNC_M EssDeleteFilter (hCtx, AppName, DbName, FilterName);
ESS_HCTX_ThCtx
ESS_STR_TAppName
ESS_STR_TDbName
ESS_STR_TFilterName

Parameters

hCtxEssbase API context handle
AppNameApplication name
DbNameDatabase name
FilterNameFilter name

Return Value

None.

Access

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

Example

ESS_FUNC_M 
ESS_DeleteFilter (ESS_HCTX_T  hCtx)        
{
   ESS_FUNC_M        sts = ESS_STS_NOERR;
   ESS_STR_T        AppName;   
   ESS_STR_T        DbName;
   ESS_STR_T        FilterName;
   
   AppName    = "Sample";
   DbName     = "Basic";
   FilterName = "Test";
   
   sts = EssDeleteFilter(hCtx, AppName, DbName,
         FilterName);  
   return (sts);
}

See Also

EssCopyFilter()
EssListFilters()
EssRenameFilter()
EssSetFilter()