IRTCSessionStateChangeEvent
Other versions of this page are also available for the following:
.gif "A hyphen indicates that the information in this topic is not relevant for this platform, or that the platform does not support the API that is listed.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
8/28/2008
This interface retrieves information about an event of type RTCE_SESSION_STATE_CHANGE. This type of event is triggered when a session changes state.
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 |
|---|---|
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. |
|
Retrieves the type information for an object. |
|
Retrieves the number of type information interfaces provided by an object, either zero (0) or 1. |
|
Provides access to properties and methods exposed by an object. |
The following table shows the IRTCSessionStateChangeEvent methods.
| Method | Description |
|---|---|
Gets the Session object that changed state. |
|
Gets the state of the session. |
|
Gets the result code associated with the state change. |
|
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 RTCE_SESSION_STATE_CHANGE, the method's pEvent parameter is an IDispatch pointer for the IRTCSessionStateChangeEvent interface.
Remarks
If the state of the session is RTCSS_INCOMING, the application should hold a reference to the Session object.
The IRTCSessionStateChangeEvent::Session method adds a reference to the IRTCSession2 interface. The application should not release this reference on the Session object until it receives an event indicating that the session is in the RTCSS_DISCONNECTED state.
The RTC Client API does not hold a reference to the Session object and the Session object is deleted when the application releases the IRTCSessionStateChangeEvent object.
Requirements
| Header | rtccore.h, rtccore.idl |
| Library | uuid.lib |
| Windows Embedded CE | Windows CE .NET 4.0 and later |