.NET Framework Class Library
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)
Syntax

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

instance.WriteXml(fileName, mode)
C#
public void WriteXml(
    string fileName,
    XmlWriteMode mode
)
Visual C++
public:
void WriteXml(
    String^ fileName, 
    XmlWriteMode mode
)
JScript
public function WriteXml(
    fileName : String, 
    mode : XmlWriteMode
)

Parameters

fileName
Type: System..::.String
The file name (including the path) to which to write.
mode
Type: System.Data..::.XmlWriteMode
One of the XmlWriteMode values.
Exceptions

ExceptionCondition
SecurityException

FileIOPermission is not set to Write.

Remarks

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.

Examples

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

Visual Basic
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
C#
private void WriteXmlToFile(DataSet thisDataSet) 
{
    if (thisDataSet == null) { return; }

    // Create a file name to write to.
    string filename = "XmlDoc.xml";

    // Write to the file with the WriteXml method.
    thisDataSet.WriteXml(filename);
}
.NET Framework Security

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, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0

XNA Framework

Supported in: 3.0, 2.0, 1.0
See Also

Reference

Other Resources

Tags :


Page view tracker