IRTCSessionCallControl::get_IsReferred

  • Article

The get_IsReferred method returns whether the session has been referred by another user to this endpoint.

HRESULT get_IsReferred(VARIANT_BOOLpfIsReferred);

Parameters

  • pfIsReferred
    [out] Pointer to a VARIANT_BOOL specifying whether the session has been referred.

Return Values

RTC methods may return an RTC_E_ constant.

Value Meaning
E_POINTER The pfIsReferred parameter is not a valid pointer.

Remarks

The application should call this method when it receives an incoming session. If the pfIsReferred parameter is VARIANT_TRUE, the application should call IRTCSessionCallControl::get_ReferredByURI and IRTCSessionCallControl::get_ReferCookie to retrieve the URI and BSTR cookie of the referring party (transfer initiator). An RTC session is considered a referred session if the application creating the session calls the ITRCSessionCallControl::put_ReferredByURI and ITRCSessionCallControl::put_ReferCookie methods on the session before adding a participant to the session.

For more information on session transfer (refer), see Transferring (Referring) a Session and Session Transfer Accepted.

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, IRTCSessionCallControl::get_ReferredByURI, Session Control, Session Transfer Accepted