IRTCUserSearchResultsEvent

The IRTCUserSearchResultsEvent interface contains details of the user search. When a search returns from IRTCUserSearch::ExecuteSearch, the RTCE_USERSEARCH event is fired, and the IRTCUserSearchResultsEvent interface is available by calling QueryInterface on the event object.

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

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

No results will be returned if the status code retrieved with get_StatusCode indicated failure.

Methods in Vtable Order

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

In addition, IRTCUserSearchResultsEvent defines the following methods.

Method Description
EnumerateResults Returns an enumeration of the results from the user search. If there are no results, an empty enumeration is returned.
get_Results Gets a collection of the results from the user search. If there are no results, an empty collection is returned.
get_Profile Gets the IRTCProfile2 interface for the profile used to execute the search.
get_Query Gets the query object submitted for the search.
get_Cookie Gets the cookie supplied to the IRTCUserSearch::ExecuteSearch operation that has completed.
get_StatusCode Gets the result code of the IRTCUserSearch::ExecuteSearch operation that has completed.
get_MoreAvailable Gets a boolean value that indicates whether or not possible unreturned results exist on the server for the IRTCUserSearch::ExecuteSearch 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_IRTCEnumSearchResultEvent is defined as D8C8C3CD-7FAC-4088-81C5-C24CBC0938E3.

See Also

Receive a Search Response

 

Show: