StorageItemQueryResult.GetItemsAsync() | getItemsAsync() method

Applies to Windows only

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.

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.


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

None supported

Namespace

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

Metadata

Windows.winmd

See also

storageItemQueryResult class
storageItemQueryResult.getItemsAsync(startIndex, maxNumberOfItems) method
Windows.Foundation.Collections.IVectorView interface
Windows.Storage.IStorageItem interface
Windows.Storage.IStorageItem.isOfType method
Windows.Storage.storageFile class
Windows.Storage.storageFolder class

 

 

Show:
© 2014 Microsoft