WriteAllText(IWritableFileInfo,String,Boolean) Method

Writes text to a file in an abstract writable file provider.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
Public Overloads Shared Sub WriteAllText( _
   ByVal writableFileInfo As IWritableFileInfo, _
   ByVal text As String, _
   ByVal append As Boolean _
)

'Usage
 
Dim writableFileInfo As IWritableFileInfo
Dim text As String
Dim append As Boolean
 
IWritableFileInfoExtension.WriteAllText(writableFileInfo, text, append)

[Extension()]
public static void WriteAllText( 
   IWritableFileInfo writableFileInfo,
   string text,
   bool append
)

[Extension()]
public:
static void WriteAllText( 
   IWritableFileInfo^ writableFileInfo,
   String^ text,
   bool append
)

Parameters

writableFileInfo: The writable file info object that will perform the operation.
text: Text to be written to file.
append: True to append to the file contents; False to overwrite the file contents. Default is False.

Exceptions

Exception	Description
System.ArgumentNullException	A `null` reference (`Nothing` in Visual Basic) is passed to a method that does not accept it as a valid argument. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.
System.IO.IOException	An I/O error has occurred. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.
System.NotSupportedException	An invoked method is not supported at all, or is not supported with the parameters used to create the object.
System.Security.SecurityException	A security error was detected. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.
System.UnauthorizedAccessException	The operating system has denied access because of an I/O error or a specific type of security error. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

Remarks

If the file does not already exist, the method creates it.

This method is similar to FileSystem.WriteAllText Method for normal (operating system) files.

The overloads of this method that do not specify the encoding use UTF-8 encoding to write to the file. To specify a different encoding, use aan appropriate overload of this method.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

Reference

IWritableFileInfoExtension Class
IWritableFileInfoExtension Members
Overload List

Send Documentation Feedback. Resources: Knowledge Base. Technical support: Online Forums, FAQ.