DeleteKey method

Builder Syntax	int __fastcall DeleteKey (void);
Delphi Syntax	Function DeleteKey (): Integer;
Overview	Refer to Working with Key Elements.

Remarks

Deletes the key element specified by the CurrentElement property from the DICOM Dir Data Set.

When a key element is deleted using this function, 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.

$image\IODDlAft.gif$

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

$image\IODDlBef.gif$

Please note that key elements should not be deleted using the DeleteElement method. Deleting a key element using DeleteElement method 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 Key Elements.