GetDataDefList
For fetching the list of dataclass of the connected cabinet.
Public Function GetDataDefList(ByVal StartPos As Long, ByVal FetchCount As Long, ByVal TotalRecCountFlag As String, ByRef RetrievedRecCount As Long, ByRef TotalRecCount As Long,ByRef DataDefList() As Byte) As Long
Parameters
|
In/out |
Name |
Data type |
Description |
|
In
|
StartPos |
Long |
Starting position for fetching in batches |
|
In
|
FetchCount |
Long |
Number of records to be fetched in each batch |
|
In
|
TotalRecCountFlag |
Long |
Whether total number of records are to fetched - 'Y'/'N' |
|
Out |
RetrievedRecCount |
Long |
Items fetched in one batch |
|
Out
|
TotalRecCount |
Long |
Total number of records fetched. |
|
Out |
DataDefList |
Byte |
List of dataclass |
Description
This function is called form both admin and desktop for both local and shared cabinet. This function is called in desktop when properties associated with a document or folder are fetched and and in admin to fetch the list of the dataclass present in the cabinet. This function also supports batching.
Return value
|
Name |
Description |
|
1 |
In case of success |
|
-1 |
Invalid operation |
|
-3 |
Cabinet not connected |
Example
Dim StartPos As Long
Dim FetchCount As Long
Dim TotalRecCountFlag As String
Dim RetrievedRecCount As Long
Dim TotalRecCount As Long
Dim DataDefList() As Byte
Dim gPDb
As PanDb.pdbCls
Set gPDb = New PanDb.pdbCls
StartPos =0
FetchCount = 10
TotalRecCountFlag = “Y”
lRetVal = gPDb.GetDataDefList(StartPos,FetchCount,TotalRecCountFlag,RetrievedRecCount,TotalRecCount, DatDefList)
If lRetVal <> NG_SUCCESS Then
MsgBox gPDb.ErrDescription, vbInformation
Screen.MousePointer = vbNormal
Exit Sub
End If