Share via


IRTCRoamingEvent

RTCE_ROAMING events have an IRTCRoamingEvent interface. This type of event is fired when a roaming session is enabled, is disabled, or encounters an error.

When the application's implementation of the IRTCEventNotification::Event method indicates an RTC_EVENT of type RTCE_ROAMING, the method's pEvent parameter is an IDispatch pointer for the IRTCRoamingEvent interface.

Note  You must call the IRTCClient::put_EventFilter method and set an event filter mask that includes the RTCE_ROAMING event to enable reception of roaming events. If you do not call IRTCClient::put_EventFilter, your application will not receive any events.

Methods in Vtable Order

The IRTCRoamingEvent interface inherits the methods of the standard COM interface IUnknown.

In addition, IRTCRoamingEvent defines the following methods.

Method Description
get_EventType Returns the event type. This specifies whether this event concerns buddy, watcher, or preference roaming.
get_Profile Returns the profile associated with this event.
get_StatusCode Gets the result code of the roaming operation that has completed.
get_StatusText Gets the status text string of the roaming operation that has completed.

Requirements

Redistributable: Requires Rtcdll.dll on Windows 2000, Windows XP, and Windows Server 2003.
Header: Declared in Rtccore.h.
Library: Included as a resource in Rtcdll.dll.
GUID: IID_IRTCRoamingEvent is defined as 79960a6b-0cb1-4dc8-a805-7318e99902e8.

See Also

Roaming