Windows.Storage.Search namespace
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 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. |
| 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). |
| 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). |
Enumerations
The Windows.Storage.Search namespace has these enumerations.
| Enumeration | Description |
|---|---|
| CommonFileQuery | Specifies whether the query is shallow or deep and the sorting criteria to use for files in the query results. Query results for deep queries include all files in all of the subfolders of the folder being queried and sorts them based on the specified metadata. |
| CommonFolderQuery | Specifies whether the query is shallow or deep and the sorting criteria to use to group files into folders in the query results. |
| 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. |
Interfaces
The Windows.Storage.Search namespace defines these interfaces.
| Interface | Description |
|---|---|
| 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. |
Structures
The Windows.Storage.Search namespace has these structures.
| Structure | Description |
|---|---|
| SortEntry | An entry in the SortOrder list the specifies a property and ordering that is used to sort query results. |
Remarks
Windows Phone 8
This API is not implemented and will throw an exception if called.
Requirements
|
Minimum supported client | Windows 8 |
|---|---|
|
Minimum supported server | Windows Server 2012 |
|
Minimum supported phone | Windows Phone 8 |
|
Namespace |
|
|
Metadata |
|
Build date: 2/25/2013
