HDFGETFILEANN Function

Obtains an HDF file annotation, either label or description.

Usage

status = HDFGETFILEANN (filename)

Input Parameters

The name of the HDF file.

Return Value

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.

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

status = HDFGETFILEANN (testfile, $ Description=newdesc)
IF (status EQ FAIL) THEN $

MESSAGE,'Failed HDFGETFILEANN with'+$ 'Description.'

PRINT, STRING (newdesc)

See Also

Also refer to the following routines in the HDF Reference Manual:

DFANGETFDS, DFANGETFDSLEN, DFANGETFID, DFANGETFIDLEN, HCLOSE, HOPEN

For more information on using the HDF interface and the calling sequence for the entire suite of HDF base functions, refer to Appendix , The PV-WAVE HDF Interface.

For a complete list of the HDF convenience routines, refer to Chapter 1, Functional Summary of Routines.

doc@boulder.vni.com

Copyright © 1999, Visual Numerics, Inc. All rights reserved.