CloudFile.ListRanges Method

Definition

Gets a collection of valid ranges and their starting and ending bytes.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Collections.Generic.IEnumerable<Microsoft.Azure.Storage.File.FileRange> ListRanges (long? offset = default, long? length = default, Microsoft.Azure.Storage.AccessCondition accessCondition = default, Microsoft.Azure.Storage.File.FileRequestOptions options = default, Microsoft.Azure.Storage.OperationContext operationContext = default);
[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member ListRanges : Nullable<int64> * Nullable<int64> * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext -> seq<Microsoft.Azure.Storage.File.FileRange>
override this.ListRanges : Nullable<int64> * Nullable<int64> * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext -> seq<Microsoft.Azure.Storage.File.FileRange>
Public Overridable Function ListRanges (Optional offset As Nullable(Of Long) = Nothing, Optional length As Nullable(Of Long) = Nothing, Optional accessCondition As AccessCondition = Nothing, Optional options As FileRequestOptions = Nothing, Optional operationContext As OperationContext = Nothing) As IEnumerable(Of FileRange)

Parameters

offset
Nullable<Int64>

The starting offset of the data range over which to list file ranges, in bytes.

length
Nullable<Int64>

The length of the data range over which to list file ranges, in bytes.

accessCondition
AccessCondition

An AccessCondition object that represents the access conditions for the file. If null, no condition is used.

options
FileRequestOptions

A FileRequestOptions object that specifies additional options for the request.

operationContext
OperationContext

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

Returns

An enumerable collection of ranges.

Attributes

Applies to