IRTCClientPresence2::SetPresenceData

The SetPresenceData method sets application-specific information to be included in the presence document. This method sets the data that can be retrieved by the IRTCPresenceDevice::GetPresenceData method.

HRESULT SetPresenceData(BSTRbstrNamespace,
BSTRbstrData);

Parameters

  • bstrNamespace
    [in] A unique name for the presence property data. Typically, this parameter would contain the XML namespace if the format of the presence data set is an XML document.
  • bstrData
    [in] BSTR containing application-specific information that is included in the presence document.

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 bstrData parameter is too large. This parameter is limited to 65,535 characters.
E_OUTOFMEMORY Insufficient memory to perform this operation.

Remarks

The presence data is not set in the presence document when the registrar server specifies the UDP transport. Multiple points of presence (MPOP) and roaming are not supported.

Note   The size of the bstrData parameter is limited to 65,535 characters.

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, Presence, Set Presence Information