IRTCSessionCallControl::Refer
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 transfers (refers) a session to another URI. The session to be transferred must be in the RTCSS_CONNECTED or RTCSS_HOLD state.
Syntax
HRESULT Refer(
BSTR bstrReferToURI,
BSTR bstrReferCookie
);
Parameters
- bstrReferToURI
[in] The URI to which to refer the session.
- bstrReferCookie
[in] The cookie that contains contextual information on the session to transfer.
Return Value
This method can return an RTC_E_ constant.
The following table shows an additional return value and additional information about a specific return value.
| Value | Meaning |
|---|---|
E_OUTOFMEMORY |
Insufficient memory to perform this operation. |
RTC_E_INVALID_SIP_URL |
The SIP URL specified in the bstrReferToURI parameter is not valid. |
Remarks
This method is used by the party initiating the session transfer. To initiate a session transfer, the session must be of type RTCST_PC_TO_PC, RTCST_PC_TO_PHONE, or RTCST_MULTIPARTY_IM. Multiparty instant messaging (MIM) sessions are limited to two participants to initiate a transfer.
If the remote participant has put this endpoint in the RTCSS_HOLD state, the remote party fails the transfer request with a SIP 603 response.
In contrast, if this endpoint has put the remote participant on hold, sending a transfer to the remote participant is allowed.
Requirements
| Header | rtccore.h, rtccore.idl |
| Library | uuid.lib |
| Windows Embedded CE | Windows CE .NET 4.2 and later |
See Also
Reference
IRTCSessionCallControl
IRTCSessionCallControl::ReferredByURI
IRTCSessionCallControl::ReferCookie