IRTCClientPresence2::put_PresenceProperty

  • Article

The put_PresenceProperty method sets the standard presence property for the local user. This information is included in the presence document. This method sets information that can be retrieved by the IRTCBuddy2::get_PresenceProperty and IRTCPresenceDevice::get_PresenceProperty methods.

HRESULT put_PresenceProperty(RTC_PRESENCE_PROPERTYenProperty,
BSTRbstrProperty);

Parameters

  • enProperty
    [in] An RTC_PRESENCE_PROPERTY enumeration value containing the type of presence property that is set.
  • bstrProperty
    [in] The presence property of the local user.

Return Values

RTC methods may return an RTC_E_ constant.

Value Meaning
RTC_E_CLIENT_NOT_INITIALIZED The client object is not initialized.
RTC_E_PRESENCE_NOT_ENABLED Presence has not been enabled.
E_INVALIDARG The size of the bstrProperty parameter is too large. This parameter is limited to the following sizes bases on the value in the enProperty parameter:

  • RTCPP_PHONENUMBER—127 characters
  • RTCPP_DISPLAYNAME—1023 characters
  • RTCPP_EMAIL—1023 characters
  • RTC_DEVICE_NAME—255 characters
E_OUTOFMEMORY Insufficient memory to perform this operation.

Requirements

Redistributable: Requires Rtcdll.dll on Windows 2000, Windows XP, and Windows Server 2003.
Header: Declared in Rtccore.h.
Library: Included as a resource in Rtcdll.dll.
GUID: IID_IRTCClientPresence2 is defined as AD1809E8-62F7-4783-909A-29C9D2CB1D34.

See Also

IRTCClientPresence2, RTC_PRESENCE_PROPERTY, Presence, Set Presence Information