CloudBlockBlob.DownloadBlockList Method ()
From Storage Client Library NET API
Returns an enumerable collection of the committed blocks comprising the blob.
Namespace: Microsoft.WindowsAzure.StorageClient
Assembly: Microsoft.WindowsAzure.StorageClient (in Microsoft.WindowsAzure.StorageClient.dll)
Usage
| Visual Basic |
|---|
Dim instance As CloudBlockBlob Dim returnValue As IEnumerable(Of ListBlockItem) returnValue = instance.DownloadBlockList |
Syntax
| Visual Basic |
|---|
Public Function DownloadBlockList As IEnumerable(Of ListBlockItem) |
| C# |
|---|
public IEnumerable<ListBlockItem> DownloadBlockList () |
| C++ |
|---|
public: IEnumerable<ListBlockItem^>^ DownloadBlockList () |
| J# |
|---|
| JScript |
|---|
Return Value
Type: System.Collections.Generic.IEnumerable
An enumerable collection of objects implementing ListBlockItem.
Example
The following code example downloads the block list for a blob and enumerates the blocks in the list. The example first downloads the committed blocks, then the uncommitted blocks, then the entire block list.
| C# | Copy Code |
|---|---|
static void DownloadBlockListForBlob(Uri blobEndpoint, string accountName, string accountKey)
{
//Create service client for credentialed access to the Blob service, using development storage.
CloudBlobClient blobClient = new CloudBlobClient(blobEndpoint,
new StorageCredentialsAccountAndKey(accountName, accountKey));
//Get a reference to a block blob.
CloudBlockBlob blockBlob = blobClient.GetBlockBlobReference("mycontainer/mybinaryblob.mp3");
//Download the committed blocks in the block list.
foreach (var blockListItem in blockBlob.DownloadBlockList())
{
Console.WriteLine("Block ID: " + blockListItem.Name);
Console.WriteLine("Block size: " + blockListItem.Size);
Console.WriteLine("Is block committed?: " + blockListItem.Committed);
Console.WriteLine();
}
//Download only uncommitted blocks.
foreach (var blockListItem in blockBlob.DownloadBlockList(BlockListingFilter.Uncommitted))
{
Console.WriteLine("Block ID: " + blockListItem.Name);
Console.WriteLine("Block size: " + blockListItem.Size);
Console.WriteLine("Is block committed?: " + blockListItem.Committed);
Console.WriteLine();
}
//Download all blocks.
foreach (var blockListItem in blockBlob.DownloadBlockList(BlockListingFilter.All))
{
Console.WriteLine("Block ID: " + blockListItem.Name);
Console.WriteLine("Block size: " + blockListItem.Size);
Console.WriteLine("Is block committed?: " + blockListItem.Committed);
Console.WriteLine();
}
} | |
Remarks
The DownloadBlockList method downloads the list of committed blocks that comprise the blob. The committed block list includes the list of blocks that have been successfully committed to a blob.
The list of committed blocks is returned in the same order that they were committed to the blob. No block may appear more than once in the committed block list.