IRTCSessionCallControl::Refer (Windows Embedded CE 6.0)

1/6/2010

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.

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

See Also

Reference

IRTCSessionCallControl
IRTCSessionCallControl::ReferredByURI
IRTCSessionCallControl::ReferCookie