GetErrorString method

Returns a string describing the error that just occurred.

Event handlers whose sequence type is "before" can instruct eRoom to block the event. In these cases, eRoom will call this method in order to retrieve a meaningful message to be displayed to the user. If the event handler doesn't specify a string, a default eRoom error message will be displayed to the user.

Syntax


C++

HRESULT GetErrorString(

    BSTR *pErrorStr)

Scripting languages

Public Function IERUEventHandler_GetErrorString() As String

Parameters


pErrorStr

A string representation of the error that occurred in the handler.

Home

Applies to

IERUEventHandler