CloudTask.CopyNodeFileContentToStringAsync Method

Definition

Reads the contents of a file in the task's directory on its compute node into a string.

public System.Threading.Tasks.Task<string> CopyNodeFileContentToStringAsync (string filePath, System.Text.Encoding encoding = default, Microsoft.Azure.Batch.GetFileRequestByteRange byteRange = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);
member this.CopyNodeFileContentToStringAsync : string * System.Text.Encoding * Microsoft.Azure.Batch.GetFileRequestByteRange * seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>
Public Function CopyNodeFileContentToStringAsync (filePath As String, Optional encoding As Encoding = Nothing, Optional byteRange As GetFileRequestByteRange = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of String)

Parameters

filePath
String

The path of the file to retrieve.

encoding
Encoding

The encoding to use. If no value or null is specified, UTF8 is used.

byteRange
GetFileRequestByteRange

A byte range defining what section of the file to copy. If omitted, the entire file is downloaded.

additionalBehaviors
IEnumerable<BatchClientBehavior>

A collection of BatchClientBehavior instances that are applied after the CustomBehaviors on the current object.

cancellationToken
CancellationToken

A CancellationToken for controlling the lifetime of the asynchronous operation.

Returns

A Task object that represents the asynchronous operation.

Applies to