StorageFolderQueryResult class

Provides access to the results of a query that lists the folder (or file groups) in the folder being queried (which is represented by a storageFolder). You can use a storageFolderQueryResult to enumerate folders or file groups in that folder.

Syntax

var storageFolderQueryResult = storageFolder.createFolderQuery();

Attributes

MarshalingBehaviorAttribute(Agile)

VersionAttribute(NTDDI_WIN8)

Members

The StorageFolderQueryResult class has these types of members:

• Events
• Methods
• Properties

Events

The StorageFolderQueryResult class has these events.

Methods

The StorageFolderQueryResult class has these methods. With C#, Visual Basic, and C++, it also inherits methods from the Object class.

Properties

The StorageFolderQueryResult class has these properties.

Remarks

You can get a storageFolderQueryResult object by calling the following methods from a storageFolder or a folderInformation object:

• storageFolder.createFolderQuery methods
• storageFolder.createFolderQueryWithOptions method
• folderInformation.createFolderQuery methods
• folderInformation.createFolderQueryWithOptions method

For more code examples that show you how to use storageFolderQueryResult objects, see the Folder enumeration sample.

To get a StorageFolderQueryResult object to enumerate the folders or file groups in a location, you must get a storageFolder that represents the location and then create a folder query

Windows Phone 8

This API is not implemented and will throw an exception if called.

Examples

This example demonstrates how to get a list folders (or file groups) from a storageFolderQueryResult object.

// Get the Pictures library, then rearrange it by month
var picturesLibrary = Windows.Storage.KnownFolders.picturesLibrary;

// Set query options to create groups of files within result
var queryOptions = new QueryOptions(Windows.Storage.Search.CommonFolderQuery.GroupByMonth);

// Create query and retrieve result
var queryResult = picturesLibrary.createFolderQuery(Windows.Storage.Search.CommonFolderQuery.groupByMonth);
queryResult.getFoldersAsync().done(function(folders) {
    // Process file groups (or folders)

    // Create an array of promises that will asynchronously
    // retrieve the files for each file group
    var promises = folders.map(function (folder) {
        return folder.getFilesAsync();
    });

    // Aggregate the results of multiple asynchronous operations
    // so that they are returned after all are completed. This
    // ensures that the groups are displayed in order.
    WinJS.Promise.join(promises).done(function (folderContents) {
        // Process the contents of each file group (or folder)

        for (var i in folderContents) {
            // Process the group/folder at index i of folderContents

            // Display the group name
            var group = outputResultGroup(folders.getAt(i).name);
            // Display the items in the group 
            outputItems(group, folderContents[i]);
        }
    });
});

The queryResult variable gets the storageFolderQueryResult that is used to retrieve file groups (or folders) that meet the criteria of the query.

Note  You need the Pictures library capability to access the library using KnownFolders.PicturesLibrary. To learn more about capabilities and file access, see File access and permissions in file picker.

Requirements

See also

Windows.Storage.storageFolder.createFolderQuery methods

Windows.Storage.storageFolder.createFolderQueryWithOptions method

Windows.Storage.BulkAccess.folderInformation.createFolderQuery methods

Windows.Storage.BulkAccess.folderInformation.createFolderQueryWithOptions method

Build date: 2/25/2013