This topic has not yet been rated - Rate this topic

StorageItemQueryResult.GetItemsAsync() | getItemsAsync() method

Retrieves a list of all the items (files and folders) in the query results set.

Syntax


storageItemQueryResult.getItemsAsync().done( /* Your success and error handlers */ );

Parameters

This method has no parameters.

Return value

Type: IAsyncOperation<IVectorView>

When this method completes successfully, it returns a list (type IVectorView) of items. Each item is the IStorageItem type and represents a file, folder, or file group.

In this list, files are represented by storageFile objects, and folders or file groups are represented by storageFolder objects.

Remarks

Use IStorageItem.isOfType to find out whether an item in the list is a storageFile or storageFolder object.

You can then cast the item to the appropriate type, and access storageFile or storageFolder properties and methods.

Note Casting isn't necessary in JavaScript.

Windows Phone 8

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

Examples

Use the then or done method to capture and process the list of items that is returned by this method, as in the following example.

JavaScript


storageItemQueryResults.getItemsAsync().then(
    function (items) {
        items.forEach(
            function (item) {
                if (item.isOfType(Windows.Storage.StorageItemTypes.folder)) {
                    // Process folder
                } else {
                    // Process file
                }
            }
        ); 
    }
);

Requirements

Minimum supported client	Windows 8
Minimum supported server	Windows Server 2012
Minimum supported phone	Windows Phone 8
Namespace	Windows.Storage.Search Windows::Storage::Search [C++]
Metadata	Windows.winmd