CloudBlobClient.BeginListContainersSegmented Method (String, ContainerListingDetails, Nullable(Int32), BlobContinuationToken, BlobRequestOptions, OperationContext, AsyncCallback, Object) (Microsoft.WindowsAzure.Storage.Blob)

Begins an asynchronous request to return a result segment containing a collection of containers whose names begin with the specified prefix.

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

Syntax

C#

Copy Code

 

[DoesServiceRequestAttribute]
public virtual ICancellableAsyncResult BeginListContainersSegmented(
	string prefix,
	ContainerListingDetails detailsIncluded,
	Nullable<int> maxResults,
	BlobContinuationToken continuationToken,
	BlobRequestOptions options,
	OperationContext operationContext,
	AsyncCallback callback,
	object state
)

C++

Copy Code

 

public:
[DoesServiceRequestAttribute]
virtual ICancellableAsyncResult^ BeginListContainersSegmented(
	String^ prefix,
	ContainerListingDetails detailsIncluded,
	Nullable<int> maxResults,
	BlobContinuationToken^ continuationToken,
	BlobRequestOptions^ options,
	OperationContext^ operationContext,
	AsyncCallback^ callback,
	Object^ state
)

F#

Copy Code

 

[<DoesServiceRequestAttribute>]
abstract BeginListContainersSegmented : 
        prefix:string *
        detailsIncluded:ContainerListingDetails *
        maxResults:Nullable<int> *
        continuationToken:BlobContinuationToken *
        options:BlobRequestOptions *
        operationContext:OperationContext *
        callback:AsyncCallback *
        state:Object -> ICancellableAsyncResult
[<DoesServiceRequestAttribute>]
override BeginListContainersSegmented : 
        prefix:string *
        detailsIncluded:ContainerListingDetails *
        maxResults:Nullable<int> *
        continuationToken:BlobContinuationToken *
        options:BlobRequestOptions *
        operationContext:OperationContext *
        callback:AsyncCallback *
        state:Object -> ICancellableAsyncResult

VB

Copy Code

 

<DoesServiceRequestAttribute>
Public Overridable Function BeginListContainersSegmented (
	prefix As String,
	detailsIncluded As ContainerListingDetails,
	maxResults As Nullable(Of Integer),
	continuationToken As BlobContinuationToken,
	options As BlobRequestOptions,
	operationContext As OperationContext,
	callback As AsyncCallback,
	state As Object
) As ICancellableAsyncResult

Parameters

prefix

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

A string containing the container name prefix.

detailsIncluded

Type: Microsoft.WindowsAzure.Storage.Blob.ContainerListingDetailsMicrosoft.WindowsAzure.Storage.Blob::ContainerListingDetailsMicrosoft.WindowsAzure.Storage.Blob.ContainerListingDetailsMicrosoft.WindowsAzure.Storage.Blob.ContainerListingDetails

A ContainerListingDetails enumeration value that indicates whether to return container metadata with 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 in the result segment, 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.

continuationToken

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.

callback

Type: System.AsyncCallbackSystem::AsyncCallback^System.AsyncCallbackSystem.AsyncCallback

An AsyncCallback delegate that will receive notification when the asynchronous operation completes.

state

Type: System.ObjectSystem::Object^System.ObjectSystem.Object

A user-defined object that will be passed to the callback delegate.

Return Value

Type: Microsoft.WindowsAzure.Storage.ICancellableAsyncResultMicrosoft.WindowsAzure.Storage::ICancellableAsyncResult^Microsoft.WindowsAzure.Storage.ICancellableAsyncResultMicrosoft.WindowsAzure.Storage.ICancellableAsyncResult

An ICancellableAsyncResult that references the asynchronous operation.

See Also

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

Return to top