ICatAdm::GetScopeByPath 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 an existing scope object by path.

Syntax

HRESULT GetScopeByPath(
  [in]          BSTR      bstrPath,
  [out, retval] IDispatch **pIDisp
);

Parameters

bstrPath [in]: The name of an existing scope. The scope path must be a valid local or universal naming convention (UNC) path.
pIDisp [out, retval]: The returned CatAdm scope object.

Return value

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

Remarks

The scope name must refer to a valid scope. If the scope path is not valid, an error object is created with the Number property set to ERROR_NOT_FOUND.

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