Collapse All Expand All

L_DicomAnnDelete

#include "ltdic.h"

L_LTDIC_API L_UINT16 L_DicomAnnDelete (hDS, nIndex, nPage)

HDICOMDS hDS;	/* a DICOM handle */
L_INT nIndex;	/* index of an annotation file */
L_INT nPage;	/* page to delete */

Deletes a page from an annotation file, deletes the entire annotation file, or deletes all annotation files stored in a DICOM data set.

Parameter	Description
hDS	A DICOM handle.
nIndex	Index into an array of annotation files stored in the DICOM data set. Each DICOM data set can store up to 256 annotation files. This is a zero-based index. Valid values are between 0 and 255. Pass 1 to delete ALL annotation files and the private creator data element.
nPage	Number of the page to delete. The page number is 1-based. Therefore, the first page is page 1, the second page is page 2, etc. Pass 1 to delete the entire file specified by the nIndex parameter.

Returns

DICOM_SUCCESS	The function was successful.
>0	An error occurred. Refer to Return Codes.

Comments

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. L_DicomAnnDelete can delete a page from an annotation file, delete the entire annotation file, or delete all annotation files in a DICOM data set.

To delete the third page of the annotation file at index 1:

HDICOMDS hDS;
hDS = L_DicomCreateDS(NULL);
L_DicomLoadDS(hDS, TEXT("d:\\work\\images\\a.dic"), 0); 
L_DicomAnnDelete(hDS, 1, 3);
L_DicomFreeDS(hDS);

To delete the annotation file at index 1

HDICOMDS hDS;
hDS = L_DicomCreateDS(NULL);
L_DicomLoadDS(hDS, TEXT("d:\\work\\images\\a.dic"), 0);
L_DicomAnnDelete(hDS, 1, -1);
L_DicomFreeDS(hDS);

To delete all annotation files and the private creator data element

HDICOMDS hDS;
hDS = L_DicomCreateDS(NULL);
L_DicomLoadDS(hDS, TEXT("d:\\work\\images\\a.dic"), 0);
L_DicomAnnDelete(hDS, -1, 0);
L_DicomFreeDS(hDS);

Please note that both the DICOM capabilities and the DOCUMENT capabilities must be unlocked in order to work with DICOM annotations. For more information on unlocking these capabilities, refer to L_SetLicenseFile.

Required DLLs and Libraries

LTDIC For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application

Platforms

Win32, x64, Linux.

See Also

Functions:	L_DicomAnnLoad, L_DicomAnnSave, L_DicomAnnCount, L_DicomAnnDelete
Topics:	Working with DICOM Annotations

Example

For an example, refer to L_DicomAnnCount.