ICatAdm::GetScope 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 the current scope object.

Syntax

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

Parameters

pIDisp [out, retval]

The current scope object. See IScopeAdm.

Return value

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

Remarks

This method assumes that the scope exists and has been found by enumerating a catalog administration object's collection of scopes using FindFirstScope or FindNextScope.

Examples

For an example, see FindFirstScope or FindNextScope.

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

See also

ICatAdm