IRTCClientPresence2::PresenceProperty

Other versions of this page are also available for the following:

• Windows Embedded CE 6.0 R3

8/28/2008

Note

This method is unsupported in Windows Embedded CE 6.0.

This method sets or gets 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::PresenceProperty and IRTCPresenceDevice::PresenceProperty methods.

Syntax

HRESULT put_PresenceProperty(
  RTC_PRESENCE_PROPERTY enProperty,
  BSTR bstrProperty
);
HRESULT get_PresenceProperty(
  RTC_PRESENCE_PROPERTY enProperty,
  BSTR* pbstrProperty
);

Parameters

• enProperty
  [in] An RTC_PRESENCE_PROPERTY enumeration value specifying the type of presence property.

• bstrProperty, pbstrProperty
  [in, out] The presence property of the local user.

  On output, this parameter is a pointer to a BSTR that will be filled with the presence property of the local user, or an empty string if there is no entry.

  The method allocates the buffer. The caller is responsible for releasing this memory with SysFreeString.

Return Value

This method can return an RTC_E_ constant.

The following table shows additional possible return values.

Value	Meaning
E_INVALIDARG	The size of the bstrProperty parameter is too large. This parameter is limited to the following sizes based on the value in the enProperty parameter: RTCPP_PHONENUMBER: 127 characters RTCPP_DISPLAYNAME: 1,023 characters RTCPP_EMAIL: 1,023 characters RTC_DEVICE_NAME: 255 characters
E_OUTOFMEMORY	Insufficient memory to perform this operation.

Requirements

Header	rtccore.h, rtccore.idl
Library	uuid.lib
Windows Embedded CE	Windows CE .NET 4.2 and later

See Also

Reference

IRTCClientPresence2
IRTCBuddy2::PresenceProperty
IRTCPresenceDevice::PresenceProperty
RTC_PRESENCE_PROPERTY

Other Resources

SysFreeString