EssGetMessage

EssGetMessage

Description

EssGetMessage() 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
LONG hInst;
INTEGER ErrLevel;
LONG ErrNum;
STRING ErrMessage;
INTEGER szErrMessage;

Parameters

hInst Essbase VB API instance handle.
ErrLevel Pointer to variable to receive message level.
ErrNum Pointer to variable to receive message number in the message database.
ErrMessage Buffer to receive a message string.
szErrMessage Size 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

See Also