IAdminIndexServer::GetCatalog method

Article
05/31/2018

[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 the current catalog object.

Syntax

HRESULT GetCatalog(
  [out, retval] IDispatch **pIDisp
);

Parameters

pIDisp [out, retval]: The CatAdm object that represents the current catalog. See ICatAdm.

Return value

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

Remarks

This method assumes that the catalog exists and has been found by enumerating an administration object's collection of catalogs using FindFirstCatalog or FindNextCatalog.

Examples

For an example, see FindFirstCatalog and FindNextCatalog.

Requirements


Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
End of client support	Windows 7
End of server support	Windows Server 2008 R2
DLL	Ciodm.dll