StorageFolder.GetFoldersAsync(CommonFolderQuery, UInt32, UInt32) | getFoldersAsync(CommonFolderQuery, UInt32, UInt32) method

Applies to Windows and Windows Phone

Gets an index-based range of StorageFolder objects that represent groups of files in the current folder. Files are filtered and grouped based on the specified CommonFolderQuery and are included in the range based on the resulting indexes.

Syntax


storageFolder.getFoldersAsync(query, startIndex, maxItemsToRetrieve).done( /* Your success and error handlers */ );

Parameters

query

Type: CommonFolderQuery

The enum value that identifies the file groups that are represented by StorageFolder objects in the range to retrieve.

startIndex

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

The zero-based index of the first StorageFolder in the range to retrieve.

maxItemsToRetrieve

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

The maximum number of child folders to retrieve.

Return value

Type: IAsyncOperation<IVectorView>

When this method completes successfully, it returns a list of the files (type IVectorView). Each folder in the list is represented by a StorageFolder.

Remarks

Using a CommonFolderQuery lets you construct lists of folders and file groups based on specific file attributes (like title and date) quickly and easily.

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows Phone 8

Namespace

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

Metadata

Windows.winmd

See also

StorageFolder
GetFoldersAsync(CommonFolderQuery)
GetFoldersAsync

 

 

Show:
© 2014 Microsoft