AnnSave method (ILEADDicomDS)

Remarks

(Medical only) Saves annotations as private data in a DICOM data set.

LEAD Annotation files can be saved as private data in a DICOM data set (LEAD native format or binary encoded format). There can be up to 256 private data tags for LEAD annotation files. Specify one of the 256 possible files by setting the nIndex parameter to be a value from 0 to 255.

The annotations that are saved are those that are stored in the AnnContainer property. Therefore, you must set the AnnContainer property prior to calling this method. For more information, see the documentation for AnnContainer.

Setting the AnnPrivateCreatorTag property before calling this method affects where the data is stored in the DICOM data set. You can specify a private creator tag, or set it to 0 to have the tag automatically chosen. For more information, see the documentation for AnnPrivateCreatorTag.

Each of the possible 256 annotation files can store multiple pages

To overwrite an existing annotation file, pass SAVE_OVERWRITE for the iModify parameter (iSavePage will be ignored).

To add a page to the end of an annotation file, pass SAVE_APPEND for the iModify argument (iSavePage will be ignored).

To replace a page in an annotation file, pass SAVE_REPLACE and set iSavePage to the page number to be replaced. Note that page numbers are 1-based. Therefore, the first page is page 1, the second page is page 2, etc.

To insert a new page, pass SAVE_INSERT and set iSavePage. The new page will be inserted BEFORE the page specified in iSavePage.

See Also