NodeFile.ReadAsString Method

Definition

Namespace:

Microsoft.Azure.Batch

Assembly:

Microsoft.Azure.Batch.dll

Package:

Microsoft.Azure.Batch v16.3.1

Source:

NodeFile.cs

Blocking call to return the contents of the file as a string.

public string ReadAsString (System.Text.Encoding encoding = default, Microsoft.Azure.Batch.GetFileRequestByteRange byteRange = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);

member this.ReadAsString : System.Text.Encoding * Microsoft.Azure.Batch.GetFileRequestByteRange * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> string

Public Function ReadAsString (Optional encoding As Encoding = Nothing, Optional byteRange As GetFileRequestByteRange = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing) As String

Parameters

encoding

Encoding

The encoding used to interpret the file data. If no value or null is specified, UTF8 is used.

byteRange

GetFileRequestByteRange

The file byte range to retrieve. If null, the entire file is retrieved.

additionalBehaviors

IEnumerable<BatchClientBehavior>

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

Returns

String

A string containing the contents of the file.