I​Storage​Folder​Query​Operations I​Storage​Folder​Query​Operations I​Storage​Folder​Query​Operations Interface

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

public PlatForm::Boolean AreQueryOptionsSupported(QueryOptions queryOptions)public bool AreQueryOptionsSupported(QueryOptions queryOptions)Public Function AreQueryOptionsSupported(queryOptions As QueryOptions) As bool

Attributes

ContractVersionAttribute GuidAttribute

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.

Retrieves an object for enumerating the files in a storage location and subscribing to events that fire when the contents of the storage location change.

public StorageFileQueryResult CreateFileQuery()public StorageFileQueryResult CreateFileQuery()Public Function CreateFileQuery() As StorageFileQueryResult

Attributes

OverloadAttribute

Retrieves an object with the specified options for enumerating the storage location in a folder and subscribing to events that fire when the contents of the storage location change.

public StorageFileQueryResult CreateFileQuery(CommonFileQuery query)public StorageFileQueryResult CreateFileQuery(CommonFileQuery query)Public Function CreateFileQuery(query As CommonFileQuery) As StorageFileQueryResult

Attributes

OverloadAttribute

Retrieves an object with the specified options for enumerating the files in a storage location and subscribing to events that fire when the contents of the storage location change.

public StorageFileQueryResult CreateFileQueryWithOptions(QueryOptions queryOptions)public StorageFileQueryResult CreateFileQueryWithOptions(QueryOptions queryOptions)Public Function CreateFileQueryWithOptions(queryOptions As QueryOptions) As StorageFileQueryResult

Attributes

ContractVersionAttribute GuidAttribute

Retrieves an object for enumerating folders in a storage location and subscribing to events that fire when the contents of the storage location change.

public StorageFolderQueryResult CreateFolderQuery()public StorageFolderQueryResult CreateFolderQuery()Public Function CreateFolderQuery() As StorageFolderQueryResult

Attributes

OverloadAttribute

Retrieves an object with the specified options for enumerating folders in a storage location and subscribing to events that fire when the contents of the storage location change.

public StorageFolderQueryResult CreateFolderQuery(CommonFolderQuery query)public StorageFolderQueryResult CreateFolderQuery(CommonFolderQuery query)Public Function CreateFolderQuery(query As CommonFolderQuery) As StorageFolderQueryResult

Attributes

OverloadAttribute

Retrieves an object with the specified options for enumerating folders in a storage location and subscribing to events that fire when the contents of the storage location change.

public StorageFolderQueryResult CreateFolderQueryWithOptions(QueryOptions queryOptions)public StorageFolderQueryResult CreateFolderQueryWithOptions(QueryOptions queryOptions)Public Function CreateFolderQueryWithOptions(queryOptions As QueryOptions) As StorageFolderQueryResult

Attributes

ContractVersionAttribute GuidAttribute

Remarks

You can use QueryOptions and CreateFileQueryWithOptions to create an indexed backed file query that lets you get properties that rely on another app's property handler. For more information see QueryOptions.

Retrieves an object for performing shallow enumerations of the files and folders in a storage location. An app can use the object to enumerate the items in a storage location and subscribe to events that fire when the contents of the storage location change.

public StorageItemQueryResult CreateItemQuery()public StorageItemQueryResult CreateItemQuery()Public Function CreateItemQuery() As StorageItemQueryResult

Attributes

ContractVersionAttribute GuidAttribute

Retrieves an object with the specified options for enumerating the files and folders in a storage location and subscribing to events that fire when the contents of the storage location change.

public StorageItemQueryResult CreateItemQueryWithOptions(QueryOptions queryOptions)public StorageItemQueryResult CreateItemQueryWithOptions(QueryOptions queryOptions)Public Function CreateItemQueryWithOptions(queryOptions As QueryOptions) As StorageItemQueryResult

Attributes

ContractVersionAttribute GuidAttribute

Remarks

Don't set QueryOptions.FolderDepth to FolderDepth.Deep; deep queries do not work if you are querying files in a Digital Living Network Alliance (DLNA) device.

Retrieves a list of files based on the specified query (shallow enumeration). This returns a snapshot of the files at a point in time and does not allow you to keep track of changes through events.

public IAsyncOperation<IVectorView<StorageFile>> GetFilesAsync(CommonFileQuery query)public IAsyncOperation<IVectorView<StorageFile>> GetFilesAsync(CommonFileQuery query)Public Function GetFilesAsync(query As CommonFileQuery) As IAsyncOperation( Of IVectorViewStorageFile )

Attributes

OverloadAttribute RemoteAsyncAttribute

Retrieves a list of files in a specified range that are based on the specified file query. This returns a snapshot of the files at a point in time and does not allow you to keep track of changes through events.

public IAsyncOperation<IVectorView<StorageFile>> GetFilesAsync(CommonFileQuery query, UInt32 startIndex, UInt32 maxItemsToRetrieve)public IAsyncOperation<IVectorView<StorageFile>> GetFilesAsync(CommonFileQuery query, UInt32 startIndex, UInt32 maxItemsToRetrieve)Public Function GetFilesAsync(query As CommonFileQuery, startIndex As UInt32, maxItemsToRetrieve As UInt32) As IAsyncOperation( Of IVectorViewStorageFile )

Attributes

OverloadAttribute RemoteAsyncAttribute

Remarks

Use this overload to retrieve improve system performance by presenting a virtual view of the query results that includes only the necessary subset of files.

Retrieves a list of folders and file groups based on a specified folder query. This returns a snapshot of the folders or file groups at a point in time and does not allow you to keep track of changes through events.

public IAsyncOperation<IVectorView<StorageFolder>> GetFoldersAsync(CommonFolderQuery query)public IAsyncOperation<IVectorView<StorageFolder>> GetFoldersAsync(CommonFolderQuery query)Public Function GetFoldersAsync(query As CommonFolderQuery) As IAsyncOperation( Of IVectorViewStorageFolder )

Attributes

OverloadAttribute RemoteAsyncAttribute

Asynchronously retrieves a range of folders in this folder based on a folder query. This returns a snapshot of the folders or file groups at a point in time and does not allow you to keep track of changes through events.

public IAsyncOperation<IVectorView<StorageFolder>> GetFoldersAsync(CommonFolderQuery query, UInt32 startIndex, UInt32 maxItemsToRetrieve)public IAsyncOperation<IVectorView<StorageFolder>> GetFoldersAsync(CommonFolderQuery query, UInt32 startIndex, UInt32 maxItemsToRetrieve)Public Function GetFoldersAsync(query As CommonFolderQuery, startIndex As UInt32, maxItemsToRetrieve As UInt32) As IAsyncOperation( Of IVectorViewStorageFolder )

Attributes

OverloadAttribute RemoteAsyncAttribute

Remarks

Use this overload to retrieve improve system performance by presenting a virtual view of the query results that includes only the necessary subset of folders.

Retrieves a value that indicates the indexed state of the StorageFolder location associated with the query.

public IAsyncOperation<IndexedState> GetIndexedStateAsync()public IAsyncOperation<IndexedState> GetIndexedStateAsync()Public Function GetIndexedStateAsync() As IAsyncOperation( Of IndexedState )

Attributes

RemoteAsyncAttribute

Retrieves a list items like files, folders, or file groups, in a specified range (shallow enumeration).

public IAsyncOperation<IVectorView<IStorageItem>> GetItemsAsync(UInt32 startIndex, UInt32 maxItemsToRetrieve)public IAsyncOperation<IVectorView<IStorageItem>> GetItemsAsync(UInt32 startIndex, UInt32 maxItemsToRetrieve)Public Function GetItemsAsync(startIndex As UInt32, maxItemsToRetrieve As UInt32) As IAsyncOperation( Of IVectorViewIStorageItem )

Attributes

OverloadAttribute RemoteAsyncAttribute

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

public PlatForm::Boolean IsCommonFileQuerySupported(CommonFileQuery query)public bool IsCommonFileQuerySupported(CommonFileQuery query)Public Function IsCommonFileQuerySupported(query As CommonFileQuery) As bool

Attributes

ContractVersionAttribute GuidAttribute

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.

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

public PlatForm::Boolean IsCommonFolderQuerySupported(CommonFolderQuery query)public bool IsCommonFolderQuerySupported(CommonFolderQuery query)Public Function IsCommonFolderQuerySupported(query As CommonFolderQuery) As bool

Attributes

ContractVersionAttribute GuidAttribute

Remarks

Not all locations support all query options, for more detail refer to IsCommonFileQuerySupported.