AnnLoad method (ILEADDicomDS)

VB.NET example

C# example

Visual Basic example

Visual C++ 6.0 example

 

Syntax

short AnnLoad (short iIndex, long lPage);

Overview

Refer to DICOM Annotation Files.

Remarks

(Medical only) Loads the specified annotation file from 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.

This method updates the AnnContainer property, which can be used in the LEAD Raster Annotation COM Object.

This method also updates the AnnPrivateCreatorTag property with the private creator tag of the LEAD annotations.

The 256 annotation files can hold one or more pages. Select the page to load by setting the lPage argument to the desired page number. The page number is one based. Therefore, the first page is page 1; the second page is page 2, etc.

To delete a page from a multi-page annotation file, or to delete the entire annotation file, use the AnnDelete method.

See Also

Elements:

AnnSave method, AnnCount method, AnnDelete method, AnnContainer property, AnnPrivateCreatorTag property, AnnEntries property

Topics:

Data Sets: Annotation Files