CreateStreamWriter(IWritableFileInfo,FileMode,Encoding) Method

Creates a System.IO.StreamWriter that writes into a text file, specifying the file mode and the encoding to use.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Overloads Shared Function CreateStreamWriter( _
   ByVal writableFileInfo As IWritableFileInfo, _
   ByVal fileMode As FileMode, _
   ByVal encoding As Encoding _
) As StreamWriter

'Usage
 
Dim writableFileInfo As IWritableFileInfo
Dim fileMode As FileMode
Dim encoding As Encoding
Dim value As StreamWriter
 
value = IWritableFileInfoExtension.CreateStreamWriter(writableFileInfo, fileMode, encoding)

[Extension()]
[NotNull()]
public static StreamWriter CreateStreamWriter( 
   IWritableFileInfo writableFileInfo,
   FileMode fileMode,
   Encoding encoding
)

[Extension()]
[NotNull()]
public:
static StreamWriter^ CreateStreamWriter( 
   IWritableFileInfo^ writableFileInfo,
   FileMode fileMode,
   Encoding^ encoding
)

Parameters

writableFileInfo: The writable file info object that will perform the operation.
The value of this parameter cannot be null (Nothing in Visual Basic).
fileMode: A System.IO.FileMode value that specifies whether a file is created if one does not exist, and determines whether the contents of existing files are retained or overwritten.
encoding: The character encoding to use.
The value of this parameter cannot be null (Nothing in Visual Basic).

Return Value

A new System.IO.StreamWriter.

This method never returns null (Nothing in Visual Basic).

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

This method is similar in purpose to System.IO.FileInfo.CreateText, but is generalized for any kind of writable file info, not just files in the physical file system.

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

Reference

IWritableFileInfoExtension Class
IWritableFileInfoExtension Members
Overload List
CreateWriteStream(IWritableFileInfo) Method

Documentation Home, Send Documentation Feedback. Technical Support