IRTCSession::Redirect

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

• Windows Embedded CE 6.0 R3

8/28/2008

This method changes the type of session and profile for a redirected call. The application calls this method when an outgoing call is redirected. The method is used only when the session was created using the RTCCS_FAIL_ON_REDIRECT flag.

Syntax

HRESULT Redirect(
  RTC_SESSION_TYPE enType,
  BSTR bstrLocalPhoneURI,
  IRTCProfile* pProfile,
  long lFlags
);

Parameters

• enType
  [in] An RTC_SESSION_TYPE enumeration value specifying the type of session.

• bstrLocalPhoneURI
  [in] The TEL Universal Resource Identifier (URI), which specifies the phone at which the local user will be called.

  Note

  This parameter must be set to NULL. It is used only for phone-to-phone calls which is currently not supported.

• pProfile
  [in] Pointer to an IRTCProfile interface that specifies a provisioning profile to use for this session.

  It is used only when the RTCCS_FORCE_PROFILE flag is specified in lFlags. Otherwise, this parameter must be set to NULL, and the RTC API automatically chooses the best profile.

  If the RTCCS_FORCE_PROFILE flag is set and the parameter is NULL, no profile is used.

• lFlags
  [in] An RTCCS_ constant specifying the profile used and the behavior for redirected users.

Return Value

This method can return an RTC_E_ constant.

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

Remarks

The RTC Client API chooses the best profile from the list of enabled profiles. The profile that supports the session type and destination address is chosen.

The application can obtain a pointer to IRTCProfile from IRTCClientProvisioning::EnumerateProfiles.

To initiate the redirected call or messaging session, the application must call the IRTCSession::AddParticipant method with the redirected address.

Requirements

See Also

Reference

IRTCSession
IRTCClientProvisioning::EnumerateProfiles
IRTCProfile
IRTCSession::AddParticipant
RTC_SESSION_TYPE