In This Topic ▼

SaveXml(DicomDataSet,Stream,DicomDataSetSaveXmlFlags,SaveXmlCallback) Method

Summary

Saves the contents of the Data Set as an XML output stream.

Syntax

C++

public static void SaveXml( 
   this DicomDataSet ds, 
   Stream stream, 
   DicomDataSetSaveXmlFlags xmlFlags, 
   SaveXmlCallback cb 
)

<ExtensionAttribute()> 
Public Overloads Shared Sub SaveXml( _ 
   ByVal ds As DicomDataSet, _ 
   ByVal stream As Stream, _ 
   ByVal xmlFlags As DicomDataSetSaveXmlFlags, _ 
   ByVal cb As SaveXmlCallback _ 
)

[ExtensionAttribute()] 
public: 
static void SaveXml(  
   DicomDataSet^ ds, 
   Stream^ stream, 
   DicomDataSetSaveXmlFlags xmlFlags, 
   SaveXmlCallback^ cb 
)

Parameters

ds
The Data Set being saved

stream
The stream where the output XML file is written

xmlFlags
Flags that affect how binary data and other information is saved in the XML output file

cb
Optional callback that allows you to change the element names, attributes, and values of the XML output file

Remarks

Use this method to export a DicomDataSet as an XML stream. By default, all binary data is written using Base64 encoding, but this behavior can be modified by passing appropriate DicomDataSetSaveXmlFlags

Pass the DicomDataSetSaveXmlFlags.NativeDicomModel flag to save to the 'Native DICOM Model' XML format described in PS3.19.A.1 of the DICOM Specification. One of the following flags can be used, together with the DicomDataSetSaveXmlFlags.NativeDicomModel flag to control how binary data is written. If DicomDataSetSaveXmlFlags.NativeDicomModel, is not also included, all of the following flags are ignored. Callers should only pass one of the three flags. If more than one of the flags is passed, precedence is given in the order that they appear below.

InlineBinary
BulkDataUri
BulkDataUuid

If none of these three flags are passed, the default behavior is BulkDataUuid. The output XML file can be customized by passing the optional SaveXmlCallback delegate. For more information on this, see the documentation and example for SaveXmlCallback.

Example

For an example, refer to LoadXml.

Requirements

Target Platforms