IRTCRegistrationStateChangeEvent

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

Windows Mobile Not SupportedWindows Embedded CE Supported

8/28/2008

This interface retrieves information about an event of type RTCE_REGISTRATION_STATE_CHANGE. This type of event is triggered when a registration 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

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 IRTCRegistrationStateChangeEvent methods.

Method Description

IRTCRegistrationStateChangeEvent::Profile

Gets the profile associated with the registration that changed state.

IRTCRegistrationStateChangeEvent::State

Gets the state of the registration.

IRTCRegistrationStateChangeEvent::StatusCode

Gets the result code associated with the state change.

IRTCRegistrationStateChangeEvent::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 RTCE_REGISTRATION_STATE_CHANGE, the method's pEvent parameter is an IDispatch pointer for the IRTCRegistrationStateChangeEvent interface.

Remarks

To enable reception of registration state change events, the application must call the IRTCClient::EventFilter method and set an event filter mask that includes the RTCE_REGISTRATION_STATE_CHANGE event. If the application does not call IRTCClient::EventFilter, it will not receive any events.

Requirements

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

See Also

Reference

RTC Client API Interfaces