DeleteKey Method

Summary

Deletes the specified key element from the Dicom Dir Data Set.

Syntax

C++

Java

public void DeleteKey( 
   DicomElement element 
)

Public Sub DeleteKey( _ 
   ByVal element As DicomElement _ 
)

public void deleteKey(DicomElement element)

public: 
void DeleteKey(  
   DicomElement^ element 
)

Parameters

element
The key element to delete.

Remarks

When a key element is deleted using this method, all offspring of the key element (both key element children and non-key element children) and all their respective children are also deleted. Below are illustrations of this. For the sake of these illustrations, the order of siblings is top to bottom.

Please note that the numbering of the items of interest is arbitrary, and does not imply order.

In this illustration, item 2 will be deleted. If any of the children of item 2 had children, these would be deleted also.

In this illustration, item 3 will be deleted. Again, if any of the children of item 2 had children, these would be deleted also.

Please note that key elements should not be deleted using DeleteElement. Deleting a key element using DeleteElement will not delete any child key elements, but will delete information that references the child key elements.

For more information about key elements, refer to Working with Basic Directory Key Elements.

Example

For an example, refer to Reset.

Requirements

Target Platforms