CloudBlockBlob.DownloadBlockListAsync Method (BlockListingFilter, AccessCondition, BlobRequestOptions, OperationContext, CancellationToken) (Microsoft.WindowsAzure.Storage.Blob)
From Microsoft Windows Azure Storage Blob
Initiates an asynchronous operation to return an enumerable collection of the blob's blocks, using the specified block list filter.
Namespace:
Microsoft.WindowsAzure.Storage.Blob
Assembly:
Microsoft.WindowsAzure.Storage (in Microsoft.WindowsAzure.Storage.dll)
Syntax
[DoesServiceRequestAttribute]
public virtual Task<IEnumerable<ListBlockItem>> DownloadBlockListAsync(
BlockListingFilter blockListingFilter,
AccessCondition accessCondition,
BlobRequestOptions options,
OperationContext operationContext,
CancellationToken cancellationToken
)
C++
public:
[DoesServiceRequestAttribute]
virtual Task<IEnumerable<ListBlockItem^>^>^ DownloadBlockListAsync(
BlockListingFilter blockListingFilter,
AccessCondition^ accessCondition,
BlobRequestOptions^ options,
OperationContext^ operationContext,
CancellationToken cancellationToken
)
[<DoesServiceRequestAttribute>]
abstract DownloadBlockListAsync :
blockListingFilter:BlockListingFilter *
accessCondition:AccessCondition *
options:BlobRequestOptions *
operationContext:OperationContext *
cancellationToken:CancellationToken -> Task<IEnumerable<ListBlockItem>>
[<DoesServiceRequestAttribute>]
override DownloadBlockListAsync :
blockListingFilter:BlockListingFilter *
accessCondition:AccessCondition *
options:BlobRequestOptions *
operationContext:OperationContext *
cancellationToken:CancellationToken -> Task<IEnumerable<ListBlockItem>>
<DoesServiceRequestAttribute>
Public Overridable Function DownloadBlockListAsync (
blockListingFilter As BlockListingFilter,
accessCondition As AccessCondition,
options As BlobRequestOptions,
operationContext As OperationContext,
cancellationToken As CancellationToken
) As Task(Of IEnumerable(Of ListBlockItem))
Parameters
- blockListingFilter
-
Type:
Microsoft.WindowsAzure.Storage.Blob.BlockListingFilterMicrosoft.WindowsAzure.Storage.Blob::BlockListingFilterMicrosoft.WindowsAzure.Storage.Blob.BlockListingFilterMicrosoft.WindowsAzure.Storage.Blob.BlockListingFilter
A BlockListingFilter enumeration value that indicates whether to return committed blocks, uncommitted blocks, or both.
- accessCondition
-
Type:
Microsoft.WindowsAzure.Storage.AccessConditionMicrosoft.WindowsAzure.Storage::AccessCondition^Microsoft.WindowsAzure.Storage.AccessConditionMicrosoft.WindowsAzure.Storage.AccessCondition
An AccessCondition object that represents the condition that must be met in order for the request to proceed. If null, no condition is used.
- 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<IEnumerable<ListBlockItem>>System.Threading.Tasks::Task<IEnumerable<ListBlockItem^>^>^System.Threading.Tasks.Task<IEnumerable<ListBlockItem>>System.Threading.Tasks.Task(Of IEnumerable(Of ListBlockItem))A Task<TResult><TResult><'TResult>(Of TResult) object that is an enumerable collection of type ListBlockItem that represents the asynchronous operation.
See Also
DownloadBlockListAsync Overload
CloudBlockBlob Class
Microsoft.WindowsAzure.Storage.Blob Namespace
Return to top
Initiates an asynchronous operation to return an enumerable collection of the blob's blocks, using the specified block list filter.
Syntax
[DoesServiceRequestAttribute] public virtual Task<IEnumerable<ListBlockItem>> DownloadBlockListAsync( BlockListingFilter blockListingFilter, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken )
public: [DoesServiceRequestAttribute] virtual Task<IEnumerable<ListBlockItem^>^>^ DownloadBlockListAsync( BlockListingFilter blockListingFilter, AccessCondition^ accessCondition, BlobRequestOptions^ options, OperationContext^ operationContext, CancellationToken cancellationToken )
[<DoesServiceRequestAttribute>] abstract DownloadBlockListAsync : blockListingFilter:BlockListingFilter * accessCondition:AccessCondition * options:BlobRequestOptions * operationContext:OperationContext * cancellationToken:CancellationToken -> Task<IEnumerable<ListBlockItem>> [<DoesServiceRequestAttribute>] override DownloadBlockListAsync : blockListingFilter:BlockListingFilter * accessCondition:AccessCondition * options:BlobRequestOptions * operationContext:OperationContext * cancellationToken:CancellationToken -> Task<IEnumerable<ListBlockItem>>
<DoesServiceRequestAttribute> Public Overridable Function DownloadBlockListAsync ( blockListingFilter As BlockListingFilter, accessCondition As AccessCondition, options As BlobRequestOptions, operationContext As OperationContext, cancellationToken As CancellationToken ) As Task(Of IEnumerable(Of ListBlockItem))
Parameters
- blockListingFilter
-
Type:
Microsoft.WindowsAzure.Storage.Blob.BlockListingFilterMicrosoft.WindowsAzure.Storage.Blob::BlockListingFilterMicrosoft.WindowsAzure.Storage.Blob.BlockListingFilterMicrosoft.WindowsAzure.Storage.Blob.BlockListingFilter
A BlockListingFilter enumeration value that indicates whether to return committed blocks, uncommitted blocks, or both.
- accessCondition
-
Type:
Microsoft.WindowsAzure.Storage.AccessConditionMicrosoft.WindowsAzure.Storage::AccessCondition^Microsoft.WindowsAzure.Storage.AccessConditionMicrosoft.WindowsAzure.Storage.AccessCondition
An AccessCondition object that represents the condition that must be met in order for the request to proceed. If null, no condition is used.
- 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<IEnumerable<ListBlockItem>>System.Threading.Tasks::Task<IEnumerable<ListBlockItem^>^>^System.Threading.Tasks.Task<IEnumerable<ListBlockItem>>System.Threading.Tasks.Task(Of IEnumerable(Of ListBlockItem))A Task<TResult><TResult><'TResult>(Of TResult) object that is an enumerable collection of type ListBlockItem that represents the asynchronous operation.
See Also
DownloadBlockListAsync Overload
CloudBlockBlob Class
Microsoft.WindowsAzure.Storage.Blob Namespace