IRTCSessionReferredEvent::ReferCookie
Other versions of this page are also available for the following:
.gif "A hyphen indicates that the information in this topic is not relevant for this platform, or that the platform does not support the API that is listed.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
8/28/2008
This method gets the cookie for the referred session. The cookie contains context information on the session. This method is called by the recipient in the session transfer.
Syntax
HRESULT get_ReferCookie(
BSTR* pbstrReferCookie
);
Parameters
pbstrReferCookie
[out] Pointer to a BSTR that is filled with the cookie that is stored for the referred session, 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_POINTER |
The pbstrReferCookie parameter is not a valid pointer. |
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 |