ICatAdm::GetScopeByAlias 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 scope object by alias or alternative friendly name for the scope.
Syntax
HRESULT GetScopeByAlias(
[in] BSTR bstrAlias,
[out, retval] IDispatch **pIDisp
);
Parameters
-
bstrAlias [in]
-
The alias of an existing scope.
-
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 name is not valid, an error object is created with the Number property set to ERROR_NOT_FOUND. The alias of a scope is defined by the Alias property of the scope's ScopeAdm object.
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 |
|
See also