IStorageFolderQueryOperations.GetFilesAsync(CommonFileQuery, UInt32, UInt32) method

[This documentation is preliminary and is subject to change.]

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.

Syntax


IAsyncOperation<IReadOnlyList> GetFilesAsync(
  CommonFileQuery query, 
  uint startIndex, 
  uint maxItemsToRetrieve
)

Parameters

query

Type: CommonFileQuery

The type of file query to perform.

startIndex

Type: System.UInt32 [.NET] | uint32 [C++]

The zero-based index of the first file in the range. This parameter defaults to 0.

maxItemsToRetrieve

Type: System.UInt32 [.NET] | uint32 [C++]

The maximum number of files to retrieve. Use -1 to retrieve all files.

Return value

Type: IAsyncOperation<IVectorView>

When this method completes successfully, it returns a list (type IVectorView) of files that are represented by StorageFile objects.

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.

Requirements (device family)

Device family

Universal

API contract

Windows.Foundation.UniversalApiContract, introduced version 1.0

Namespace

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

Metadata

Windows.Foundation.UniversalApiContract.winmd

Requirements (operating system)

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows 10 Technical Preview for phones

Namespace

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

Metadata

Windows.winmd

See also

IStorageFolderQueryOperations interface
IStorageFolderQueryOperations.GetFilesAsync methods
IStorageFolderQueryOperations.GetFilesAsync(CommonFileQuery) method
Windows.Foundation.IVectorView interface
Windows.Storage.StorageFile class

 

 

Show:
© 2015 Microsoft