APDEF

GDDM V3R2 Base Application Programming Reference

APDEF

GDDM V3R2 Base Application Programming Reference
SC33-0868-02

Function

To define a field list.

APDEF (field-list-id, depth-1, width-1, field-list, length, data-buffer, depth-2, width-2, bundle-list, mode)

APL code 280 GDDM RCP code X'0C380000' (204996608)

Parameters

field-list-id (specified by user) (fullword integer)
The identifier of the new field list. It must be greater than 0, and unique for the current page.

depth-1 (specified by user) (fullword integer)
The number of rows in the new field list array (stored in row major order). It must be greater than or equal to 1.

width-1 (specified by user) (fullword integer)
The number of columns in the new field list array. It must be greater than or equal to 6.

field-list (specified by user) (an array of halfword integers)
The new field list.

length (specified by user) (fullword integer)
The length of the data buffer. It must be greater than or equal to 0.

data-buffer (specified by user) (character)
The data buffer to be associated with the field list.

depth-2 (specified by user) (fullword integer)
The number of rows in the new bundle list array (stored in row major order). It must be greater than or equal to 0.

width-2 (specified by user) (fullword integer)
The number of columns in the new bundle list array. It must be greater than or equal to 4.

bundle-list (specified by user) (an array of halfword integers)
The bundle list to be associated with the field list.

mode (specified by user) (fullword integer)
The mode of operation. This consists of a set of indicators, which have these values:

1 Validate

There is to be validation of the parameters, field list, data buffer, and bundle list.

2 Locate

The field list, data buffer, and bundle list are not copied by GDDM. The storage they occupy must not be released until the field list has been deleted, and it must not be altered except according to the rules described in "GDDM high-performance alphanumerics" in topic 17.0. If this indicator is not set, move mode is implied.

Note: Locate mode must not be used with interpreted programming languages such as REXX.

4 Cursor

The cursor row and cursor column fields in the field list header are to contain the alphanumeric cursor position. Only one field list per page may be used for this purpose at any one time.

If more than one indicator is required, the mode should be set to the sum of the numbers corresponding to the indicators required.

Description

Defines a new field list to GDDM. The field list describes a set of alphanumeric fields on the current page. The new fields must not overlap each other, or any existing fields in other field lists on the same page.

Field lists may not be defined on mapped pages or pages containing procedural alphanumerics. Similarly, procedural or mapped alphanumeric fields may not be defined on pages containing field lists.

The format of field list, data buffer, and bundle list are described in "GDDM high-performance alphanumerics" in topic 17.0.

Note: When used under non-XA subsystems of CICS, the total storage occupied by the field list, data buffer, and bundle list must not be greater than 64KB.

Principal errors

ADM0222 E: MODE n IS INVALID
ADM3000 E: CURRENT PAGE IS MAPPED OR HAS PROCEDURAL ALPHANUMERICS
ADM3001 E: FIELD LIST n ALREADY EXISTS
ADM3002 E: FIELD LIST IDENTIFIER n IS INVALID
ADM3003 E: LENGTH (n) IS INVALID
ADM3006 E: CURSOR POSITION ALREADY DEFINED IN ANOTHER FIELD LIST
ADM3009 E: DEPTH (n1) OR WIDTH (n2) IS INVALID
ADM3013 E: FIELD LIST n TOTAL STORAGE EXCEEDS SUBSYSTEM MAXIMUM

Notices | Terms of use | Support | Contact z/OS