DataLakeFileClient.ReadTo Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| ReadTo(Stream, DataLakeFileReadToOptions, CancellationToken) |
The ReadTo(Stream, DataLakeFileReadToOptions, CancellationToken) operation downloads an entire file using parallel requests, and writes the content to the provided stream. |
| ReadTo(String, DataLakeFileReadToOptions, CancellationToken) |
The ReadTo(String, DataLakeFileReadToOptions, CancellationToken) operation downloads an entire file using parallel requests, and writes the content to the provided file path. |
ReadTo(Stream, DataLakeFileReadToOptions, CancellationToken)
- Source:
- DataLakeFileClient.cs
- Source:
- DataLakeFileClient.cs
The ReadTo(Stream, DataLakeFileReadToOptions, CancellationToken) operation downloads an entire file using parallel requests, and writes the content to the provided stream.
public virtual Azure.Response ReadTo (System.IO.Stream destination, Azure.Storage.Files.DataLake.Models.DataLakeFileReadToOptions options = default, System.Threading.CancellationToken cancellationToken = default);abstract member ReadTo : System.IO.Stream * Azure.Storage.Files.DataLake.Models.DataLakeFileReadToOptions * System.Threading.CancellationToken -> Azure.Response
override this.ReadTo : System.IO.Stream * Azure.Storage.Files.DataLake.Models.DataLakeFileReadToOptions * System.Threading.CancellationToken -> Azure.ResponsePublic Overridable Function ReadTo (destination As Stream, Optional options As DataLakeFileReadToOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ResponseParameters
- destination
- Stream
Destination stream for writing read contents.
- options
- DataLakeFileReadToOptions
Options for reading this blob.
- cancellationToken
- CancellationToken
Optional CancellationToken to propagate notifications that the operation should be cancelled.
Returns
A Response describing the operation.
Remarks
A RequestFailedException will be thrown if a failure occurs.
Applies to
ReadTo(String, DataLakeFileReadToOptions, CancellationToken)
- Source:
- DataLakeFileClient.cs
- Source:
- DataLakeFileClient.cs
The ReadTo(String, DataLakeFileReadToOptions, CancellationToken) operation downloads an entire file using parallel requests, and writes the content to the provided file path.
public virtual Azure.Response ReadTo (string path, Azure.Storage.Files.DataLake.Models.DataLakeFileReadToOptions options = default, System.Threading.CancellationToken cancellationToken = default);abstract member ReadTo : string * Azure.Storage.Files.DataLake.Models.DataLakeFileReadToOptions * System.Threading.CancellationToken -> Azure.Response
override this.ReadTo : string * Azure.Storage.Files.DataLake.Models.DataLakeFileReadToOptions * System.Threading.CancellationToken -> Azure.ResponsePublic Overridable Function ReadTo (path As String, Optional options As DataLakeFileReadToOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ResponseParameters
- path
- String
File path to write read contents to.
- options
- DataLakeFileReadToOptions
Options for reading this blob.
- cancellationToken
- CancellationToken
Optional CancellationToken to propagate notifications that the operation should be cancelled.
Returns
A Response describing the operation.
Remarks
A RequestFailedException will be thrown if a failure occurs.
Applies to
Azure SDK for .NET