EsbSetFilterList

Description

EsbSetFilterList() sets the list of groups or users that are assigned to a filter. The Items parameter controls the number of groups or users assigned to the filter. A Items of zero will remove all the groups or users from the list.

Syntax
EsbSetFilterList (hCtx, AppName, DbName, FltName, UserList, Items)
ByVal hCtx     As Long
ByVal AppName  As String
ByVal DbName   As String
ByVal FltName  As String
ByVal UserList As String
ByVal Items    As Integer

Parameters

hCtxEssbase VB API context handle.
AppNameApplication name.
DbNameDatabase name.
FltNameFilter name.
UserListString of user names (CR and EOL delimited), must be less than 64 KBytes in length.
ItemsNumber of user names in the string.

Return Value

None.

Access

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

Example

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

Sub ESB_SetFilterList ()
   Dim sts As Long
   Dim AppName As String
   Dim DbName As String
   Dim FilterName As String
   Dim UserList As String
   Dim Items As Integer

   AppName = "Sample"
   DbName = "Basic"
   FilterName = "Filter"
   '******************************
   ' Initialize UserList and Items
   '****************************** 
   Items = 2
   UserList = "Admin"+Chr$(13)+Chr$(10)+"Truc" 
   '****************
   ' Set Filter List
   '****************
   sts = EsbSetFilterList (hCtx, AppName, DbName,
   FilterName, UserList, Items) 
End Sub

See Also

EsbGetFilterList()
EsbListFilters()
EsbSetFilter()