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_CREATE

HDF_AN_CREATE

HDF_AN_CREATE

This function creates an HDF AN data annotation of type Annotation_type for the object specified by its HDF tag, Object_tag, and its HDF reference number, Object_ref. Use HDF_AN_CREATEF to create a file annotation. Currently, the user must write to a newly-created annotation before creating another annotation of the same type. Creating two consecutive annotations of the same type causes the second call to HDF_AN_CREATE to return FAIL (-1).

Syntax


Result = HDF_AN_CREATE(Annotation_id, Object_tag, Object_ref, Annotation_type)

Return Value


Returns the data annotation identifier (Annotation_id) if successful or FAIL (-1) otherwise.

Arguments


Annotation_id

HDF_AN_ INTERFACE identifier returned by HDF_AN_START.

Object_tag

HDF tag of the object to be annotated.

Object_ref

HDF reference number of the object to be annotated.

Annotation_type

Type of the data annotation.

The returned data annotation identifier can represent either a data label or a data description. Valid values for Annotation_type are:

  • 0 = data label
  • 1 = data description

Keywords


None

Version History


5.2

Introduced



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