Share via

IRTCClientPresence::SetLocalPresenceInfo

  • Article

The SetLocalPresenceInfo method sets the local presence status. All the active Watchers are instantly notified of the change. This method sets information that can be retrieved from the IRTCBuddy::get_Notes and IRTCBuddy::get_Status methods.

HRESULT SetLocalPresenceInfo(RTC_PRESENCE_STATUSenStatus,
BSTRbstrNotes);

Parameters

  • enStatus
    [in] An RTC_PRESENCE_STATUS enumeration that specifies the presence status.
  • bstrNotes
    [in] Custom user-provided text that may have a meaning for the active Watchers.

Return Values

RTC methods may return an RTC_E_ constant.

Value Meaning
RTC_E_CLIENT_NOT_INITIALIZED The client is not initialized.
RTC_E_PRESENCE_NOT_ENABLED Presence is not enabled.
E_INVALID_ARG The bstrNotes parameter is too large. This parameter is limited to 511 characters.

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_IRTCClientPresence is defined as 11c3cbcc-0744-42d1-968a-51aa1bb274c6.

See Also

IRTCClientPresence, RTC_PRESENCE_STATUS, IRTCSession::SendMessageStatus, Presence, Set Presence Information