EsbGetApplicationInfo

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

Syntax

EsbGetApplicationInfo (hCtx, AppName, pAppInfo, pItems)
ByVal hCtx     As Long
ByVal AppName  As String
ByVal pAppInfo As ESB_APPINFO_T
      pItems   As Integer
ParameterDescription

hCtx

VB API context handle (logged in).

AppName

Application name. Required; cannot by NULL.

pAppInfo

Buffer to receive an application info structure.

pItems

Address of variable to receive Items of returned databases.

Notes

This function can only be called for applications on the server.

Return Value

If successful, this function returns an application info structure in pAppInfo and a number of databases in pItems and generates a list of database name strings that is accessible via EsbGetNextItem().

Access

This function requires the caller to have access to the specified application.

Example

Declare Function EsbGetApplicationInfo Lib "ESBAPIN" (ByVal hCtx As Long, ByVal AppName As String, AppInfo As ESB_APPINFO_T, Items As Integer) As Long

Sub ESB_GetApplicationInfo ()
   Dim Items As Integer
   Dim AppName As String
   Dim DbName As String * ESB_DBNAMELEN 
   Dim AppInfo As ESB_APPINFO_T
   Dim sts As Long   AppName = "Sample"   '*******************************
   ' Get Application info structure
   '*******************************
   sts = EsbGetApplicationInfo (hCtx, AppName,
   AppInfo, Items)   For n = 1 To Items       '******************************
      ' Get next Database name string
      ' from the list
      '******************************
      sts = EsbGetNextItem (hCtx, 
      ESB_DBNAME_TYPE, ByVal DbName)
   Next
End Sub

See Also