ISearchManager2::CreateCatalog method (searchapi.h)

  • Article

Creates a new custom catalog in the Windows Search indexer and returns a reference to it.

Syntax

HRESULT CreateCatalog(
  [in]  LPCWSTR               pszCatalog,
  [out] ISearchCatalogManager **ppCatalogManager
);

Parameters

[in] pszCatalog

Type: LPCWSTR

Name of catalog to create. Can be any name selected by the caller, must contain only standard alphanumeric characters and underscore.

[out] ppCatalogManager

Type: ISearchCatalogManager**

On success a reference to the created catalog is returned as an ISearchCatalogManager interface pointer. The Release() must be called on this interface after the calling application has finished using it.

Return value

Type: HRESULT

HRESULT indicating status of operation:

Return code Description
S_OK
 Catalog did not previously exist and was created. Reference to catalog returned.
S_FALSE
 Catalog previously existed, reference to catalog returned.
 

FAILED HRESULT: Failure creating catalog or invalid arguments passed.

Remarks

Called to create a new catalog in the Windows Search indexer. After creation, the methods on the returned ISearchCatalog manager can be used to add locations to be indexed, monitor indexing process, and construct queries to send to the indexer and get results. For more information, see Managing the Index.

Requirements

Requirement Value
Minimum supported client Windows 8 [desktop apps only]
Minimum supported server Windows Server 2012 [desktop apps only]
Target Platform Windows
Header searchapi.h

See also

ISearchManager2