This documentation is archived and is not being maintained.

DataSet.WriteXml Method (XmlWriter, XmlWriteMode)

.NET Framework 1.1

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

[Visual Basic]
Overloads Public Sub WriteXml( _
   ByVal writer As XmlWriter, _
   ByVal mode As XmlWriteMode _
)
[C#]
public void WriteXml(
 XmlWriter writer,
 XmlWriteMode mode
);
[C++]
public: void WriteXml(
 XmlWriter* writer,
 XmlWriteMode mode
);
[JScript]
public function WriteXml(
   writer : XmlWriter,
 mode : XmlWriteMode
);

Parameters

writer
The XmlWriter with which to write.
mode
One of the XmlWriteMode values.

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 WriteXmlMode 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.

Example

[Visual Basic, C#, C++] The following example creates a System.IO.FileStream object that is used to create a new System.Xml.XmlTextWriter. The XmlTextWriter object is used with 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 = "myXmlDoc.xml"
    ' Create the FileStream to write with.
    Dim myFileStream As New System.IO.FileStream _
       (filename, System.IO.FileMode.Create)
    ' Create an XmlTextWriter with the fileStream.
    Dim myXmlWriter As New System.Xml.XmlTextWriter _
       (myFileStream, System.Text.Encoding.Unicode)
    ' Write to the file with the WriteXml method.
    thisDataSet.WriteXml(myXmlWriter)
    myXmlWriter.Close()
End Sub

[C#] 
private void WriteXmlToFile(DataSet thisDataSet) {
    if (thisDataSet == null) { return; }
    // Create a file name to write to.
    string filename = "myXmlDoc.xml";
    // Create the FileStream to write with.
    System.IO.FileStream myFileStream = new System.IO.FileStream
       (filename, System.IO.FileMode.Create);
    // Create an XmlTextWriter with the fileStream.
    System.Xml.XmlTextWriter myXmlWriter = 
       new System.Xml.XmlTextWriter(myFileStream, System.Text.Encoding.Unicode);
    // Write to the file with the WriteXml method.
    thisDataSet.WriteXml(myXmlWriter);   
    myXmlWriter.Close();
 }

[C++] 
private:
void WriteXmlToFile(DataSet* thisDataSet) {
    if (thisDataSet == 0) { return; }
    // Create a file name to write to.
    String* filename = S"myXmlDoc.xml";
    // Create the FileStream to write with.
    System::IO::FileStream* myFileStream = new System::IO::FileStream
       (filename, System::IO::FileMode::Create);
    // Create an XmlTextWriter with the fileStream.
    System::Xml::XmlTextWriter* myXmlWriter = 
       new System::Xml::XmlTextWriter(myFileStream, System::Text::Encoding::Unicode);
    // Write to the file with the WriteXml method.
    thisDataSet->WriteXml(myXmlWriter);   
    myXmlWriter->Close();
 }

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, .NET Compact Framework

See Also

DataSet Class | DataSet Members | System.Data Namespace | DataSet.WriteXml Overload List | ReadXml | ReadXmlSchema | WriteXml | WriteXmlSchema

Show: