Skip to content

Latest commit

 

History

History
38 lines (26 loc) · 2.45 KB

storagefolder_getfoldersasync_731846614.md

File metadata and controls

38 lines (26 loc) · 2.45 KB
-api-id -api-type
M:Windows.Storage.StorageFolder.GetFoldersAsync(Windows.Storage.Search.CommonFolderQuery,System.UInt32,System.UInt32)
winrt method

Windows.Storage.StorageFolder.GetFoldersAsync

-description

Gets an index-based range of folders from the list of all subfolders in the current folder. When the value of the query argument is something other than CommonFolderQuery.DefaultQuery, gets a list of virtual folders that represent containers for groups of files in the subfolders of the current folder. Files are grouped into folders based on the specified value from the CommonFolderQuery enumeration.

-parameters

-param query

One of the enumeration values that specifies how to group the files into folders and determines whether the query is shallow or deep.

-param startIndex

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

-param maxItemsToRetrieve

The maximum number of folders to retrieve.

-returns

When this method completes successfully, it returns a list of subfolders. When the value of the query argument is something other than CommonFolderQuery.DefaultQuery, this method returns a list of virtual folders that represent containers for groups of files in the subfolders of the current folder. (Files from the current folder are not included.) The files are grouped as specified by query. The list is of type IReadOnlyList<StorageFolder>. Each folder in the list is represented by a StorageFolder object.

-exceptions

T:System.UnauthorizedAccessException

You don't have permission to access the contents of the current folder. For more information, see File access permissions.

-remarks

-examples

-see-also

File access permissions, GetFoldersAsync(CommonFolderQuery), GetFoldersAsync, GetItemsAsync