Loads the specified annotation file from a DICOM data set. This function is available in the Medical Imaging Toolkits.


#include "ltdic.h"

L_UINT16 LDicomDS::AnnLoad(phAnnContainer, nIndex, pLoadOptions)


pHANNOBJECT phAnnContainer

Address of the variable to be updated with the handle to the container object of the loaded annotations.

L_INT nIndex

Index of the annotation file to load. This is an 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.


Pointer to optional extended load options. Pass NULL to use the default load options.


Value Meaning
>0 An error occurred. Refer to Return Codes.


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.

Before calling this function, you must declare a variable of data type HANNOBJECT. Then, pass the address of the variable in the phAnnContainer parameter. This function will update the variable with the handle of the container object of the loaded annotations.

The 256 annotation files can hold one or more pages. To load the first page of an annotation file, pass NULL for the pLoadOptions argument. To load any page of an annotation file, use the LOADFILEOPTION structure. For example, to load the 3rd page of an annotation file number 2, do the following:

LDicomDS DicomDS;   
HANNOBJECT hAnnContainer;   
DicomDS.LoadDS("d:\work\images\a.dic", 0);   
memset(&LoadOption, 0, sizeof(LOADFILEOPTION));   
LoadOption.PageNumber = 3;   
DicomDS.AnnLoad(&hAnnContainer, 2, &LoadOption); 

To delete a page from an annotation multipage file, or to delete the entire annotation file, call LDicomDS::AnnDelete.

NOTE: Both DICOM and DOCUMENT capabilities must be unlocked in order to work with DICOM annotations. For more information on unlocking these capabilities, refer to LSettings::SetLicenseFile.

Required DLLs and Libraries


Win32, x64

See Also




For an example, refer to LDicomDS::AnnCount.

Help Version 22.0.2022.12.7
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS DICOM C++ Class Library Help

Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.