Developer Guide and Reference

ID 767251
Date 10/31/2024
Public
Document Table of Contents

PXFEGET

POSIX Subroutine: Gets the value stored in an array element component (or field) of a structure.

Module

USE IFPOSIX

CALL PXFE(type)GET (jhandle, compname,index,value,ierror)

CALL PXFE(type)GET (jhandle,compname,index,value,ilen,ierror) ! syntax when (type) is STR

(type)

A placeholder for one of the following values:

Value

Data Type

Routine Name

INT

INTEGER(4)

PXFEINTGET

REAL

REAL(4)

PXFEREALGET

LGCL

LOGICAL(4)

PXFELGCLGET

STR

CHARACTER*(*)

PXFESTRGET

CHAR

CHARACTER(1)

PXFECHARGET

DBL

REAL(8)

PXFEDBLGET

INT8

INTEGER(8)

PXFEINT8GET

jhandle

(Input) INTEGER(4). A handle of a structure.

compname

(Input) Character. The name of the component (or field) of the structure to retrieve data from.

index

(Input) INTEGER(4). The index of the array element to get data for.

value

(Output) A variable, whose data type depends on the value of (type). See the table above for the data types for each value; for example, if the value for (type) is INT, the data type is INTEGER(4). Stores the value of the component (or field).

ilen

(Output) INTEGER(4). This argument can only be used when (type) is STR (PXFESTRGET). Stores the length of the returned string.

ierror

(Output) INTEGER(4). The error status.

If successful, ierror is set to zero; otherwise, an error code.

The PXFE(type)GET subroutines are similar to the PXF(type)GET subroutines, but they should be used when the component (or field) of the structure is an array.

When the PXFE(type)GET subroutines are used, the array element with index index is accessed (read from the component or field).