StorageFolder.AreQueryOptionsSupported | areQueryOptionsSupported method

Determines whether the current folder supports the specified QueryOptions.

Syntax

var boolean = storageFolder.areQueryOptionsSupported(queryOptions);

Parameters

queryOptions

Type: QueryOptions

The QueryOptions to check.

Return value

Type: Boolean [JavaScript] | System.Boolean [.NET] | Platform::Boolean [C++]

True if the folder or file group supports the specified QueryOptions; otherwise false.

Remarks

QueryOptions let you enumerate files in a folder and its subfolders by letting you specify criterion that you can then use to create a query result object of files in that folder and subfolders. The CommonFileQuery and CommonFolderQuery enumeration represent some of the most common criterion used to filter and enumerate files and folders.

We recommend that you use this method to verify that the QueryOptions you specify are available for the current folder. You can also check if a specific CommonFileQuery or CommonFolderQuery value is available, by calling IsCommonFileQuerySupported or IsCommonFolderQuerySupported, respectively.

The specific options (or enum values) available to you depends on where the files or folders that you want to enumerate are located. For folders and files that are located inside a library or homegroup, you can use any combination of QueryOptions.

For Windows Server 2012:  You must install indexer components to use some QueryOptions, CommonFileQuery values, and CommonFolderQuery values because indexer components are not installed by default.

Folders and files outside of a library or homegroup support a only subset of options.

For queries that enumerate only the top-level files or folders (also known as a shallow query), create a QueryOptions object in one of the following three ways:

• Call the default QueryOptions() constructor.
• Call the QueryOptions(CommonFolderQuery) constructor and specify CommonFolderQuery.DefaultQuery.
• Call the QueryOptions(CommonFileQuery, IIterable(String)) constructor and specify CommonFileQuery.DefaultQuery. You can still specify file types to be filtered when you use this constructor.

For queries that enumerate all of the files inside the current folder (also known as a deep query),, create a QueryOptions object in one of the following two ways:

• Call the QueryOptions(CommonFolderQuery) constructor and specify CommonFileQuery.OrderBySearchRank.
• Call the QueryOptions(CommonFileQuery, IIterable(String)) constructor and specify CommonFileQuery.OrderByName. You can still specify file types to be filtered when you use this constructor.

Requirements

See also

StorageFolder

Build date: 2/25/2013