Windows.Storage.Search Namespace
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Provides classes for enumerating content in storage and performing Advanced Query Syntax (AQS) searches on the content.
Apps can retrieve content collections in a number of shapes, including the normal folder hierarchy, flat lists, and media-oriented shapes based on item properties such as year, month, artist, album, and so on. Also, apps can add content and properties to the system index to enable fast searches of app content.
Apps can also receive events that fire when a collection changes because files were created, modified, or deleted.
For an individual item, the system exposes the stream associated with the item, a thumbnail, and item properties, and provides the ability to create and delete items.
Classes
ContentIndexer |
Enables UWP apps to make private content searchable by using the system index. |
ContentIndexerQuery |
Represents a query for content properties in the ContentIndexer. |
IndexableContent |
Represents app content and properties that can be added to the ContentIndexer. |
QueryOptions |
Specifies the parameters of a search query for enumerating the contents of storage folders. |
SortEntryVector |
Provides access to the sorting criteria of the query results as a collection of SortEntry objects. |
StorageFileQueryResult |
Provides access to the results of a query of the files in the location that is represented by a StorageFolder object. You can use StorageFileQueryResult to enumerate the files in that StorageFolder location. |
StorageFolderQueryResult |
Provides access to the results of a query that lists the folder (or file groups) in the folder being queried (which is represented by a StorageFolder). You can use a StorageFolderQueryResult to enumerate folders or file groups in that folder. |
StorageItemQueryResult |
Provides access to the results of a query that lists all items including files and folders (or file groups) in the folder being queried (which is represented by a StorageFolder). You can use storageItemQueryResult to enumerate the files and folders in that StorageFolder. |
StorageLibraryChangeTrackerTriggerDetails |
Contains the details of a storage library change tracker. |
StorageLibraryContentChangedTriggerDetails |
Contains the details of a storage library content change tracker. |
ValueAndLanguage |
Specifies the language of a property, as a BCP-47 language code. |
Structs
SortEntry |
An entry in the SortOrder list the specifies a property and ordering that is used to sort query results. |
Interfaces
IIndexableContent |
Represents app content and properties that can be added to the ContentIndexer. |
IStorageFolderQueryOperations |
Provides methods to create search queries and retrieve files from a folder. This interface is implemented by StorageFolder objects, which can represent file system folders, libraries, or virtual folders that are automatically generated when queries are created using group-based CommonFolderQuery values like GroupByAlbum. |
IStorageQueryResultBase |
Provides methods to access to and manage query results. |
Enums
CommonFileQuery |
Specifies how to sort the files in the query results and determines whether the query is shallow or deep. Query results for deep queries include all files in all of the subfolders of the current folder, sorted according to the specified option. |
CommonFolderQuery |
Specifies how to group files into folders in the query results and determines whether the query is shallow or deep. Query results for deep queries include all files in all of the subfolders of the current folder, grouped into folders according to the specified option. |
DateStackOption |
Indicates the unit of time used to group files into folders if a CommonFolderQuery based on date is used to create a QueryOptions object. |
FolderDepth |
Indicates whether all files and subfolders of the folder being queried will be enumerated or if only the top-level files and subfolders will be enumerated. |
IndexedState |
Indicates whether a StorageFolder is included in the system index. |
IndexerOption |
Specifies whether the query should use the system index of the file system when enumerating content in the folder being queried. The indexer can retrieve results faster but is not available in all file locations. |