GetGroupList
Fetches groups of cabinet .
Public Function GetGroupList(ByVal userId As Long,ByVal StartPos As Long, ByVal FetchCount As Long, _
ByRef RetrievedRecCount As Long, ByRef TotalRecCount As Long, ByRef GroupList() As Byte) As Long
Parameters
|
In/out |
Name |
Data type |
Description |
|
In |
UserId |
Long |
Index of user fetching group list |
|
In
|
StartPos |
Long |
Starting position for fetching the group list |
|
In
|
FetchCount |
Long |
Number of records to be fetched in a single batch |
|
Out |
RetrievedRecCount |
Long |
Records retrieved |
|
Out |
TotalRecCount |
Long |
Total Records retrieved |
|
Out |
GroupList |
Byte[TagGroup] |
Byte array specifying the list of groups fetched and their attributes |
Description
This function is called from admin for shared cabinet. This is called when a call to connect to a cabinet is called and does the job of fetching the group list. Logic for fetching in batches is same as that of 'GetKeyWords'
Return value
|
Name |
Description |
|
1 |
In case of success |
|
-3 |
Cabinet not connected |
|
-4 |
Invalid operation |
Example
Dim userId As Long
Dim StartPos As Long
Dim FetchCount As Long
Dim RetrievedRecCount As Long
Dim TotalRecCount As Long
Dim GroupList() As Byte
Dim gPDb As PanDb.pdbCls
Set gPDb = New PanDb.pdbCls
UserId = 3
StartPos = 0
FetchCount = 10
lRetVal=gPDb.GetGroupList(userId,StartPos,FetchCount,RetrievedRecCount,TotalRecCount,GroupList)
if lRetVal <> NG_SUCCESS Then
MsgBox gPDb.ErrDescription, vbInformation
Screen.MousePointer = vbNormal
Endif