EsbGetMessage

Description

EsbGetMessage() retrieves the top message from the message stack filled during VB API function execution if ClientError in ESB_INIT_T structure has been set to ESB_TRUE during EsbInit().

Syntax
EsbGetMessage (hInst, ErrLevel, ErrNum, ErrMessage, szErrMessage)
ByVal hInst        As Long
      ErrLevel     As Integer
      ErrNum       As Long
ByVal ErrMessage   As String
ByVal szErrMessage As Integer

Parameters

hInstEssbase VB API instance handle.
ErrLevelPointer to variable to receive message level.
ErrNumPointer to variable to receive message number in the message database.
ErrMessageBuffer to receive a message string.
szErrMessageSize of the buffer to receive a message string.

Return Value

If successful, returns a pointer to a message level, a pointer to a message number, and a message string. Also decrements internal message stack pointer.

Notes

Access

This function requires no special privileges.

Example

Declare Function EsbGetMessage Lib "ESBAPIW" (ByVal hInst As Long, ErrLevel As Integer, ErrNum As Long, ByVal Message As String, ByVal szMessage As Integer) As Long
Sub ESB_GetMessage ()
   Dim Items As Integer
   Dim AppName As String
   Dim DbName As String 
   Dim FilterName As String
   Const szMessage = 256
   Dim Message As String * szMessage
   Dim Number As Long
   Dim Level As Integer 
   Dim sts As Long

   AppName = "Demo"
   DbName = "Basic"
   FilterName = "Filter"

   '****************
   ' Get Filter List
   '**************** 
   sts = EsbGetFilterList (hCtx, AppName, DbName,
    FilterName, Items)

   '*******************************
   ' Process all messages if error 
   ' occurred till the bottom of the
   ' message stack enItemsered
   '*******************************
   If sts > 0 Then
      sts = EsbGetMessage (hInst, Level, Number,
            Message, szMessage) 
      Do While Mid$(Message, 1, 1) <> Chr$(0)
         Print Level
         Print Number
         Print Message 
         sts = EsbGetMessage (hInst, Level,
               Number, Message, szMessage)
     Loop 
   End If
End Sub

See Also

EsbAutoLogin()
EsbInit()