# EsbCreateFilter

Description

EsbCreateFilter() creates a new filter and starts setting its contents.

Syntax

    Declare Function EsbCreateFilter Lib "esbapin" (
    ByVal hCtx As Long,
    ByVal AppName As String,
    ByVal DbName As String,
    ByVal FltName As String,
    ByVal isActive As Integer,
    ByVal pAccess As Integer) As Long

Parameters

hCtx | Essbase API context handle
AppName | Application name
DbName | Database name
FilterName | Filter name, up to 30 characters long
Active | Filter active flag. If TRUE, the filter is set active, otherwise it is set inactive.
Access | The default filter access level

Return Value

None.

Notes

- If the filter does not already exist, it will be created by this call.
- If the filter already exists, an error message is returned.
- This call must be followed by successive calls to EsbSetFilterRow() to set all the rows for the filter.

Access

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

Example

See Also