IStorageFolderQueryOperations.IsCommonFileQuerySupported Method

Definition

Namespace:

Windows.Storage.Search

Verifies whether this folder supports the specified file query (returns true or false).

public:
 bool IsCommonFileQuerySupported(CommonFileQuery query);

bool IsCommonFileQuerySupported(CommonFileQuery const& query);

public bool IsCommonFileQuerySupported(CommonFileQuery query);

function isCommonFileQuerySupported(query)

Public Function IsCommonFileQuerySupported (query As CommonFileQuery) As Boolean

Parameters

query

CommonFileQuery

The file query to test.

Returns

Boolean

bool

True if the folder supports the specified file query; otherwise false.

Remarks

Not all locations support all query options. Because files 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.