Welcome to the Harris Geospatial product documentation center. Here you will find reference guides, help documents, and product libraries.


Harris Geospatial / Docs Center / IDL Reference / I/O - HDF / HDF_AN_GET_TAGREF

HDF_AN_GET_TAGREF

HDF_AN_GET_TAGREF

This function retrieves the HDF tag and reference number of the annotation identified by its index and by its annotation type.

Syntax


Result = HDF_AN_GET_TAGREF(Annotation_id, index, Annotation_type, Annotation_tag, Annotation_ref)

Return Value


Returns SUCCEED (0) if successful or FAIL (-1) otherwise.

Arguments


Annotation_id

HDF AN interface identifier returned by HDF_AN_START.

Index

Index of the annotation. This parameter is a nonnegative integer and is less than the total number of annotations of type Annotation_type in the file. Use HDF_AN_FILEINFO to obtain the total number of annotations of each type in the file.

Annotation_type

Type of the annotation. The following table lists the valid values of the parameter Annotation_type in the left column, and the corresponding values of the parameter Annotation_tag in the right column.

Annotation Type

HDF Annotation Tag

0 = Data Label (AN_DATA_LABEL)

104 (DFTAG_DIL)

1= Data Description (AN_DATA_DESC)

105 (DFTAG_DIA)

2 = File Label (AN_FILE_LABEL)

100 (DFTAG_FID)

3 = File Description (AN_FILE_DESC)

101 (DFTAG_FD)

Annotation_tag

A named variable that will contain the HDF tag of the annotation.

Annotation_ref

A named variable that will contain the HDF reference number of the annotation.

Keywords


None

Version History


5.2

Introduced



© 2017 Exelis Visual Information Solutions, Inc. |  Legal
My Account    |    Buy    |    Contact Us