Share via


ShareFileClient.OpenWrite Method

Definition

Opens a stream for writing to the file.

public virtual System.IO.Stream OpenWrite (bool overwrite, long position, Azure.Storage.Files.Shares.Models.ShareFileOpenWriteOptions options = default, System.Threading.CancellationToken cancellationToken = default);
abstract member OpenWrite : bool * int64 * Azure.Storage.Files.Shares.Models.ShareFileOpenWriteOptions * System.Threading.CancellationToken -> System.IO.Stream
override this.OpenWrite : bool * int64 * Azure.Storage.Files.Shares.Models.ShareFileOpenWriteOptions * System.Threading.CancellationToken -> System.IO.Stream
Public Overridable Function OpenWrite (overwrite As Boolean, position As Long, Optional options As ShareFileOpenWriteOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Stream

Parameters

overwrite
Boolean

Whether an existing blob should be deleted and recreated.

position
Int64

The offset within the blob to begin writing from.

options
ShareFileOpenWriteOptions

Optional parameters.

cancellationToken
CancellationToken

Optional CancellationToken to propagate notifications that the operation should be cancelled.

Returns

A stream to write to the file.

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to