IRTCUserSearch::ExecuteSearch
Other versions of this page are also available for the following:
.gif "A hyphen indicates that the information in this topic is not relevant for this platform, or that the platform does not support the API that is listed.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
8/28/2008
Note
This method is unsupported in Windows Embedded CE 6.0.
This method executes a search using a user search query object. Search results are in the form of an RTCE_USERSEARCH event, returned asynchronously via the IRTCUserSearchResultsEvent interface.
Syntax
HRESULT ExecuteSearch(
IRTCUserSearchQuery* pQuery,
IRTCProfile* pProfile,
LONG_PTR lCookie
);
Parameters
- pQuery
[in] Pointer to the IRTCUserSearchQuery interface on a user search query object created with IRTCUserSearch::CreateQuery.
- pProfile
[in] Pointer to the IRTCProfile interface that is to be used to request the search. The search request is sent to the registrar server specified in the profile. If the server challenges the request, the user name and password specified in the profile are used to authenticate the user; the profile does not need to be enabled. If this parameter is NULL, the RTC Client API attempts to find a suitable profile from the list of enabled profiles.
- lCookie
[in] Pointer to an application-specified cookie that identifies this request. This value is generated and maintained by the application. It is also used to synchronize search requests and results indicated by an RTCE_USERSEARCH event. The application is responsible for ensuring the uniqueness of the cookie, as well as for releasing the cookie values from completed searches.
Return Value
This method can return an RTC_E_ constant. The following table shows additional return values and additional information about specific return values.
| Value | Meaning |
|---|---|
E_OUTOFMEMORY |
Insufficient memory to perform this operation. |
E_POINTER |
The pProfile or pQuery parameter is not a valid pointer. |
RTC_E_NO_PROFILE |
The pProfile parameter is NULL and the RTC Client API is unable to find a suitable profile for the search. |
RTC_E_UDP_NOT_SUPPORTED |
The current profile specifies the UDP transport for the registrar server; subsequently, the user search is not allowed when the UDP transport is specified in the registrar server. |
Remarks
To execute a search, a profile that has PC-to-PC capabilities specified in the session type settings must be currently enabled. A profile can be created with the IRTCClientProvisioning::GetProfile method. It can then be enabled using the IRTCClientProvisioning::EnableProfile method.
Requirements
| Header | rtccore.h, rtccore.idl |
| Library | uuid.lib |
| Windows Embedded CE | Windows CE .NET 4.2 and later |
See Also
Reference
IRTCUserSearch
IRTCClientProvisioning::GetProfile
IRTCClientProvisioning::EnableProfile
IRTCProfile
IRTCUserSearch::CreateQuery
IRTCUserSearchQuery
IRTCUserSearchResultsEvent:IDispatch