EsbGetDatabaseInfo

Gets a database's information structure,which contains non user-configurable parameters for the database.

Syntax

EsbGetDatabaseInfo (hCtx, AppName, DbName, DbInfo, pItems)
ByVal hCtx    As Long
ByVal AppName As String
ByVal DbName  As String
      DbInfo As ESB_DBINFO_T
          pItems  As Integer

Parameter	Description
hCtx	VB API context handle
AppName	Application name
DbName	Database name
DbInfo	Buffer to receive a database info structure.
pItems	Number of ESB_DBREQINFO_T structures returned.

Notes

This function can only get the information structure for a server database.
The caller of this routine must call EsbGetNextItem with the ESB_DBREQINFO_TYPE, which returns a structure of type ESB_DBREQINFO_T. These structures contain request information, including last calc, data load, and outline update.

Return Value

If successful, this function returns a pointer to a database infostructure in pDbInfo.

Access

This function requires the caller to have at least Read access(ESB_PRIV_READ) to the specified database.

Example

Declare Function EsbGetDatabaseInfo Lib "ESBAPIN" (ByVal hCtx As Long, ByVal AppName As String, ByVal DbName As String, pDbInfo As ESB_DBINFO_T, Items As Integer) As Long

Sub ESB_GetDatabaseInfo()   
        Dim sts As Long 
        Dim AppName As String
        Dim DbName As String
        Dim Items As Integer
        Dim n As Integer
        Dim DbInfo As ESB_DBINFO_T
        Dim DbReqInfo As ESB_DBREQINFO_T,
        Dim Items As Integer
        AppName = "Sample"
        DbName = "Basic"
        sts = EsbGetDatabaseInfo(hCtx, AppName, DbName, DbInfo, Items)
        If sts = 0 Then
               For n = 1 To Items
                      sts = EsbGetNextItem(hCtx, ESB_DBREQINFO_TYPE, DbReqInfo)
                               Next   End 
        IfEnd Sub