CloudBlobClient.EndListBlobsWithPrefixSegmented Method

Storage Client Library NET API

[This topic is part of the Microsoft Azure Storage Client Library 1.7, which has been deprecated. See Storage Client Library for the latest version.]

Ends an asynchronous operation to return a result segment containing a collection of blob items whose names begin with the specified prefix.

Namespace: Microsoft.WindowsAzure.StorageClient
Assembly: Microsoft.WindowsAzure.StorageClient (in Microsoft.WindowsAzure.StorageClient.dll)

Usage

Visual Basic
Dim instance As CloudBlobClient
Dim asyncResult As IAsyncResult
Dim returnValue As ResultSegment(Of IListBlobItem)

returnValue = instance.EndListBlobsWithPrefixSegmented(asyncResult)

Syntax

Visual Basic
Public Function EndListBlobsWithPrefixSegmented ( _
	asyncResult As IAsyncResult _
) As ResultSegment(Of IListBlobItem)
C#
public ResultSegment<IListBlobItem> EndListBlobsWithPrefixSegmented (
	IAsyncResult asyncResult
)
C++
public:
ResultSegment<IListBlobItem^>^ EndListBlobsWithPrefixSegmented (
	IAsyncResult^ asyncResult
)
J#
JScript

Parameters

asyncResult

Type: System.IAsyncResult

An IAsyncResult that references the pending asynchronous operation.

Return Value

Type: Microsoft.WindowsAzure.StorageClient.ResultSegment

A result segment containing objects that implement IListBlobItem.

Example

The following sample code lists blobs in a container with an asynchronous operation. The blob prefix includes the name of the container and the beginning of the blob name.

C# Copy Code
static void ListBlobsInSegmentsAsynchronously(Uri blobEndpoint, string accountName, string accountKey)
{
    //Create service client for credentialed access to the Blob service.
    CloudBlobClient blobClient = 
        new CloudBlobClient(blobEndpoint, new StorageCredentialsAccountAndKey(accountName, accountKey));

    //Begin the operation to return a page of up to 5000 blobs, passing the service client to the callback.
    blobClient.BeginListBlobsWithPrefixSegmented("lotsofblobs/0", ListBlobsInSegmentsCallback, blobClient);
}

static void ListBlobsInSegmentsCallback(IAsyncResult result)
{
    CloudBlobClient blobClient = (CloudBlobClient)result.AsyncState;

    //End the operation.
    ResultSegment<IListBlobItem> resultSegment = blobClient.EndListBlobsWithPrefixSegmented(result);

    //Enumerate the blob items.
    foreach (var blobItem in resultSegment.Results)
    {
        Console.WriteLine(blobItem.Uri);
    }

    //Check the continuation token to determine whether there are more results.
    if (resultSegment.ContinuationToken != null)
    {
        //Get the next result segment.
        resultSegment = resultSegment.GetNext();

        //Enumerate the blob items.
        foreach (var blobItem in resultSegment.Results)
        {
            Console.WriteLine(blobItem.Uri);
        }
    }
}

Remarks

This method blocks until the listing operation is complete.


Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows Vista, Windows 7, Windows Server 2008, Windows 8.1, Windows Server 2012 R2, Windows 8 and Windows Server 2012

Change History

See Also