Share via

NodeFile.CopyToStream Method

  • Reference

Definition

Namespace:
Microsoft.Azure.Batch
Assembly:
Microsoft.Azure.Batch.dll
Package:
Microsoft.Azure.Batch v16.3.1
Source:
NodeFile.cs

Blocking call to copy the contents of the file into the given Stream.

public virtual void CopyToStream (System.IO.Stream stream, Microsoft.Azure.Batch.GetFileRequestByteRange byteRange = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);
abstract member CopyToStream : System.IO.Stream * Microsoft.Azure.Batch.GetFileRequestByteRange * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> unit
override this.CopyToStream : System.IO.Stream * Microsoft.Azure.Batch.GetFileRequestByteRange * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> unit
Public Overridable Sub CopyToStream (stream As Stream, Optional byteRange As GetFileRequestByteRange = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing)

Parameters

stream
Stream

The stream into which the contents of the file are copied.

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.

Applies to