This documentation is archived and is not being maintained.

BinaryWriter.Write Method (String)

Writes a length-prefixed string to this stream in the current encoding of the BinaryWriter, and advances the current position of the stream in accordance with the encoding used and the specific characters being written to the stream.

Namespace: System.IO
Assembly: mscorlib (in mscorlib.dll)

'Declaration
Public Overridable Sub Write ( _
	value As String _
)
'Usage
Dim instance As BinaryWriter
Dim value As String

instance.Write(value)
public void Write (
	String value
)
public function Write (
	value : String
)
Not applicable.

Parameters

value

The value to write.

Exception typeCondition

IOException

An I/O error occurs.

ArgumentNullException

value is a null reference (Nothing in Visual Basic).

ObjectDisposedException

The stream is closed.

A length-prefixed string represents the string length by prefixing to the string a single byte or word that contains the length of that string. This method first writes the length of the string as a four-byte unsigned integer, and then writes that many characters to the stream. This method writes a length-prefixed string to this stream using the BinaryWriter instance's current Encoding.

For a list of common I/O tasks, see Common I/O Tasks.

This code example is part of a larger example provided for the BinaryWriter class.

Dim binWriter As New BinaryWriter( _
    File.Open(fileName, FileMode.Create))
Try
    binWriter.Write(aspRatio)
    binWriter.Write(lkupDir)
    binWriter.Write(saveTime)
    binWriter.Write(statusBar)
Finally
    binWriter.Close()
End Try

BinaryWriter binWriter =
    new BinaryWriter(File.Open(fileName, FileMode.Create));
try {
    binWriter.Write(aspectRatio);
    binWriter.Write(lookupDir);
    binWriter.Write(autoSaveTime);
    binWriter.Write(showStatusBar);
}
finally {
    if ( binWriter != null ) {
        binWriter= null;
    }
}

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

XNA Framework

Supported in: 1.0
Show: