In This Topic ▼

L_DicomAnnLoad

Summary

Loads the specified annotation file from a DICOM data set.

Syntax

#include "ltdic.h"

L_LTDIC_API L_UINT16 L_DicomAnnLoad(hDS, phAnnContainer, nIndex, pLoadOptions)

Parameters

HDICOMDS hDS

A DICOM handle.

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.

pLOADFILEOPTION pLoadOptions

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

Returns

Value	Meaning
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. 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:

HDICOMDS hDS;   
HANNOBJECT hAnnContainer;   
LOADFILEOPTION LoadOption;   
memset(&LoadOption, 0, sizeof(LOADFILEOPTION));   
LoadOption.PageNumber = 3;   
hDS = L_DicomCreateDS(NULL);   
L_DicomLoadDS(hDS, "d:\\work\\images\\a.dic", 0);    
L_DicomAnnLoad (hDS, &hAnnContainer, 2, &LoadOption);   
L_DicomFreeDS(hDS);

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

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.