ShareFileClient.OpenWriteAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Opens a stream for writing to the file.
public virtual System.Threading.Tasks.Task<System.IO.Stream> OpenWriteAsync (bool overwrite, long position, Azure.Storage.Files.Shares.Models.ShareFileOpenWriteOptions options = default, System.Threading.CancellationToken cancellationToken = default);abstract member OpenWriteAsync : bool * int64 * Azure.Storage.Files.Shares.Models.ShareFileOpenWriteOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>
override this.OpenWriteAsync : bool * int64 * Azure.Storage.Files.Shares.Models.ShareFileOpenWriteOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>Public Overridable Function OpenWriteAsync (overwrite As Boolean, position As Long, Optional options As ShareFileOpenWriteOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of 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
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
Azure SDK for .NET