OPC Studio User's Guide and Reference
WriteAllText(IWritableFileInfo,String) Method



OpcLabs.BaseLib Assembly > OpcLabs.BaseLib.Extensions.FileProviders Namespace > IWritableFileInfoExtension Class > WriteAllText Method : WriteAllText(IWritableFileInfo,String) Method
The writable file info object that will perform the operation.

The value of this parameter cannot be null (Nothing in Visual Basic).

Text to be written to file.

The value of this parameter cannot be null (Nothing in Visual Basic).

Writes text to a file in an abstract writable file provider. Does not append.
Syntax
'Declaration
 
<ExtensionAttribute()>
Public Overloads Shared Sub WriteAllText( _
   ByVal writableFileInfo As IWritableFileInfo, _
   ByVal text As String _
) 
'Usage
 
Dim writableFileInfo As IWritableFileInfo
Dim text As String
 
IWritableFileInfoExtension.WriteAllText(writableFileInfo, text)
[Extension()]
public static void WriteAllText( 
   IWritableFileInfo writableFileInfo,
   string text
)
[Extension()]
public:
static void WriteAllText( 
   IWritableFileInfo^ writableFileInfo,
   String^ text
) 

Parameters

writableFileInfo
The writable file info object that will perform the operation.

The value of this parameter cannot be null (Nothing in Visual Basic).

text
Text to be written to file.

The value of this parameter cannot be null (Nothing in Visual Basic).

Exceptions
ExceptionDescription

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.

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.

An invoked method is not supported at all, or is not supported with the parameters used to create the object.

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.

This is an extension method (info: C#, VB.NET). In languages that have support for extensions methods (such as C# and VB.NET), you can use the extension method as if it were a regular method on the object that is its first parameter. In other languages (such as with Python.NET), you will call the extension as a static method, and pass it the object on which it acts as its first parameter.

Requirements

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

See Also