GenerateMetadata Method

Summary

Creates and stores JSON and/or XML metadata for All metadata, Existing metadata only, or Missing metadata only.

Syntax

C++

public void GenerateMetadata( 
   MetadataOptions options, 
   MetadataScope scope 
)

Public Sub GenerateMetadata( 
   ByVal options As MetadataOptions, 
   ByVal scope As MetadataScope 
)

public:  
   void GenerateMetadata( 
      MetadataOptions^ options, 
      MetadataScope^ scope 
   )

options

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

scope

An enumeration that specifies if the count is for existing, missing, or all metadata records.

Remarks

This method iterates through all instances stored in the Instance database table and takes the following actions:

Loads the instance into a DicomDataSet
Converts the DICOM elements from the DicomDataSet to XML and/or JSON metadata
Stores the metadata in the corresponding metadata database table (MetadataXml or MetadataJson)

The scope parameter determines if metadata is generated for a DICOM instance, as follows:

If scope is MetadataScope.All, then XML and/or JSON metadata is generated for all instances in the Instance table.
If scope is MetadataScope.Existing, then XML and/or JSON metadata is generated only for existing metadata instances in the corresponding metadata table.
If scope is MetadataScope.Missing, then XML and/or JSON metadata is generated only for instances in the Instance table that do not have corresponding XML and/or JSON metadata.