HDFPUTFILEANN Function

Inserts HDF file labels and file descriptions (annotations) into a file.


SUCCEED (0)	Indicates success.
FAIL (-1)	Indicates failure.

Keywords

Description

A byte array that contains the description for the specified file. This byte array may require further processing later for display of the description.

Help If present and nonzero, lists the usage for this routine.

Label A string variable that contains the label for the specified file.

Usage If present and nonzero, lists the usage for this routine. (Same as the Help keyword.)

Discussion

Multiple calls to HDFPUTFILEANN will cause additional labels/descriptions to be added in the file. There is no way known to overwrite an existing file label/description, other than to start writing a new file.

Example 1

label = 'Put File Label (ID) Test'
status = HDFPUTFILEANN (testfile, Label=label)
IF (status EQ FAIL) THEN  $
    MESSAGE, 'Failed HDFPUTFILEANN with Label.'

Example 2

desc = BYTE ('Put File Description Test')
status = HDFPUTFILEANN (testfile, $
    Description=desc)
IF (status EQ FAIL) THEN  $
    MESSAGE, 'Failed HDFPUTFILEANN with'+  $
    '  Description.'

HDFPUTFILEANN Function

Usage

Input Parameters

Return Value

Keywords

Discussion

Example 1

Example 2

See Also