IRTCSessionCallControl::Refer
The Refer method transfers (refers) a session in the RTCSS_CONNECTED or RTCSS_HOLD state to another URI.
HRESULT Refer(BSTRbstrReferToURI,
BSTRbstrReferCookie);
Parameters
- bstrReferToURI
[in] BSTR that contains the URI to refer the session to. - bstrReferCookie
[in] BSTR that contains the cookie for the session. The cookie contains contextual information on the session that is being transferred.
Return Values
RTC methods may return an RTC_E_ constant.
| Value | Meaning |
|---|---|
| RTC_E_INVALID_SIP_URL | The SIP URL specified in the bstrReferToURI parameter is not valid. |
| E_OUTOFMEMORY | Insufficient memory to perform this operation. |
Remarks
Note The remote party will fail the Refer request with a SIP 603 response if the remote participant has put this endpoint in the RTCSS_ HOLD state. If this endpoint has put the remote participant on hold, then sending a Refer to the remote participant is allowed.
The session must be of type RTCST_PC_TO_PC, RTCST_PC_TO_PHONE, or RTCST_MULTIPARTY_IM to initiate a session transfer. Multiparty IM sessions are limited to two participants to initiate a transfer.
This method is used by the party initiating the session transfer. For more information on session transfers, see Session Control.
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.