Mawosoft.PowerShell.WindowsSearchManager.xml
<?xml version="1.0"?>
<doc> <assembly> <name>Mawosoft.PowerShell.WindowsSearchManager</name> </assembly> <members> <member name="T:Mawosoft.PowerShell.WindowsSearchManager.AddSearchRootCommand"> <summary> Adds search roots to a search catalog. </summary> </member> <member name="T:Mawosoft.PowerShell.WindowsSearchManager.AddSearchRuleCommand"> <summary> Adds search rules to a search catalog. </summary> </member> <member name="T:Mawosoft.PowerShell.WindowsSearchManager.GetSearchCatalogCommand"> <summary> Gets settings and status of all search catalogs or for a specified one. </summary> </member> <member name="T:Mawosoft.PowerShell.WindowsSearchManager.GetSearchManagerCommand"> <summary> Gets global settings and version information for Windows Search. </summary> <remarks> Requires admin rights. </remarks> </member> <member name="T:Mawosoft.PowerShell.WindowsSearchManager.GetSearchRootCommand"> <summary> Gets all search roots defined for a search catalog. </summary> </member> <member name="T:Mawosoft.PowerShell.WindowsSearchManager.GetSearchRuleCommand"> <summary> Gets the search rules in effect for a search catalog. </summary> </member> <member name="T:Mawosoft.PowerShell.WindowsSearchManager.DefaultSearchManagerFactory"> <summary> Default implementation of <see cref="T:Mawosoft.PowerShell.WindowsSearchManager.ISearchManagerFactory"/>. </summary> </member> <member name="T:Mawosoft.PowerShell.WindowsSearchManager.ISearchManagerFactory"> <summary> Factory abstraction for creating instances of <see cref="T:SearchAPI.ISearchManager"/> and <see cref="T:Mawosoft.PowerShell.WindowsSearchManager.ISearchRegistryProvider"/>. </summary> </member> <member name="T:Mawosoft.PowerShell.WindowsSearchManager.ISearchRegistryProvider"> <summary> Interface for accessing Windows Search registry entries. </summary> </member> <member name="M:Mawosoft.PowerShell.WindowsSearchManager.ISearchRegistryProvider.GetCatalogNames"> <summary> Returns a list of registered search catalog names. </summary> </member> <member name="T:Mawosoft.PowerShell.WindowsSearchManager.SearchApiErrorHelper"> <summary> Helper for handling errors returned from the SearchAPI interfaces. </summary> </member> <member name="M:Mawosoft.PowerShell.WindowsSearchManager.SearchApiErrorHelper.TryGetCOMExceptionMessage(System.Exception,System.String@)"> <summary> Try to get a SearchAPI-specific message for given COMException. Accepts generic Exception for convenience. </summary> </member> <member name="M:Mawosoft.PowerShell.WindowsSearchManager.SearchApiErrorHelper.TryWrapCOMException(System.Exception,System.Management.Automation.ErrorRecord@)"> <summary> Try to wrap a COMException in an ErrorRecord with SearchAPI-specific message. Accepts generic Exception for convenience. </summary> </member> <member name="M:Mawosoft.PowerShell.WindowsSearchManager.SearchApiErrorHelper.TrySetErrorDetails(System.Management.Automation.ErrorRecord)"> <summary> Try to set ErrorDetails to a SearchAPI-specific message. </summary> </member> <member name="T:Mawosoft.PowerShell.WindowsSearchManager.SearchRegistryProviderBase"> <summary> Base class for implementations of <see cref="T:Mawosoft.PowerShell.WindowsSearchManager.ISearchRegistryProvider"/>. </summary> </member> <member name="T:Mawosoft.PowerShell.WindowsSearchManager.SearchRegistryProviderPSCore"> <summary> Implementation of <see cref="T:Mawosoft.PowerShell.WindowsSearchManager.ISearchRegistryProvider"/> for PowerShell Core. </summary> </member> <member name="M:Mawosoft.PowerShell.WindowsSearchManager.SearchRegistryProviderPSCore.GetCatalogNames"> <inheritdoc/> </member> <member name="T:Mawosoft.PowerShell.WindowsSearchManager.SearchRegistryProviderPSDesktop"> <summary> Implementation of <see cref="T:Mawosoft.PowerShell.WindowsSearchManager.ISearchRegistryProvider"/> for Windows PowerShell. </summary> <remarks> In Windows PowerShell, the <see cref="T:Microsoft.Win32.Registry"/> type is already loaded via mscorlib. Using the type directly via the extension package (as in <see cref="T:Mawosoft.PowerShell.WindowsSearchManager.SearchRegistryProviderPSCore"/>) would cause a TypeLoadException. Therefore we use reflection here. </remarks> </member> <member name="M:Mawosoft.PowerShell.WindowsSearchManager.SearchRegistryProviderPSDesktop.GetCatalogNames"> <inheritdoc/> </member> <member name="T:Mawosoft.PowerShell.WindowsSearchManager.NewSearchCatalogCommand"> <summary> Creates a new search catalog. </summary> </member> <member name="T:Mawosoft.PowerShell.WindowsSearchManager.RemoveSearchCatalogCommand"> <summary> Deletes the specified search catalog. </summary> </member> <member name="T:Mawosoft.PowerShell.WindowsSearchManager.RemoveSearchRootCommand"> <summary> Deletes the specified search roots from a search catalog. </summary> </member> <member name="T:Mawosoft.PowerShell.WindowsSearchManager.RemoveSearchRuleCommand"> <summary> Deletes the specified search rules from a search catalog. </summary> </member> <member name="T:Mawosoft.PowerShell.WindowsSearchManager.ResetSearchCatalogCommand"> <summary> Resets a search catalog by completely rebuilding its index database. </summary> <remarks> Requires admin rights. </remarks> </member> <member name="T:Mawosoft.PowerShell.WindowsSearchManager.ResetSearchRuleCommand"> <summary> Resets a catalog to the default search rules. </summary> </member> <member name="T:Mawosoft.PowerShell.WindowsSearchManager.SR"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.SR.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.SR.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.SR.AdminRequiredForOperation"> <summary> Looks up a localized string similar to This operation requires administrative privileges.. </summary> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.SR.InterfaceNotAvailable"> <summary> Looks up a localized string similar to The interface {0} is not available.. </summary> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.SR.NA_AdminRequired"> <summary> Looks up a localized string similar to N/A: Requires admin rights.. </summary> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.SR.OverrideChildrenNotSupported"> <summary> Looks up a localized string similar to OverrideChildren not supported for default rule set.. </summary> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.SR.ReturnedCOMObjectIsNull"> <summary> Looks up a localized string similar to Returned COMObject {0} is null, but no error info is available.. </summary> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.SR.SetProxy"> <summary> Looks up a localized string similar to Proxy: Access={0}, Name={1}, PortNumber={2}, BypassLocal={3}, BypassList={4}. </summary> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.SR.SetUserAgent"> <summary> Looks up a localized string similar to User Agent={0}. </summary> </member> <member name="T:Mawosoft.PowerShell.WindowsSearchManager.SearchApiCommandBase"> <summary> Base class for all SearchAPI-related commands. </summary> </member> <member name="F:Mawosoft.PowerShell.WindowsSearchManager.SearchApiCommandBase.DefaultCatalogName"> <summary> The name of the default Windows Search catalog </summary> </member> <member name="T:Mawosoft.PowerShell.WindowsSearchManager.SearchCatalogInfo"> <summary> Contains settings and status for a search catalog. </summary> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.SearchCatalogInfo.Catalog"> <value>The catalog name.</value> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.SearchCatalogInfo.ConnectTimeout"> <value>The time, in seconds, that the indexer should wait for a connection response from a server or data store.</value> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.SearchCatalogInfo.DataTimeout"> <value>The time, in seconds, that the indexer should wait for a data transaction.</value> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.SearchCatalogInfo.DiacriticSensitivity"> <value><c>true</c> if the catalog should differentiate words with diacritics. <c>false</c> if the catalog should ignore diacritics.</value> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.SearchCatalogInfo.Status"> <value>One of the enumeration values that indicates the current catalog status.</value> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.SearchCatalogInfo.PausedReason"> <value>One of the enumeration values that indicates why the catalog is paused.</value> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.SearchCatalogInfo.ItemCount"> <value>The number of items in the catalog.</value> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.SearchCatalogInfo.ItemsToIndexCount"> <value>The number of items to be indexed during the next incremental crawl.</value> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.SearchCatalogInfo.NotificationQueueCount"> <value>The number of items in the notification queue.</value> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.SearchCatalogInfo.HighPriorityQueueCount"> <value>The number of items in the high-priority queue.</value> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.SearchCatalogInfo.PathBeingIndexed"> <value>The path currently being indexed.</value> </member> <member name="M:Mawosoft.PowerShell.WindowsSearchManager.SearchCatalogInfo.#ctor"> <summary> Initializes a new instance of the <see cref="T:Mawosoft.PowerShell.WindowsSearchManager.SearchCatalogInfo"/> class. </summary> </member> <member name="M:Mawosoft.PowerShell.WindowsSearchManager.SearchCatalogInfo.Clone"> <summary> Creates a shallow copy of the <see cref="T:Mawosoft.PowerShell.WindowsSearchManager.SearchCatalogInfo"/> instance. </summary> <returns>A shallow copy of the <see cref="T:Mawosoft.PowerShell.WindowsSearchManager.SearchCatalogInfo"/> instance.</returns> </member> <member name="T:Mawosoft.PowerShell.WindowsSearchManager.SearchManagerInfo"> <summary> Contains the global settings and version information for Windows Search. </summary> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.SearchManagerInfo.Version"> <value> The complete version number of the indexer. For Windows 10 and newer, this will typically match the OS version number. </value> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.SearchManagerInfo.MajorVersion"> <value>The major version number of the indexer.</value> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.SearchManagerInfo.MinorVersion"> <value>The minor version number of the indexer.</value> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.SearchManagerInfo.UserAgent"> <value>The user agent string that a user agent passes to website and services to identify itself.</value> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.SearchManagerInfo.ProxyAccess"> <value>One of the enumeration values that indicates if and how a proxy server is used.</value> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.SearchManagerInfo.ProxyName"> <value>The name of the proxy server.</value> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.SearchManagerInfo.ProxyPortNumber"> <value>The port number of the proxy server.</value> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.SearchManagerInfo.ProxyBypassLocal"> <value><c>true</c> if the proxy should be bypassed for local domains, <c>false</c> otherwise.</value> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.SearchManagerInfo.ProxyBypassList"> <value> A comma-separated list of items that are considered local by the indexer and are not to be accessed through a proxy server. </value> </member> <member name="M:Mawosoft.PowerShell.WindowsSearchManager.SearchManagerInfo.#ctor"> <summary> Initializes a new instance of the <see cref="T:Mawosoft.PowerShell.WindowsSearchManager.SearchManagerInfo"/> class. </summary> </member> <member name="M:Mawosoft.PowerShell.WindowsSearchManager.SearchManagerInfo.Clone"> <summary> Creates a shallow copy of the <see cref="T:Mawosoft.PowerShell.WindowsSearchManager.SearchManagerInfo"/> instance. </summary> <returns>A shallow copy of the <see cref="T:Mawosoft.PowerShell.WindowsSearchManager.SearchManagerInfo"/> instance.</returns> </member> <member name="T:Mawosoft.PowerShell.WindowsSearchManager.SearchRootInfo"> <summary> Contains information about a search root in a search catalog. </summary> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.SearchRootInfo.Path"> <value>The root URL of this search root.</value> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.SearchRootInfo.IsHierarchical"> <value><c>true</c> if this search root is hierarchical, <c>false</c> otherwise.</value> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.SearchRootInfo.ProvidesNotifications"> <value><c>true</c> if this search root provides notifications, <c>false</c> otherwise.</value> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.SearchRootInfo.UseNotificationsOnly"> <value> <c>true</c> if this search root should be indexed only by notification and not crawled, <c>false</c> otherwise. </value> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.SearchRootInfo.EnumerationDepth"> <value>The enumeration depth of this search root.</value> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.SearchRootInfo.HostDepth"> <value>The host depth of this search root.</value> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.SearchRootInfo.FollowDirectories"> <value> <c>true</c> if the search engine should follow subdirectories and hierarchical scopes for this search root, <c>false</c> otherwise. </value> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.SearchRootInfo.AuthenticationType"> <value>One of the enumeration values indicating the authentication type needed to access this search root.</value> </member> <member name="M:Mawosoft.PowerShell.WindowsSearchManager.SearchRootInfo.#ctor"> <summary> Initializes a new instance of the <see cref="T:Mawosoft.PowerShell.WindowsSearchManager.SearchRootInfo"/> class. </summary> </member> <member name="M:Mawosoft.PowerShell.WindowsSearchManager.SearchRootInfo.Clone"> <summary> Creates a shallow copy of the <see cref="T:Mawosoft.PowerShell.WindowsSearchManager.SearchRootInfo"/> instance. </summary> <returns>A shallow copy of the <see cref="T:Mawosoft.PowerShell.WindowsSearchManager.SearchRootInfo"/> instance.</returns> </member> <member name="T:Mawosoft.PowerShell.WindowsSearchManager.SearchRuleInfo"> <summary> Contains information about a search rule in a search catalog. </summary> </member> <member name="T:Mawosoft.PowerShell.WindowsSearchManager.SearchRuleInfo.SearchRuleType"> <summary> Specifies the type of a search rule. </summary> </member> <member name="F:Mawosoft.PowerShell.WindowsSearchManager.SearchRuleInfo.SearchRuleType.Exclude"> <summary> The rule excludes items from indexing. </summary> </member> <member name="F:Mawosoft.PowerShell.WindowsSearchManager.SearchRuleInfo.SearchRuleType.Include"> <summary> The rule includes items into the index. </summary> </member> <member name="T:Mawosoft.PowerShell.WindowsSearchManager.SearchRuleInfo.SearchRuleSet"> <summary> Specifies the rule set a search rule belongs to. </summary> </member> <member name="F:Mawosoft.PowerShell.WindowsSearchManager.SearchRuleInfo.SearchRuleSet.User"> <summary> The search rule belongs to the user scope. </summary> </member> <member name="F:Mawosoft.PowerShell.WindowsSearchManager.SearchRuleInfo.SearchRuleSet.Default"> <summary> The search rule belongs to the default scope. </summary> </member> <member name="T:Mawosoft.PowerShell.WindowsSearchManager.SearchRuleInfo._FOLLOW_FLAGS"> <summary> Specifies whether to follow complex URLs and whether a URL is to be indexed or just followed. </summary> </member> <member name="F:Mawosoft.PowerShell.WindowsSearchManager.SearchRuleInfo._FOLLOW_FLAGS.FF_INDEXCOMPLEXURLS"> <summary> Complex URLs should be indexed. </summary> </member> <member name="F:Mawosoft.PowerShell.WindowsSearchManager.SearchRuleInfo._FOLLOW_FLAGS.FF_SUPPRESSINDEXING"> <summary> Follow but do not index this URL. </summary> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.SearchRuleInfo.Path"> <value>The URL, path, or pattern of this search rule.</value> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.SearchRuleInfo.RuleType"> <value>One of the enumeration values indicating whether this is an inclusion or exclusion rule.</value> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.SearchRuleInfo.RuleSet"> <value>One of the enumeration values indicating whether this is a user scope or default scope rule.</value> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.SearchRuleInfo.FollowFlags"> <value> A combination of enumeration values to indicate whether to follow complex URLs and whether a URL is to be indexed or just followed. </value> </member> <member name="M:Mawosoft.PowerShell.WindowsSearchManager.SearchRuleInfo.#ctor"> <summary> Initializes a new instance of the <see cref="T:Mawosoft.PowerShell.WindowsSearchManager.SearchRuleInfo"/> class. </summary> </member> <member name="M:Mawosoft.PowerShell.WindowsSearchManager.SearchRuleInfo.Clone"> <summary> Creates a shallow copy of the <see cref="T:Mawosoft.PowerShell.WindowsSearchManager.SearchRuleInfo"/> instance. </summary> <returns>A shallow copy of the <see cref="T:Mawosoft.PowerShell.WindowsSearchManager.SearchRuleInfo"/> instance.</returns> </member> <member name="T:Mawosoft.PowerShell.WindowsSearchManager.SetSearchCatalogCommand"> <summary> Changes settings for a search catalog. </summary> </member> <member name="T:Mawosoft.PowerShell.WindowsSearchManager.SetSearchManagerCommand"> <summary> Changes global settings for Windows Search. </summary> <remarks> Requires admin rights. </remarks> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.SetSearchManagerCommand.ProxyName"> <summary> Gets or sets the proxy name. An empty string is allowed to clear the proxy info if ProxyAccess != PROXY_ACCESS_PROXY. </summary> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.SetSearchManagerCommand.ProxyPortNumber"> <summary> Gets or sets the proxy port number. Valid numbers start with 1, but 0 is allowed for clearing the proxy info if ProxyAccess != PROXY_ACCESS_PROXY. </summary> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.SetSearchManagerCommand.ProxyBypassList"> <summary> Gets or sets the proxy bypass list. An empty array or string is allowed if there is nothing to bypass. </summary> </member> <member name="T:Mawosoft.PowerShell.WindowsSearchManager.TestSearchRuleCommand"> <summary> Tests specified paths against the search rules of a search catalog. </summary> </member> <member name="T:Mawosoft.PowerShell.WindowsSearchManager.TestSearchRuleInfo"> <summary> Contains the detailed result of testing a path against the search rules of a search catalog. </summary> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.TestSearchRuleInfo.Path"> <value>The path that has been tested.</value> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.TestSearchRuleInfo.IsIncluded"> <value><c>true</c> if the path is included in the index, <c>false</c> otherwise.</value> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.TestSearchRuleInfo.Reason"> <value>One of the enumeration values indicating the reason why a path is included or excluded.</value> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.TestSearchRuleInfo.HasChildScope"> <value><c>true</c> if the path has a child scope, <c>false</c> otherwise.</value> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.TestSearchRuleInfo.HasParentScope"> <value><c>true</c> if the path has a parent scope, <c>false</c> otherwise.</value> </member> <member name="P:Mawosoft.PowerShell.WindowsSearchManager.TestSearchRuleInfo.ParentScopeVersiondId"> <value>The parent scope version ID.</value> </member> <member name="M:Mawosoft.PowerShell.WindowsSearchManager.TestSearchRuleInfo.#ctor"> <summary> Initializes a new instance of the <see cref="T:Mawosoft.PowerShell.WindowsSearchManager.TestSearchRuleInfo"/> class. </summary> </member> <member name="M:Mawosoft.PowerShell.WindowsSearchManager.TestSearchRuleInfo.Clone"> <summary> Creates a shallow copy of the <see cref="T:Mawosoft.PowerShell.WindowsSearchManager.TestSearchRuleInfo"/> instance. </summary> <returns>A shallow copy of the <see cref="T:Mawosoft.PowerShell.WindowsSearchManager.TestSearchRuleInfo"/> instance.</returns> </member> <member name="T:Mawosoft.PowerShell.WindowsSearchManager.UpdateSearchCatalogCommand"> <summary> Reindexes a search catalog either completely or partially. </summary> <remarks> Requires admin rights when using the <c>-All</c> switch. </remarks> </member> </members> </doc> |