XmlWriter.Create Method (Stream, XmlWriterSettings) (System.Xml)

Create Method (Stream, XmlWriterSet...

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

XmlWriter..::.Create Method (Stream, XmlWriterSettings)

Creates a new XmlWriter instance using the stream and XmlWriterSettings object.

Namespace: System.Xml
Assembly: System.Xml (in System.Xml.dll)

Syntax

Visual Basic (Declaration)

Public Shared Function Create ( _
    output As Stream, _
    settings As XmlWriterSettings _
) As XmlWriter

Visual Basic (Usage)

Dim output As Stream
Dim settings As XmlWriterSettings
Dim returnValue As XmlWriter

returnValue = XmlWriter.Create(output, _
    settings)

public static XmlWriter Create(
    Stream output,
    XmlWriterSettings settings
)

Visual C++

public:
static XmlWriter^ Create(
    Stream^ output, 
    XmlWriterSettings^ settings
)

JScript

public static function Create(
    output : Stream, 
    settings : XmlWriterSettings
) : XmlWriter

Parameters

output: Type: System.IO..::.Stream
The stream to which you want to write. The XmlWriter writes XML 1.0 text syntax and appends it to the specified stream

settings: Type: System.Xml..::.XmlWriterSettings
The XmlWriterSettings object used to configure the new XmlWriter instance. If this is nullNothingnullptra null reference (Nothing in Visual Basic), a XmlWriterSettings with default settings is used.
If the XmlWriter is being used with the Transform method, you should use the OutputSettings property to obtain an XmlWriterSettings object with the correct settings. This ensures that the created XmlWriter object has the correct output settings.

Return Value

Type: System.Xml..::.XmlWriter
An XmlWriter object.

Exceptions

Exception	Condition
ArgumentNullException	The stream value is nullNothingnullptra null reference (Nothing in Visual Basic).

Examples

The following example writes an XML fragment to a memory stream.

Visual Basic

Dim settings As XmlWriterSettings = New XmlWriterSettings()
settings.OmitXmlDeclaration = true
settings.ConformanceLevel = ConformanceLevel.Fragment
settings.CloseOutput = false

' Create the XmlWriter object and write some content.
Dim strm as MemoryStream = new MemoryStream()
Dim writer As XmlWriter = XmlWriter.Create(strm, settings)
writer.WriteElementString("orderID", "1-456-ab")
writer.WriteElementString("orderID", "2-36-00a")
writer.Flush()
writer.Close()

' Do additonal processing on the stream.

XmlWriterSettings settings = new XmlWriterSettings();
settings.OmitXmlDeclaration = true;
settings.ConformanceLevel = ConformanceLevel.Fragment;
settings.CloseOutput = false;

// Create the XmlWriter object and write some content.
MemoryStream strm = new MemoryStream();
XmlWriter writer = XmlWriter.Create(strm, settings);
writer.WriteElementString("orderID", "1-456-ab");
writer.WriteElementString("orderID", "2-36-00a");
writer.Flush();
writer.Close();

// Do additonal processing on the stream.

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0

.NET Compact Framework

Supported in: 3.5, 2.0

XNA Framework

Supported in: 3.0, 2.0, 1.0

Reference

Other Resources

Creating XML Writers