This documentation is archived and is not being maintained.

DataSet.WriteXml Method (String, XmlWriteMode)

Writes the current data, and optionally the schema, for the DataSet to the specified file using the specified XmlWriteMode. To write the schema, set the value for the mode parameter to WriteSchema.

Namespace: System.Data
Assembly: System.Data (in system.data.dll)

'Declaration
Public Sub WriteXml ( _
	fileName As String, _
	mode As XmlWriteMode _
)
'Usage
Dim instance As DataSet
Dim fileName As String
Dim mode As XmlWriteMode

instance.WriteXml(fileName, mode)
public void WriteXml (
	String fileName, 
	XmlWriteMode mode
)
public function WriteXml (
	fileName : String, 
	mode : XmlWriteMode
)
Not applicable.

Parameters

fileName

The file name (including the path) to which to write.

mode

One of the XmlWriteMode values.

Exception typeCondition

SecurityException

FileIOPermission is not set to Write.

The WriteXml method provides a way to write either data only, or both data and schema from a DataSet into an XML document, whereas the WriteXmlSchema method writes only the schema. To write both data and schema, set the mode parameter to WriteSchema.

Note that the same is true for the ReadXml and ReadXmlSchema methods, respectively. To read XML data, or both schema and data into the DataSet, use the ReadXml method. To read just the schema, use the ReadXmlSchema method.

The following example uses the WriteXml method to write an XML document.

Private Sub WriteXmlToFile(thisDataSet As DataSet)
    If thisDataSet Is Nothing Then
        Return
    End If

    ' Create a file name to write to.
    Dim filename As String = "XmlDoc.xml"

    ' Write to the file with the WriteXml method.
    thisDataSet.WriteXml(filename)
End Sub

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, 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

XNA Framework

Supported in: 1.0
Show: