EsbGetFilterList

Description

EsbGetFilterList() gets the list of users who are assigned a filter.

Syntax
EsbGetFilterList (hCtx, AppName, DbName, FltName, pItems)

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

Parameters

hCtxEssbase VB API context handle.
AppNameApplication name.
DbNameDatabase name.
FltNameFilter name.
pItemsAddress of variable to receive Items of users assigned this filter.

Return Value

If successful, returns a Items of the users assigned this filter in pItems, and generates an array of user 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 EsbGetFilterList Lib "ESBAPIW" (ByVal hCtx As 
Long, ByVal AppName As String, ByVal DbName As String, ByVal 
FilterName As String, Items As Integer) As Long

Sub ESB_GetFilterList ()
   Dim Items As Integer
   Dim AppName As String
   Dim DbName As String 
   Dim FilterName As String
   Dim User As String * ESB_USERNAMELEN
   Dim sts As Long

   AppName = "Sample"
   DbName = "Basic"
   FilterName = "Filter"

   '****************
   ' Get Filter List
   '**************** 
   sts = EsbGetFilterList (hCtx, AppName, DbName, FilterName, Items)

   For n = 1 To Items

     '**************************
     ' Get next User Name String 
     ' from the list
     '**************************
     sts = EsbGetNextItem (hCtx, 
     ESB_FUSERNAME_TYPE, ByVal User)
   Next
End Sub

See Also

EsbGetFilter()
EsbListFilters()
EsbSetFilterList()
EsbGetNextItem()