Share via


IRTCSessionCallControl::IsReferred

Other versions of this page are also available for the following:

Windows Mobile Not SupportedWindows Embedded CE Supported

8/28/2008

This method determines if the session has been referred by another user to this endpoint.

Syntax

HRESULT get_IsReferred(
  VARIANT_BOOL* pfIsReferred
);

Parameters

  • pfIsReferred
    [out] Pointer to VARIANT_TRUE if the session has been referred, and to VARIANT_FALSE otherwise.

Return Value

This method can return an RTC_E_ constant.

The following table shows an additional possible return value.

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 returns VARIANT_TRUE, the application should use the IRTCSessionCallControl::ReferredByURI and IRTCSessionCallControl::ReferCookie methods to retrieve the URI and cookie of the referring party (transfer initiator).

An RTC session is considered a referred session if the application creating the session uses ITRCSessionCallControl::ReferredByURI and ITRCSessionCallControl::ReferCookie to set the session's URI and cookie properties before adding a participant to the session.

Requirements

Header rtccore.h, rtccore.idl
Library uuid.lib
Windows Embedded CE Windows CE .NET 4.2 and later

See Also

Reference

IRTCSessionCallControl
IRTCSessionCallControl::Refer
IRTCSessionCallControl::ReferCookie
IRTCSessionCallControl::ReferredByURI