CloudBlob.DownloadRangeToStreamAsync Method (Stream, Nullable(Int64), Nullable(Int64), AccessCondition, BlobRequestOptions, OperationContext, CancellationToken) (Microsoft.WindowsAzure.Storage.Blob)
From Microsoft Windows Azure Storage Blob
Initiates an asynchronous operation to download a range of bytes from a blob to a stream.
Namespace:
Microsoft.WindowsAzure.Storage.Blob
Assembly:
Microsoft.WindowsAzure.Storage (in Microsoft.WindowsAzure.Storage.dll)
Syntax
[DoesServiceRequestAttribute]
public virtual Task DownloadRangeToStreamAsync(
Stream target,
Nullable<long> offset,
Nullable<long> length,
AccessCondition accessCondition,
BlobRequestOptions options,
OperationContext operationContext,
CancellationToken cancellationToken
)
C++
public:
[DoesServiceRequestAttribute]
virtual Task^ DownloadRangeToStreamAsync(
Stream^ target,
Nullable<long long> offset,
Nullable<long long> length,
AccessCondition^ accessCondition,
BlobRequestOptions^ options,
OperationContext^ operationContext,
CancellationToken cancellationToken
)
[<DoesServiceRequestAttribute>]
abstract DownloadRangeToStreamAsync :
target:Stream *
offset:Nullable<int64> *
length:Nullable<int64> *
accessCondition:AccessCondition *
options:BlobRequestOptions *
operationContext:OperationContext *
cancellationToken:CancellationToken -> Task
[<DoesServiceRequestAttribute>]
override DownloadRangeToStreamAsync :
target:Stream *
offset:Nullable<int64> *
length:Nullable<int64> *
accessCondition:AccessCondition *
options:BlobRequestOptions *
operationContext:OperationContext *
cancellationToken:CancellationToken -> Task
<DoesServiceRequestAttribute>
Public Overridable Function DownloadRangeToStreamAsync (
target As Stream,
offset As Nullable(Of Long),
length As Nullable(Of Long),
accessCondition As AccessCondition,
options As BlobRequestOptions,
operationContext As OperationContext,
cancellationToken As CancellationToken
) As Task
Parameters
- target
-
Type:
System.IO.StreamSystem.IO::Stream^System.IO.StreamSystem.IO.Stream
A Stream object representing the target stream.
- offset
-
Type:
System.Nullable<Int64>System::Nullable<Int64>System.Nullable<Int64>System.Nullable(Of Int64)
The offset at which to begin downloading the blob, in bytes.
- length
-
Type:
System.Nullable<Int64>System::Nullable<Int64>System.Nullable<Int64>System.Nullable(Of Int64)
The length of the data to download from the blob, in bytes.
- 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.TaskSystem.Threading.Tasks::Task^System.Threading.Tasks.TaskSystem.Threading.Tasks.TaskA Task object that represents the asynchronous operation.
See Also
DownloadRangeToStreamAsync Overload
CloudBlob Class
Microsoft.WindowsAzure.Storage.Blob Namespace
Return to top
Initiates an asynchronous operation to download a range of bytes from a blob to a stream.
Syntax
[DoesServiceRequestAttribute] public virtual Task DownloadRangeToStreamAsync( Stream target, Nullable<long> offset, Nullable<long> length, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken )
public: [DoesServiceRequestAttribute] virtual Task^ DownloadRangeToStreamAsync( Stream^ target, Nullable<long long> offset, Nullable<long long> length, AccessCondition^ accessCondition, BlobRequestOptions^ options, OperationContext^ operationContext, CancellationToken cancellationToken )
[<DoesServiceRequestAttribute>] abstract DownloadRangeToStreamAsync : target:Stream * offset:Nullable<int64> * length:Nullable<int64> * accessCondition:AccessCondition * options:BlobRequestOptions * operationContext:OperationContext * cancellationToken:CancellationToken -> Task [<DoesServiceRequestAttribute>] override DownloadRangeToStreamAsync : target:Stream * offset:Nullable<int64> * length:Nullable<int64> * accessCondition:AccessCondition * options:BlobRequestOptions * operationContext:OperationContext * cancellationToken:CancellationToken -> Task
<DoesServiceRequestAttribute> Public Overridable Function DownloadRangeToStreamAsync ( target As Stream, offset As Nullable(Of Long), length As Nullable(Of Long), accessCondition As AccessCondition, options As BlobRequestOptions, operationContext As OperationContext, cancellationToken As CancellationToken ) As Task
Parameters
- target
-
Type:
System.IO.StreamSystem.IO::Stream^System.IO.StreamSystem.IO.Stream
A Stream object representing the target stream.
- offset
-
Type:
System.Nullable<Int64>System::Nullable<Int64>System.Nullable<Int64>System.Nullable(Of Int64)
The offset at which to begin downloading the blob, in bytes.
- length
-
Type:
System.Nullable<Int64>System::Nullable<Int64>System.Nullable<Int64>System.Nullable(Of Int64)
The length of the data to download from the blob, in bytes.
- 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.TaskSystem.Threading.Tasks::Task^System.Threading.Tasks.TaskSystem.Threading.Tasks.TaskA Task object that represents the asynchronous operation.
See Also
DownloadRangeToStreamAsync Overload
CloudBlob Class
Microsoft.WindowsAzure.Storage.Blob Namespace