IRTCSessionStateChangeEvent::get_StatusText

The get_StatusText property returns status text associated with the state change. If no status text is available, the method fails and returns E_NOT_EXIST.

HRESULT get_StatusText(BSTR*pbstrStatusText);

Parameters

  • pbstrStatusText
    [out] Pointer to a BSTR containing the status text. The caller is responsible for freeing the memory holding this string by calling the SysFreeString function.

Return Values

RTC methods may return an RTC_E_ constant.

Value Meaning
E_NOT_EXIST No status text.

Remarks

The text is extracted from a SIP response that is not localized to regional language. Therefore, the text may not be appropriate to show to the user.

Requirements

Client: Requires Windows XP.
Server: Requires Windows Server 2003.
Redistributable: Requires Rtcdll.dll on Windows 2000, and Windows Me/98.
Header: Declared in Rtccore.h.
Library: Included as a resource in Rtcdll.dll.
GUID: IID_IRTCSessionStateChangeEvent is defined as b5bad703-5952-48b3-9321-7f4500521506.

See Also

IRTCSessionStateChangeEvent, IRTCSessionStateChangeEvent::get_StatusCode