ISearchCatalogManager2::PrioritizeMatchingURLs method (searchapi.h)

Article
2024-02-22

Instructs the indexer to give a higher priority to indexing items that have URLs that match a specified pattern. These items will then have a higher priority than other indexing tasks.

Syntax

HRESULT PrioritizeMatchingURLs(
  [in] LPCWSTR          pszPattern,
  [in] PRIORITIZE_FLAGS dwPrioritizeFlags
);

Parameters

[in] pszPattern

Type: LPCWSTR

A string specifying the URL pattern that defines items that failed indexing and need re-indexing.

[in] dwPrioritizeFlags

Type: PRIORITIZE_FLAGS

A value from the PRIORITIZE_FLAGS enumeration that specifies how to process items that the indexer has failed to index.

Return value

Type: HRESULT

Returns S_OK if successful, or an error value otherwise.

Remarks

The pszPattern string must specify a pattern than matches the entire item URL. You can use the asterisk wildcard character to create your pattern string.

The PRIORITIZE_FLAG_IGNOREFAILURECOUNT flag is valid only in combination with the PRIORITIZE_FLAG_RETRYFAILEDITEMS flag.

Examples

The following examples show the use of the asterisk wildcard character and of the PRIORITIZE_FLAG_IGNOREFAILURECOUNT.

hr = cpSearchCatalogManager2->PrioritizeMatchingURLs("mapi://{<SID>}/Mailbox - Boyer Zara/*",
            PRIORITIZE_FLAG_RETRYFAILEDITEMS);

hr = cpSearchCatalogManager2->PrioritizeMatchingURLs("file:f:/Project Files/*",
            PRIORITIZE_FLAG_RETRYFAILEDITEMS);

hr = cpSearchCatalogManager2->PrioritizeMatchingURLs("file:f:/Project Files/*.docx",
            PRIORITIZE_FLAG_RETRYFAILEDITEMS | PRIORITIZE_FLAG_IGNOREFAILURECOUNT);

Requirements

Requirement	Value
Minimum supported client	Windows XP with SP2, Windows Vista with SP2 [desktop apps only]
Minimum supported server	Windows Server 2003 with SP1 [desktop apps only]
Target Platform	Windows
Header	searchapi.h
Redistributable	Windows Search (WS) 4.0

Share via