IAdminIndexServer::GetCatalogByName method

[Indexing Service is no longer supported as of Windows XP and is unavailable for use as of Windows 8. Instead, use Windows Search for client side search and Microsoft Search Server Express for server side search.]

Retrieves an existing catalog object from a catalog collection, given its name.

Syntax

HRESULT GetCatalogByName(
  [in]          BSTR      bstrCatalogName,
  [out, retval] IDispatch **pDisp
);

Parameters

bstrCatalogName [in]

The name of an existing catalog.

pDisp [out, retval]

The CatAdm object that represents the catalog. See ICatAdm.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

This method expects an existing catalog name. When you attempt to retrieve a nonexistent catalog object, Indexing Service returns an error object with the Number property set to ERROR_NOT_FOUND.

Examples

' Get a catalog object named "Sources"
Set objCatAdm = objAdminIS.GetCatalogByName("Sources")

Requirements

See also

IAdminIndexServer