IRTCSessionCallControl::get_ReferCookie

  • Article

The get_ReferCookie method returns the cookie for the transferred session. This method returns the cookie set in IRTCSessionCallControl::put_ReferCookie.

HRESULT get_ReferCookie(BSTR*pbstrReferCookie);

Parameters

  • pbstrReferCookie
    [out] Pointer to a BSTR that contains the cookie for the session. The cookie contains information about the referred session from the remote client that initiated the transfer (refer). If the session was not referred, this parameter is NULL and the method returns S_FALSE.

Return Values

RTC methods may return an RTC_E_ constant.

Value Meaning
E_OUTOFMEMORY Insufficient memory to perform this operation.
E_POINTER The pbstrReferCookie parameter is not a valid pointer.
RTC_E_INVALID_SESSION_STATE The session must be in 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

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

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_IRTCSessionCallControl is defined as E9A50D94-190B-4F82-9530-3B8EBF60758A.

See Also

IRTCSessionCallControl, Session Control, Session Transfer Accepted