IRTCSessionReferStatusEvent

Switch View

Collapse All

8/28/2008

This interface retrieves information about an event of type RTCEF_SESSION_REFER_STATUS. This type of event informs the application of the status of a transferred (referred) session.

Methods

The following tables show the methods for this interface in vtable order. This is the order in which the compiler calls the methods. This interface inherits the methods for the IUnknown and IDispatch interfaces.

The following table shows the IDispatch methods.

Method	Description
IDispatch::GetIDsOfNames	Maps a single member name and an optional set of parameter names to a corresponding set of integer dispatch identifiers (DISPIDs). These identifiers can then be used on subsequent calls to IDispatch::Invoke.
IDispatch::GetTypeInfo	Retrieves the type information for an object.
IDispatch::GetTypeInfoCount	Retrieves the number of type information interfaces provided by an object, either zero (0) or 1.
IDispatch::Invoke	Provides access to properties and methods exposed by an object.

The following table shows the IRTCSessionReferStatusEvent methods.

Method	Description
IRTCSessionReferStatusEvent::Session	Gets the session being referred.
IRTCSessionReferStatusEvent::ReferStatus	Gets the status of the referred session.
IRTCSessionReferStatusEvent::StatusCode	Gets the status code of the referred session.
IRTCSessionReferStatusEvent::StatusText	Gets the status text associated with the status code.

Obtaining a Pointer

When the application's implementation of the IRTCEventNotification::Event method indicates an RTC_EVENT enumeration value of RTCEF_SESSION_REFER_STATUS, the method's pEvent parameter is an IDispatch pointer for the IRTCSessionReferStatusEvent interface.

Remarks

The RTCEF_SESSION_REFER_STATUS event is fired to the application that initiates a session transfer on a connected call by calling the IRTCSessionCallControl::Refer method. This event notifies the application of the status of the call being created between the transferred endpoint and the transfer target endpoint.

To enable reception of session refer status events, the application must call the IRTCClient::EventFilter method and set an event filter mask that includes the RTCE_SESSION_REFER_STATUS event.

If the application does not call IRTCClient::EventFilter, it will not receive events.

Requirements

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

Reference

RTC Client API Interfaces