pxfintget

Date:: 10-20-2011

NAME

PXFINTGET - Allows values stored in individual components of a structure to be extracted and used

SYNOPSIS

INTEGER jhandle, value, ierror
CHARACTER*(n) compnam
CALL PXFINTGET(jhandle, compnam, value, ierror)

IMPLEMENTATION

Cray Linux Environment (CLE)

DESCRIPTION

The PXFINTGET() subroutine allows values stored in individual components of a structure to be extracted and used.

All arguments must be of default kind unless documented otherwise. Default kind is KIND=4 for integer, real, complex, and logical arguments.

The following are arguments to PXFINTGET:

jhandle: An input integer that references a structure. jhandle should have been created with PXFSTRUCTCREATE.
compnam: An input character variable. compnam is the name of a component of the structure. compnam is case-sensitive.
value: An output integer variable. Upon successful completion, value is set to the value stored in the component of jhandle referenced by compnam.
ierror: An output integer variable. It contains the exit status.

EXIT STATUS

Upon successful completion of PXFINTGET, the argument ierror is set to 0. If any of the following conditions occur, ierror is set to the corresponding value:

ENONAME: Component name is not defined for this structure.
EBADHANDLE: If jhandle is an invalid handle or has an incorrect handle type.