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_WRITEANN

HDF_AN_WRITEANN

HDF_AN_WRITEANN

This function writes the annotation text provided in the parameter annotation to the HDF AN annotation specified by the parameter Annotation_id.

Syntax


Result = HDF_AN_WRITEANN( Annotation_id, annotation [, LENGTH=characters] )

Return Value


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

Arguments


Annotation_id

Annotation identifier returned by HDF_AN_CREATE, HDF_AN_CREATEF, or HDF_AN_SELECT.

Annotation

Text or IDL variable to be written as the annotation.

Keywords


LENGTH

Length of the annotation text to be written. If not specified, the entire annotation will be written. If the keyword LENGTH is set, then only LENGTH characters of the annotation will be written. If the annotation has already been written, HDF_AN_WRITEANN will overwrite the current text.

Version History


5.2

Introduced



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