CloudBlobClient.ListBlobsSegmentedAsync Method (String, Boolean, BlobListingDetails, Nullable(Int32), BlobContinuationToken, BlobRequestOptions, OperationContext, CancellationToken) (Microsoft.WindowsAzure.Storage.Blob)

Initiates an asynchronous operation to return a result segment containing a collection of blob items in the container.

Namespace:   Microsoft.WindowsAzure.Storage.Blob
Assembly:  Microsoft.WindowsAzure.Storage (in Microsoft.WindowsAzure.Storage.dll)

Syntax

C#

Copy Code

 

[DoesServiceRequestAttribute]
public virtual Task<BlobResultSegment> ListBlobsSegmentedAsync(
	string prefix,
	bool useFlatBlobListing,
	BlobListingDetails blobListingDetails,
	Nullable<int> maxResults,
	BlobContinuationToken currentToken,
	BlobRequestOptions options,
	OperationContext operationContext,
	CancellationToken cancellationToken
)

C++

Copy Code

 

public:
[DoesServiceRequestAttribute]
virtual Task<BlobResultSegment^>^ ListBlobsSegmentedAsync(
	String^ prefix,
	bool useFlatBlobListing,
	BlobListingDetails blobListingDetails,
	Nullable<int> maxResults,
	BlobContinuationToken^ currentToken,
	BlobRequestOptions^ options,
	OperationContext^ operationContext,
	CancellationToken cancellationToken
)

F#

Copy Code

 

[<DoesServiceRequestAttribute>]
abstract ListBlobsSegmentedAsync : 
        prefix:string *
        useFlatBlobListing:bool *
        blobListingDetails:BlobListingDetails *
        maxResults:Nullable<int> *
        currentToken:BlobContinuationToken *
        options:BlobRequestOptions *
        operationContext:OperationContext *
        cancellationToken:CancellationToken -> Task<BlobResultSegment>
[<DoesServiceRequestAttribute>]
override ListBlobsSegmentedAsync : 
        prefix:string *
        useFlatBlobListing:bool *
        blobListingDetails:BlobListingDetails *
        maxResults:Nullable<int> *
        currentToken:BlobContinuationToken *
        options:BlobRequestOptions *
        operationContext:OperationContext *
        cancellationToken:CancellationToken -> Task<BlobResultSegment>

VB

Copy Code

 

<DoesServiceRequestAttribute>
Public Overridable Function ListBlobsSegmentedAsync (
	prefix As String,
	useFlatBlobListing As Boolean,
	blobListingDetails As BlobListingDetails,
	maxResults As Nullable(Of Integer),
	currentToken As BlobContinuationToken,
	options As BlobRequestOptions,
	operationContext As OperationContext,
	cancellationToken As CancellationToken
) As Task(Of BlobResultSegment)

Parameters

prefix

Type: System.StringSystem::String^System.StringSystem.String

A string containing the blob name prefix.

useFlatBlobListing

Type: System.BooleanSystem::BooleanSystem.BooleanSystem.Boolean

A boolean value that specifies whether to list blobs in a flat listing, or whether to list blobs hierarchically, by virtual directory.

blobListingDetails

Type: Microsoft.WindowsAzure.Storage.Blob.BlobListingDetailsMicrosoft.WindowsAzure.Storage.Blob::BlobListingDetailsMicrosoft.WindowsAzure.Storage.Blob.BlobListingDetailsMicrosoft.WindowsAzure.Storage.Blob.BlobListingDetails

A BlobListingDetails enumeration describing which items to include in the listing.

maxResults

Type: System.Nullable<Int32>System::Nullable<Int32>System.Nullable<Int32>System.Nullable(Of Int32)

A non-negative integer value that indicates the maximum number of results to be returned at a time, up to the per-operation limit of 5000. If this value is null, the maximum possible number of results will be returned, up to 5000.

currentToken

Type: Microsoft.WindowsAzure.Storage.Blob.BlobContinuationTokenMicrosoft.WindowsAzure.Storage.Blob::BlobContinuationToken^Microsoft.WindowsAzure.Storage.Blob.BlobContinuationTokenMicrosoft.WindowsAzure.Storage.Blob.BlobContinuationToken

A BlobContinuationToken object returned by a previous listing operation.

options

Type: Microsoft.WindowsAzure.Storage.Blob.BlobRequestOptionsMicrosoft.WindowsAzure.Storage.Blob::BlobRequestOptions^Microsoft.WindowsAzure.Storage.Blob.BlobRequestOptionsMicrosoft.WindowsAzure.Storage.Blob.BlobRequestOptions

A BlobRequestOptions object that specifies additional options for the request.

operationContext

Type: Microsoft.WindowsAzure.Storage.OperationContextMicrosoft.WindowsAzure.Storage::OperationContext^Microsoft.WindowsAzure.Storage.OperationContextMicrosoft.WindowsAzure.Storage.OperationContext

An OperationContext object that represents the context for the current operation.

cancellationToken

Type: System.Threading.CancellationTokenSystem.Threading::CancellationTokenSystem.Threading.CancellationTokenSystem.Threading.CancellationToken

A CancellationToken to observe while waiting for a task to complete.

Return Value

Type: System.Threading.Tasks.Task<BlobResultSegment>System.Threading.Tasks::Task<BlobResultSegment^>^System.Threading.Tasks.Task<BlobResultSegment>System.Threading.Tasks.Task(Of BlobResultSegment)

A Task<TResult><TResult><'TResult>(Of TResult) object of type BlobResultSegment that represents the asynchronous operation.

See Also

ListBlobsSegmentedAsync Overload
CloudBlobClient Class
Microsoft.WindowsAzure.Storage.Blob Namespace

Return to top