StoreMetadata Method

Summary

Stores a JSON and/or XML metadata representation of all DICOM Elements contained in a DicomDataSet.

Syntax

C++

public void StoreMetadata( 
   DicomDataSet dicomDataSet, 
   string sopInstanceUid, 
   MetadataOptions options, 
   bool overwrite 
)

Public Sub StoreMetadata( 
   ByVal dicomDataSet As DicomDataSet, 
   ByVal sopInstanceUid As String, 
   ByVal options As MetadataOptions, 
   ByVal overwrite As Boolean 
)

public:  
   void StoreMetadata( 
      DicomDataSet^ dicomDataSet, 
      String^ sopInstanceUid, 
      MetadataOptions^ options, 
      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.

options

options that determine the type of metadata saved (XML and/or JSON).

overwrite

if true then overwrite any 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 metadata. This method encapsulates the StoreMetadataJson and StoreMetadataXml methods into a single method.

Example

For an example, refer to IStorageDataAccessAgent4.

Requirements

Target Platforms