IRTCSessionCallControl::ReferCookie (Windows CE 5.0)
This method sets or gets the cookie for a transferred session. The cookie contains information about the session from the remote client that initiated the transfer.
HRESULT put_ReferCookie(BSTRbstrReferCookie);HRESULT get_ReferCookie(BSTR*pbstrReferCookie);
Parameters
bstrReferCookie, pbstrReferCookie
[in, out] The application-defined cookie for the session.The method allocates the buffer.
The caller is responsible for releasing this memory with SysFreeString.
Return Values
This method can return an RTC_E_ constant.
The following table shows additional return values and additional information about specific return values.
| Value | Meaning |
|---|---|
| E_OUTOFMEMORY | Insufficient memory to perform this operation. |
| E_POINTER | The pbstrReferCookie parameter is not a valid pointer. |
| S_FALSE | The session was not referred. The pbstrReferCookie parameter contains NULL. |
| RTC_E_INVALID_SESSION_STATE | When setting the cookie, the session is not in the idle state.
When retrieving the cookie, the session is not in either the RTCSS_HOLD or RTCSS_CONNECTED state. |
| RTC_E_NOT_EXIST | The session was not referred and there is no refer cookie to return. |
Remarks
On input, the cookie should contain contextual information about the session that is being transferred. This cookie is entered by the party initiating the session transfer.
On output, if the session was referred, the pbstrReferCookie parameter returns the value set in the bstrReferCookie parameter of the IRTCSessionCallControl::Refer method. If the session was not redirected, the pbstrReferCookie parameter is NULL and the method returns S_FALSE.
Requirements
OS Versions: Windows CE .NET 4.2 and later.
Header: Rtccore.h, Rtccore.idl.
Link Library: Uuid.lib.
See Also
IRTCSessionCallControl | IRTCSessionCallControl::Refer | SysFreeString
Send Feedback on this topic to the authors