EssRenameFilter

Renames an existing filter.

Syntax

ESS_FUNC_M EssRenameFilter (hCtx, AppName, DbName, OldName, NewName);

Parameter	Data Type	Description
hCtx	ESS_HCTX_T	API context handle
AppName	ESS_STR_T	Application name
DbName	ESS_STR_T	Database name
OldName	ESS_STR_T	Old name of existing filter to be renamed
NewName	ESS_STR_T	New name of renamed filter. See Filter Name Limits.

Notes

The old filter name must already exist, and the destination filter name must not exist.

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_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);
}