EssRenameFilter

Description

EssRenameFilter() renames an existing filter.

Syntax
ESS_FUNC_M EssRenameFilter (hCtx, AppName, DbName, OldName, NewName); 
ESS_HCTX_ThCtx
ESS_STR_TAppName
ESS_STR_TDbName
ESS_STR_TOldName
ESS_STR_TNewName

Parameters

hCtxEssbase API context handle
AppNameApplication name
DbNameDatabase name
OldNameOld name of existing filter to be renamed
NewNameNew name of renamed filter, up to 30 characters long

Return Value

None.

Notes

Access

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

Example

ESS_FUNC_M 
ESS_RenameFilter (ESS_HCTX_T  hCtx)        
{
   ESS_FUNC_M        sts = ESS_STS_NOERR;
   ESS_STR_T        AppName;   
   ESS_STR_T        DbName;
   ESS_STR_T        OldName;
   ESS_STR_T        NewName;   
   
   AppName = "Sample";
   DbName  = "Basic";
   OldName = "Test";
   NewName = "NewTest";
   
   sts = EssRenameFilter(hCtx, AppName, DbName, 
         OldName, NewName);  
   return (sts);
}

See Also

EssCopyFilter()
EssDeleteFilter()
EssListFilters()