Purpose
|
|
GINLC
|
(wkid, lcdnr, tnr, ipx, ipy, pet,
xmin, xmax, ymin, ymax, ldr,
datrec) |
| |
|
| APL code |
1370 |
| GKS RCP code |
X'38004500' (939541760) |
| |
|
Function: To initialize locator.
Input function. Initializes a locator input device at a workstation.
(See the section "GDDM-GKS restrictions" below.)
Parameters
wkid (specified by user) (fullword integer)
The workstation identifier.
lcdnr (specified by user) (fullword integer)
The locator device number. GDDM-GKS provides only one locator device at
a workstation. The locator device number is always 1.
tnr (specified by user) (fullword integer)
The initial normalization transformation number.
ipx (specified by user) (short floating point)
ipy (specified by user) (short floating point)
The initial locator position in world coordinates.
pet (specified by user) (fullword integer)
The prompt and echo type. GDDM-GKS provides the standard prompt and echo
types 1, 2, 3, 4, 5, and one implementation-dependent type, -1.
xmin (specified by user) (short floating point)
xmax (specified by user) (short floating point)
ymin (specified by user) (short floating point)
ymax (specified by user) (short floating point)
The echo area in device coordinates. The echo area is not used for any
of the prompt and echo types provided.
ldr (specified by user) (fullword integer)
The dimension of the data record array datrec. If the value specified is
0, a workstation-dependent default data record is used.
datrec (specified by user) (array of 80-byte character tokens)
The data record, containing additional information depending on the
prompt and echo type.
Data records are defined for prompt and echo types 4, 5 and -1. The Pack
data record (GPRECS) function can be used to create the input data
records. (See the section "GDDM-GKS restrictions" below.)
Operating states
WSOP, WSAC, SGOP
Related functions
Request locator (GRQLC), Set locator mode (GSLCM)
Description
(See the section "GDDM-GKS restrictions" below.)
This function initializes the locator device by defining the initial
locator position, initial normalization transformation number, prompt and
echo type, echo area, and locator data record. These are stored in the
workstation state list entry for the locator device.
The initial locator position is where the graphic cursor first appears.
It must lie within the window of the initial normalization transformation
specified by tnr. When you call the function Request locator (GRQLC), the
transformation tnr is used to transform the initial locator position to
NDC. The transformed point must lie within the workstation window and
outside the viewport of any normalization transformation with higher
priority than tnr; otherwise, the initial locator position is
workstation-dependent.
The prompt and echo types provided by GDDM-GKS are:
- pet=1
- The current position of the locator is designated using the device
standard graphic cursor.
- pet=2
- The current position of the locator is designated using a cross-hair
cursor.
Available for 3179-G, 3270-PC/G and /GX ranges, 5550-family, and 5080
workstations only. Note that, even though this prompt and echo type has
been requested, at 3179-G and the 3270-PC/G and /GX ranges of
workstations, the cursor type used can be preselected or changed by the
operator by using the keyboard functions.
- pet=3
- The current position of the locator is designated using a tracking
cross.
Available for 3270-PC/G and /GX ranges, and 5080 workstations only.
- pet=4
- The current position of the locator is designated using a
rubber-band line. A rubber-band line constantly connects the initial
locator position to the current position as it moves.
Available for 3270-PC/G and /GX ranges, and 5080 workstations only. The
data record is not used but is defined; it allows either the current
polyline attributes, or attributes specified in the data record, to be
used to draw the rubber line.
If the current attributes are to be used, the parameters of the Pack
data record (GPRECS) function are:
il = 1
ia = (attribute control flag=GCURNT)
rl = 0
ra = ()
sl = 0
lstr = ()
str = ()
If attributes are to be specified in the data record, the parameters of
the Pack data record (GPRECS) function are:
il = 7
ia = (attribute control flag=GSPEC),
line type aspect source flag (ASF),
line width scale factor ASF,
polyline color index ASF,
polyline index,
line type,
polyline color index)
rl = 1
ra = (line width scale factor)
sl = 0
lstr = ()
str = ()
- pet=5
- The current position of the locator is designated using a
"rubber-box" rectangle. The diagonal of the rectangle is the line
connecting the initial locator position and the current position.
Available for 3270-PC/G and /GX ranges, and 5080 workstations only. The
data record is not used but is defined; it allows either the current
polyline or fill area attributes, or attributes specified in the data
record, to be used to draw the rectangle.
If the current attributes are to be used, the parameters of the Pack
data record (GPRECS) function are:
il = 2
ia = (polyline/fill area control flag=GPLINE or
GFILLA, attribute control flag=GCURNT)
rl = 0
ra = ()
sl = 0
lstr = ()
str = ()
If polyline attributes are to be specified in the data record, the
parameters of the Pack data record (GPRECS) function are:
il = 8
ia = (polyline/fill area control flag=GPLINE,
attribute control flag=GSPEC,
line type ASF,
line width scale factor ASF,
polyline color index ASF,
polyline index,
line type,
polyline color index)
rl = 1
ra = (line width scale factor)
sl = 0
lstr = ()
str = ()
If fill area attributes are to be specified in the data record, the
parameters of the Pack data record (GPRECS) function are:
il = 9
ia = (polyline/fill area control flag=GFILLA,
attribute control flag=GSPEC,
fill area interior style ASF,
fill area style index ASF,
fill area color index ASF,
fill area index,
fill area interior style,
fill area style index,
fill area color index)
rl = 0
ra = ()
sl = 0
lstr = ()
str = ()
- pet=-1
- The current position of the cursor is designated using a segment
locator. A copy of the segment specified in the data record datrec is
moved as the current locator position changes.
Available for 3270-PC/G and /GX ranges, and 5080 workstations only.
The data record must contain the name of the segment to be attached to
the locator. The segment need not exist when this function is invoked
but must exist at the workstation when you call the Request locator
(GRQLC) function. The parameters of the Pack data record (GPRECS)
function are:
il = 1
ia = (segment name)
rl = 0
ra = ()
sl = 0
lstr = ()
str = ()
GDDM-GKS Restrictions
The data records for prompt and echo types 4 and 5 are not honored by the
workstations supported by GDDM-GKS.
Principal errors
- 7
- GKS not in proper state: GKS shall be in one of the states WSOP,
WSAC, or SGOP
- 20
- Specified workstation identifier is invalid
- 25
- Specified workstation is not open
- 38
- Specified workstation is neither of category INPUT nor of
category OUTIN
- 51
- Rectangle definition is invalid
- 60
- Polyline index is invalid
- 63
- Linetype is equal to zero
- 65
- Linewidth scale factor is less than zero
- 80
- Fill area index is invalid
- 84
- Style (pattern or hatch) index is equal to zero
- 92
- Color index is less than zero
- 120
- Specified segment name is invalid
- 122
- Specified segment does not exist
- 123
- Specified segment does not exist on specified workstation
- 140
- Specified input device is not present on workstation
- 141
- Input device is not in REQUEST mode
- 144
- Specified prompt and echo type is not supported on this
workstation
- 145
- Echo area is outside display space
- 146
- Contents of input data record are invalid
- 152
- Initial value is invalid
- 2000
- Enumeration type out of range
|
GDDM-GKS V1R1 Programming Guide and Reference
Copyright IBM Corporation 1990, 2012