[Back to Interface] [Prev] [Next]

ANreadann/afreadann

int32 ANreadann(int32 ann_id, char* ann_buf, int32 ann_length)

ann_id IN:

Annotation identifier returned by ANcreate, ANcreatef or ANselect

ann_buf OUT:

Buffer for the annotation

ann_length IN:

Length of the buffer ann_buf

Purpose

Reads an annotation.

Return value

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

Description

ANreadann reads the annotation identified by the parameter ann_id and stores the annotation in the parameter ann_buf.

The parameter ann_length specifies the size of the buffer ann_buf. If the length of the file or data label to be read is greater than or equal to ann_length, the label will be truncated to ann_length - 1 characters. If the length of the file or data description is greater than ann_length, the description will be truncated to ann_length characters. The HDF library adds a NULL character to the retrieved label but not to the retrieved description. The user must add a NULL character to the retrieved description if the C library string functions are to operate on this description.

FORTRAN

integer function afreadann(ann_id, ann_buf, ann_length)

integer ann_id, ann_length

character*(*) ann_buf



[Back to Interface] [Prev] [Next]

hdfhelp@ncsa.uiuc.edu
HDF Reference Manual - 07/29/98, NCSA HDF Development Group.