AreQueryOptionsSupported | areQueryOptionsSupported method
TOC
Collapse the table of content
Expand the table of content

StorageFolder.AreQueryOptionsSupported | areQueryOptionsSupported method

Indicates whether the current folder supports the specified QueryOptions.

Syntax


Public Function AreQueryOptionsSupported(
  queryOptions As QueryOptions 
) As Boolean

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 criteria 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 criteria used to filter and enumerate files and folders.

Use the AreQueryOptionsSupported method to verify that the QueryOptions you want to specify are available for the current folder. You can also check whether a specific CommonFileQuery or CommonFolderQuery value is available, by calling IsCommonFileQuerySupported or IsCommonFolderQuerySupported, respectively.

The specific options available to you depend 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.

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:

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

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.

Requirements (Windows 10 device family)

Device family

Universal, introduced version 10.0.10240.0

API contract

Windows.Foundation.UniversalApiContract, introduced version 1.0

Namespace

Windows.Storage
Windows::Storage [C++]

Metadata

Windows.Foundation.UniversalApiContract.winmd

Requirements (Windows 8.x and Windows Phone 8.x)

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows Phone 8

Namespace

Windows.Storage
Windows::Storage [C++]

Metadata

Windows.winmd

See also

StorageFolder

 

 

Show:
© 2016 Microsoft