IRTCMessagingEvent::get_UserStatus

  • Article

The get_UserStatus property returns the user keystroke status.

HRESULT get_UserStatus(RTC_MESSAGING_USER_STATUS*penUserStatus);

Parameters

  • penUserStatus
    [out] Pointer to an RTC_MESSAGING_USER_STATUS enumeration containing the user status. The status indicates if the user is typing or idle.

Return Values

RTC methods may return an RTC_E_ constant.

Remarks

This method is used for IM sessions only. The applications that are participating in the IM session are responsible for setting their current user status. The status is sent to other participants with the IRTCSession::SendMessageStatus method.

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_IRTCMessagingEvent is defined as d3609541-1b29-4de5-a4ad-5aebaf319512.

See Also

IRTCMessagingEvent, RTC_MESSAGING_USER_STATUS, IRTCSession::SendMessageStatus