IRTCUserSearchResultsEvent:IDispatch (Windows Embedded CE 6.0)

1/6/2010

This interface retrieves information about an event of type RTCE_USERSEARCH. This type of event is triggered when an IRTCUserSearch::ExecuteSearch operation completes.

Methods

The following table shows 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 IRTCUserSearchResultsEvent methods.

Method	Description
IRTCUserSearchResultsEvent::EnumerateResults	Retrieves an enumeration of the results from the user search.
IRTCUserSearchResultsEvent::Results	Gets a collection of the results from the user search.
IRTCUserSearchResultsEvent::Profile	Gets the profile used to execute the search.
IRTCUserSearchResultsEvent::Query	Gets the query object submitted for the search.
IRTCUserSearchResultsEvent::Cookie	Gets the cookie supplied to the completed IRTCUserSearch::ExecuteSearch operation.
IRTCUserSearchResultsEvent::StatusCode	Gets the result code of the completed IRTCUserSearch::ExecuteSearch operation.
IRTCUserSearchResultsEvent::MoreAvailable	Gets a value indicating if additional, unretrieved results exist for a completed IRTCUserSearch::ExecuteSearch operation.

Obtaining a Pointer

When the application's implementation of the IRTCEventNotification::Event method indicates an RTC_EVENT enumeration value of RTCE_USERSEARCH, the method's pEvent parameter is an IDispatch pointer for the IRTCUserSearchResultsEvent interface.

The IRTCUserSearchResultsEvent interface is available by calling IUnknown::QueryInterface on the user search object.

Remarks

To enable reception of user search result events, the application must call the IRTCClient::EventFilter method and set an event filter mask that includes the RTCE_USERSEARCH 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.2 and later

See Also

Reference

RTC Client API Interfaces