Windows Dev Center

StorageFolderQueryResult.GetFoldersAsync(UInt32, UInt32) | getFoldersAsync(UInt32, UInt32) method

[Some information relates to pre-released product which may be substantially modified before it's commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.]

Retrieves folders (or file groups) in a specified range.

Syntax


storageFolderQueryResult.getFoldersAsync(startIndex, maxNumberOfItems).done( /* Your success and error handlers */ );

Parameters

startIndex

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

The zero-based index of the first folder to retrieve. This parameter defaults to 0.

maxNumberOfItems

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

The maximum number of folders or file groups to retrieve. Use -1 to retrieve all folders. If the range contains fewer folders than the max number, all folders in the range are returned.

Return value

Type: IAsyncOperation<IVectorView>

When this method completes successfully, it returns a list (type IVectorView) of folders or file groups that are represented by storageFolder objects.

Remarks

Use this overload to improve system performance by presenting a virtualized view of the query results that includes only the necessary subset of folders. For example, if your app displays many folders in a gallery you could use this range to retrieve only the folders that are currently visible to the user.

Requirements (Windows 10 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 (Windows 8.x and Windows Phone 8.x)

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows 10 Mobile

Namespace

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

Metadata

Windows.winmd

See also

storageFolderQueryResult class
storageFolderQueryResult.getFoldersAsync() method
Windows.Foundation.Collections.IVectorView interface

 

 

Show:
© 2015 Microsoft