WriteXml Method (String, XmlWriteMode)

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)

Public Sub WriteXml (
	fileName As String,
	mode As 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.

Exception Condition
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.

System_CAPS_noteNote

An InvalidOperationException will be thrown if a column type in the DataRow being read from or written to implements IDynamicMetaObjectProvider and does not implement IXmlSerializable.

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

FileIOPermission

for reading and writing files. Associated enumeration: FileIOPermissionAccess

.NET Framework
Available since 1.1
Return to top
Show:
© 2016 Microsoft