# EsbListFilters

Description

EsbListFilters() lists all filters for a database.

Syntax

    EsbListFilters (hCtx, AppName, DbName, pItems)

    ByVal hCtx    As Long
    ByVal AppName As String
    ByVal DbName  As String
          pItems  As Integer

Parameters

hCtx | Essbase VB API context handle.
AppName | Application name.
DbName | Database name.
pItems | Address of variable to receive Items of filter names.

Return Value

If successful, returns the Items of filters in the database in pItems, and generates an array of filter name strings accessible via EsbGetNextItem().

Access

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

Example

    Declare Function EsbListFilters Lib "ESBAPIW" (ByVal hCtx As Long, ByVal AppName As String, ByVal DbName As String, Items As Integer) As Long

    Sub ESB_ListFilters ()
       Dim Items As Integer
       Dim AppName As String
       Dim DbName As String
       Dim FilterName As String * ESB_FTRNAMELEN
       Dim sts As Long

       AppName = "Sample"
       DbName = "Basic"

       '*************
       ' List Filters
       '*************
       sts = EsbListFilters (hCtx, AppName, DbName, Items)

       For n = 1 To Items
         '****************************
         ' Get next Filter Name String
         ' from the list
         '****************************
         sts = EsbGetNextItem (hCtx,
               ESB_FTRNAME_TYPE, ByVal FilterName)
       Next
    End Sub

See Also

EsbGetFilter()
EsbSetFilter()
EsbGetNextItem()