Share via

IRTCRegistrationStateChangeEvent

  • Article

RTCE_REGISTRATION_STATE_CHANGE events have an IRTCRegistrationStateChangeEvent interface. This type of event is fired when a registration changes state.

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

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

Methods in Vtable Order

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

In addition, IRTCRegistrationStateChangeEvent defines the following methods.

Method Description
get_Profile Returns the profile associated with the registration that changed state.
get_State Returns the new state of the registration.
get_StatusCode Returns the result code associated with the state change.
get_StatusText Returns the status text associated with the state change. If no status text is available, the method fails and returns E_FAIL.

Requirements

Client: Requires Windows XP.
Server: Requires Windows Server 2003.
Redistributable: Requires Rtcdll.dll on Windows 2000, and Windows Me/98.
Header: Declared in Rtccore.h.
Library: Included as a resource in Rtcdll.dll.
GUID: IID_IRTCRegistrationStateChangeEvent is defined as 62d0991b-50ab-4f02-b948-ca94f26f8f95.