HDFGETFILEANN Function

Obtains an HDF file annotation, either label or description.

Restriction: See "Supported Platforms Guide" on the PV-WAVE Documentation website to check if this function is available on your operating system.

Usage

status = HDFGETFILEANN (filename)

Input Parameters

filename—The name of the HDF file.

Return Value

status—The status of the function call, where:

SUCCEED (0)—Indicates success.
FAIL (–1)—Indicates failure.

Keywords

Description—A byte array that contains the description for the specified filename/tag/ref object. This byte array may require further processing for display of the description.

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

Isfirst—Specifies whether to select the first or next label or description. Values for Isfirst are:

1—for the first label/descriptor.
0—for the next label/descriptor.

Label—A string variable that contains the label for the specified filename/tag/ref object.

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

Discussion

HDFGETFILEANN is used to get an HDF file annotation, either a file label or a file description. File labels and file descriptions differ from HDF object labels/descriptions in that you can access multiple labels or descriptions using the Isfirst keyword.

Example

hdf_init
@hdf_common
testfile = !Data_dir + '/raster8.hdf'
newdesc = BYTE (' ')
status = HDFGETFILEANN (testfile, Description=newdesc)
IF (status EQ FAIL) THEN $
   MESSAGE,'Failed HDFGETFILEANN with Description.' $
ELSE PRINT, STRING (newdesc)