This function returns the compression code and compression parameters for a given field.

Examples


To retrieve the compression information about the Opacity field defined in the EOS_GD_DEFCOMP section:

status = EOS_GD_COMPINFO(gridID, "Opacity", compcode, compparm)

Syntax


Result = EOS_GD_COMPINFO(gridID, fieldname, compcode, compparm)

Return Value


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

Arguments


gridID

Grid id (long) returned by EOS_GD_CREATE or EOS_GD_ATTACH.

fieldname

Fieldname (string).

compcode

A named variable that will contain the HDF compression code (long).

compparm

A named variable that will contain the compression parameters (long array).

Keywords


None

Version History


5.2

Introduced

See Also


EOS_GD_DEFCOMP