pxfstrget

Date:: 10-20-2011

NAME

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

SYNOPSIS

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

IMPLEMENTATION

Cray Linux Environment (CLE)

Standards

IEEE Std 1003.9-1992 standard interface for FORTRAN 77

Description

The PXFSTRGET routine allows character 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. PXFSTRGET accepts the following arguments.

jhandle: An input integer that references a structure. jhandle should have been created with PXFSTRUCTCREATE.
compnam: A case-sensitive input character variable that is the name of a component of the structure.
value: An output character variable. Upon successful completion, value is set to the value stored in the component of jhandle referenced by compnam. If the length of the data being stored is less than the declared length of value, value is padded with blanks.

The structures and components that may be accessed through PXFSTRGET are described on the man page for the related PXF routine. For example, the PXFUNAME man page describes the components for the utsname structure.

ilen

An output integer variable. ilen is set to the actual length of the data assigned to value. If the length of value is insufficient to contain the data being returned, the data is truncated, and ilen contains the original length of the data before truncation. In this case, ierror is set to ETRUNC.

ierror

An output integer variable. Upon successful completion of PXFSTRGET, 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 the specified structure.
ETRUNC: The actual length of the data to be copied to value was longer than the declared length of value.
EBADHANDLE: If jhandle is an invalid handle or has an incorrect handle type.