StoreMetadataXml Method

Summary

Stores an XML metadata representation of all DICOM Elements contained in a DicomDataSet.

Syntax

C++

public void StoreMetadataXml( 
   DicomDataSet dicomDataSet, 
   string sopInstanceUid, 
   DicomDataSetSaveXmlFlags flags, 
   bool overwrite 
)

Public Sub StoreMetadataXml( 
   ByVal dicomDataSet As DicomDataSet, 
   ByVal sopInstanceUid As String, 
   ByVal flags As DicomDataSetSaveXmlFlags, 
   ByVal overwrite As Boolean 
)

public:  
   void StoreMetadataXml( 
      DicomDataSet^ dicomDataSet, 
      String^ sopInstanceUid, 
      DicomDataSetSaveXmlFlags^ flags, 
      bool overwrite 
   )

Parameters

dicomDataSet

The DicomDataSet that contains all DICOM elements that are saved as metadata.

sopInstanceUid

The SOP Instance UID (0008,0018) of the DicomDataSet. Pass NULL to automatically read the SOPInstanceUID from the DicomDataSet.

flags

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

overwrite

If true then overwrite any corresponding existing metadata that corresponds to the SOP Instance UID; otherwise do not overwrite existing metadata.

Remarks

Use this method to save all the DICOM elements in the DicomDataSet as XML formatted metadata.

Example

For an example, refer to IStorageDataAccessAgent4.

Requirements

Target Platforms