IRTCSessionCallControl::ReferredByURI

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

• Windows Embedded CE 6.0 R3

8/28/2008

This method sets or gets the URI of the party that initiated the transfer.

Syntax

HRESULT put_ReferredByURI(
  BSTR bstrReferredByURI
);
HRESULT get_ReferredByURI(
  BSTR* pbstrReferredByURI
);

Parameters

• bstrReferredByURI, pbstrReferredByURI
  [in, out] The URI of the party referring the session.

  On output, this parameter is a pointer to a BSTR that is filled with the URI of the party referring the session.

  The method allocates the buffer.

  The caller is responsible for releasing this memory with SysFreeString.

Return Value

This method can return an RTC_E_ constant.

The following table shows additional return values and additional information about a specific return value.

Value	Meaning
E_OUTOFMEMORY	Insufficient memory to perform this operation.
E_POINTER	The pbstrReferredByURI parameter is not a valid pointer.
S_FALSE	The session was not referred. The pbstrReferredByURI parameter contains NULL.
RTC_E_INVALID_SESSION_STATE	On input, the session is not in the idle state.
RTC_E_INVALID_SIP_URL	The SIP URL specified in the bstrReferredByURI parameter is not valid.
RTC_E_NOT_EXIST	The session was not referred and there is no referred by URI to return.

Remarks

On input, the cookie should contain the URI of the party that is initiating the session transfer.

On output, if the session was referred, the pbstrReferredByURI parameter returns the value in the bstrReferToURI parameter of the IRTCSessionCallControl::Refer method. If the session was not redirected, the pbstrReferredByURI parameter is NULL and the method returns S_FALSE.

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

Other Resources

SysFreeString