IRTCSessionCallControl2::Retrieve

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

• Windows Embedded CE 6.0 R3

8/28/2008

Applies to Windows Embedded CE 6.0 R2

This method sends an INVITE to bstrAddress and retrieves the session identified by bstrRetrieveCallID, bstrRetrieveFromTag, and bstrRetrieveToTag. A new session is started and replaces the retrieved session.

Syntax

HRESULT Retrieve(
        BSTR bstrAddress,
        BSTR bstrName,
        BSTR bstrReferredByURI,
        BSTR bstrRetrieveCallID,
        BSTR bstrRetrieveFromTag,
        BSTR bstrRetrieveToTag,
        VARIANT_BOOL fEarlyOnly
);

Parameters

• bstrAddress
  [in] The address of the user agent. This could be a SIP or TEL URI, e-mail address, IP address, or DNS name.

• bstrName
  [in] The displayable name of the original local User Agent.

• bstrReferredByURI
  [in] The referred-by URI used for the Retrieve operation. It is optional and set to NULL when not used.

• bstrRetrieveCallID
  [in] Identifies the original session.

• bstrRetrieveFromTag
  [in] Identifies the location of the parked session.

• bstrRetrieveToTag
  [in] Identifies the new remote User Agent.

• VARIANT_BOOL fEarlyOnly
  [in] If set to TRUE, the session is at an early stage and can be retrieved.

Return Value

This method can return an RTC_E_ constant. This method returns RTC_E_REPLACES_NOT_SUPPORTED if either of the remote User Agents do not support the REPLACES header.

Remarks

The current session should be created without adding any participant. Otherwise a normal phone call will be placed.

Requirements

See Also

Reference

IRTCSessionConsultantReferredEvent
IRTCSessionStateChangeEvent3
IRTCSessionCallControl2

Other Resources