EssCopyFilter

Description

EssCopyFilter() copies an existing filter.

Syntax

ESS_FUNC_M EssCopyFilter (hCtx, hSrcCtx, SrcApp, DestApp, SrcDb, DestDb, SrcName, DestName);
ESS_HCTX_ThCtx
ESS_HCTX_ThSrcCtx
ESS_STR_TSrcApp
ESS_STR_TDestApp
ESS_STR_TSrcDb
ESS_STR_TDestDb
ESS_STR_TSrcName
ESS_STR_TDestName

Parameters

hCtxEssbase API context handle.
hSrcCtxNot used - should be same as hCtx.
SrcAppSource application name.
DestAppDestination application name.
SrcDbSource databasename.
DestDbDestination databasename.
SrcNameSource name of existing filter to be copied.
DestNameDestination name of copied filter.

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_CopyFilter (ESS_HCTX_T  hCtx)   
{
   ESS_FUNC_M        sts = ESS_STS_NOERR; 
   ESS_HCTX_T        hSrcCtx;
   ESS_STR_T         SrcApp; 
   ESS_STR_T         DestApp;
   ESS_STR_T         SrcDb; 
   ESS_STR_T         DestDb;
   ESS_STR_T         SrcName;        
   ESS_STR_T         DestName;       
   
   hSrcCtx   = hCtx;
   SrcApp    = "Sample";
   SrcDb     = "Basic";
   SrcName   = "OldFilter"; 
   DestApp   = "Sample";
   DestDb    = "Basic";
   DestName  = "NewFilter"; 
   
   sts = EssCopyFilter(hCtx, hSrcCtx, SrcApp,
         DestApp, SrcDb, DestDb, SrcName, DestName); 
   if(!sts)
      printf("The Filter is copied.\r\n");
 
   return (sts);
}

See Also

EssDeleteFilter()
EssListFilters()
EssRenameFilter()