IFileSystemProvider.WriteFileAsync Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.RpcContracts.FileSystem

Assembly:: Microsoft.VisualStudio.RpcContracts.dll

Package:: Microsoft.VisualStudio.RpcContracts v17.12.12

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.

Writes data to a file, replacing its entire contents if the file already exists.

public:
 System::Threading::Tasks::Task ^ WriteFileAsync(Uri ^ uri, System::IO::Pipelines::PipeReader ^ reader, bool overwrite, System::Threading::CancellationToken cancellationToken);

public System.Threading.Tasks.Task WriteFileAsync (Uri uri, System.IO.Pipelines.PipeReader reader, bool overwrite, System.Threading.CancellationToken cancellationToken);

abstract member WriteFileAsync : Uri * System.IO.Pipelines.PipeReader * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Function WriteFileAsync (uri As Uri, reader As PipeReader, overwrite As Boolean, cancellationToken As CancellationToken) As Task

Parameters

uri: Uri

The file to write.

reader: PipeReader

The reader for the pipe containing the data to be written to the file.

overwrite: Boolean

Indicates whether an existing file can be overwritten.

cancellationToken: CancellationToken

The cancellation token.

Returns

Task

A task representing the asynchronous write operation.

Exceptions

ArgumentNullException

uri or reader is null.

DirectoryNotFoundException

The parent of uri doesn't exist.

RemoteInvocationException

uri exists and overwrite is false. ErrorCode will be set to FileAlreadyExists.

UnauthorizedAccessException

The caller does not have the required permission.

Applies to

Partilhar via