# EsbListDbFiles

Description

EsbListDbFiles() retrieves information on specified index and data files.

Syntax

    EsbListDbFiles (hCtx, AppName, DbName, FileType, Items)

    ByVal hCtx     As Long
    ByVal AppName  As String
    ByVal DbName   As String
    ByVal FileType As Integer
          Items    As Long

Parameters

hCtx | Context handle
AppName | Application name
DbName | Database name
FileType | One of the following file types to be returned: ESB_FILETYPE_INDEX ESB_FILETYPE_DATA ESB_FILETYPE_INDEX | ESB_FILETYPE_DATA
Items | Number of index and data files returned

Return Value

If successful,
- EsbListDbFiles() returns 0
- Items contains the number of index or data files returned
- A list of ESB_DBFILEINFO_T structures is created. Each structure has information on one of the index or data files returned.

Notes

After you call EsbListDbFiles(), call EsbGetNextItem(), using ESB_DBFILEINFO_TYPE, to retrieve the database file information structure(s) that you want.

Access

Example

       Dim OutDbInfo As ESB_DBFILEINFO_T
       Dim FileType  As Integer
       Dim Count     As Long

       FileType = ESB_FILETYPE_INDEX + ESB_FILETYPE_DATA
       sts = EsbListDbFiles(hCtx, "sample", "basic", FileType, Count)
       MsgBox (sts)
       If Not sts Then
         For Index = 1 To Count
           sts = EsbGetNextItem(hCtx, ESB_DBFILEINFO_TYPE, OutDbInfo)
         Next
       End If

See Also

ESB_DBFILEINFO_T