IStorageFolderQueryOperations.AreQueryOptionsSupported(QueryOptions) Method

Definition

Namespace:

Windows.Storage.Search

Verifies whether the folder supports the specified search query options (returns true or false).

public:
 bool AreQueryOptionsSupported(QueryOptions ^ queryOptions);

bool AreQueryOptionsSupported(QueryOptions const& queryOptions);

public bool AreQueryOptionsSupported(QueryOptions queryOptions);

function areQueryOptionsSupported(queryOptions)

Public Function AreQueryOptionsSupported (queryOptions As QueryOptions) As Boolean

Parameters

queryOptions

QueryOptions

The search query options to test.

Returns

Boolean

bool

True if the folder supports the specified search query options; otherwise false.

Remarks

Not all locations support all query options. Because folders can be retrieved by the picker and you can't control the location, you can use this method to determine whether the location supports a particular query option.

Folders in a library or the HomeGroup support all query options. Other locations only support the following options:

• A shallow enumeration, such as CommonFileQuery.DefaultQuery or CommonFolderQuery.DefaultQuery, or a QueryOptions class that was created with no constructor arguments.
• A deep, flat list of files sorted by name, such as CommonFileQuery.orderByName or the equivalent QueryOptions class.
• A deep, flat list of files sorted by search rank, such as CommonFileQuery.orderBySearchRank or the equivalent QueryOptions class.