DrtEndSearch function (drt.h)
The DrtEndSearch function cancels a search for a key in a DRT. This API can be called at any point after a search is issued.
Syntax
HRESULT DrtEndSearch(
[in] HDRT_SEARCH_CONTEXT hSearchContext
);
Parameters
[in] hSearchContext
Handle to the search context to end. This parameter is returned from DrtStartSearch.
Return value
This function returns S_OK on success. Other possible values include:
| Return code | Description |
|---|---|
|
The hSearchContext handle is invalid. |
|
The DRT infrastructure is unaware of the requested search. |
Remarks
Calling the DrtEndSearch function will stop the return of search results via DRT_SEARCH_RESULT.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 7 Professional [desktop apps only] |
| Minimum supported server | Windows Server 2008 R2 [desktop apps only] |
| Target Platform | Windows |
| Header | drt.h |
| Library | Drt.lib |
| DLL | Drt.dll |