IRTCRoamingEvent
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
Note
This interface is unsupported in Windows Embedded CE 6.0.
This interface retrieves information about an event of type RTCE_ROAMING.
This type of event is used when a roaming session is enabled or disabled, or when it encounters an error.
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 lists the IRTCRoamingEvent methods.
| Method | Description |
|---|---|
Gets the event type. |
|
Gets the profile associated with this event. |
|
Gets the result code of the roaming operation that has completed. |
|
Gets the status text string 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_ROAMING, the method's pEvent parameter is an IDispatch for the IRTCRoamingEvent interface.
Remarks
To enable reception of roaming events, the application must call the IRTCClient::EventFilter method and set an event filter mask that includes the RTCE_ROAMING 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 |