[This documentation is preliminary and is subject to change.]
Provides classes for enumerating content in storage and performing Advanced Query Syntax (AQS) searches on the content.
An app 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.
Applications 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.
Members
The Windows.Storage.Search namespace has these types of members:
Classes
The Windows.Storage.Search namespace has these classes.
| Class | Description |
|---|---|
| QueryOptions | Specifies the parameters of a search query for enumerating the contents of storage folders. |
| SortEntryVector | Provides access to a collection of SortEntry objects retrieved by the SortOrder property. |
| StorageFileQueryResult | Provides access to the results of a query of the files in the location that is represented by a storageFolder object. |
| StorageFolderQueryResult | Provides access to the results of a query that lists the folder or file groups in a location that is represented by a storageFolder object. |
| StorageItemQueryResult | Provides access to the results of a query that lists items like files, folders, and file groups in a location that is represented by a storageFolder object. |
Enumerations
The Windows.Storage.Search namespace has these enumerations.
| Enumeration | Description |
|---|---|
| CommonFileQuery | Specifies the type of the file query (shallow or deep), and how to sort the results of the query. |
| CommonFolderQuery | Describes the criteria used to group files in the results of the query and determines whether files from subfolders are included in the results. |
| DateStackOption | Specifies the grouping of content in folders retrieved by using a search query option that is based on the date, such as CommonFolderQuery.GroupByYear and CommonFolderQuery.GroupByMonth. |
| FolderDepth | Specifies options for enumerating the contents of a folder. |
| IndexedState | Specifies the indexed state of a storage folder. |
| IndexerOption | Specifies the indexer options to use when enumerating content in a folder. |
Interfaces
The Windows.Storage.Search namespace implements these interfaces.
| Interface | Description |
|---|---|
| IStorageFolderQueryOperations | Represents a folder that contains files. It can represent a file system folder, a library, or a folder that is automatically generated by using a group-based enumeration such as CommonFolderQuery.groupByAlbum. |
| IStorageQueryResultBase | Provides access to the results of a storage query. |
Structures
The Windows.Storage.Search namespace has these structures.
| Structure | Description |
|---|---|
| SortEntry | Specifies an entry in the list associated with the QueryOptions.SortOrder property. |
Requirements
|
Minimum supported client | Windows 8 Release Preview |
|---|---|
|
Minimum supported server | Windows Server 2012 |
|
Namespace |
|
|
Metadata |
|
Build date: 5/22/2012
