CloudPageBlob.GetPageRanges Method (BlobRequestOptions)

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.]

Gets a collection of page ranges and their starting and ending bytes, using a conditional request based on the BlobRequestOptions specified.

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

Usage

Visual Basic
Dim instance As CloudPageBlob
Dim options As BlobRequestOptions
Dim returnValue As IEnumerable(Of PageRange)

returnValue = instance.GetPageRanges(options)

Syntax

Visual Basic
Public Function GetPageRanges ( _
	options As BlobRequestOptions _
) As IEnumerable(Of PageRange)
C#
public IEnumerable<PageRange> GetPageRanges (
	BlobRequestOptions options
)
C++
public:
IEnumerable<PageRange^>^ GetPageRanges (
	BlobRequestOptions^ options
)
J#
JScript

Parameters

options

Type: Microsoft.WindowsAzure.StorageClient.BlobRequestOptions

An object that specifies any additional options for the request.

Return Value

Type: System.Collections.Generic.IEnumerable

An enumerable collection of page ranges.

Example

The following example returns the collection of page ranges for a page blob and writes them to the console window.

C# Copy Code
static void GetPageBlobRanges(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));

    //Get a reference to the page blob.
    CloudPageBlob pageBlob = blobClient.GetPageBlobReference("mycontainer/mypageblob");

    foreach (PageRange pageRange in pageBlob.GetPageRanges())
    {
        Console.WriteLine("Starting offset: " + pageRange.StartOffset);
        Console.WriteLine("Ending offset: " + pageRange.EndOffset);
        Console.WriteLine("Content: " + pageRange.ToString());
        Console.WriteLine();
    }
}

Remarks

The start and end byte offsets for each page range are inclusive.


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