ComputeNode.CopyNodeFileContentToString(String, Encoding, GetFileRequestByteRange, IEnumerable<BatchClientBehavior>) Method

Definition

Reads the contents of a file from the specified node into a string.

public string CopyNodeFileContentToString (string filePath, System.Text.Encoding encoding = default, Microsoft.Azure.Batch.GetFileRequestByteRange byteRange = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);
member this.CopyNodeFileContentToString : string * System.Text.Encoding * Microsoft.Azure.Batch.GetFileRequestByteRange * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> string
Public Function CopyNodeFileContentToString (filePath As String, Optional encoding As Encoding = null, Optional byteRange As GetFileRequestByteRange = null, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = null) As 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.

Returns

String

A bound NodeFile object.

Applies to