GSPUT

GDDM V3R2 Base Application Programming Reference

GSPUT

GDDM V3R2 Base Application Programming Reference
SC33-0868-02

Function

To restore graphics data.


   GSPUT       (control, length, graphics-data)

   APL code               553
   GDDM RCP code          X'0C0C0900' (202115328)

Parameters

control (specified by user) (fullword integer)
The coordinate type used in the GDF data. Possible values are:

1: 1-byte binary integers
2: 2-byte binary integers
4: 4-byte short floating point.

length (specified by user) (fullword integer)
The length of the GDF string provided. The string of orders is assumed to end when an apparent order code of X'FF' is met, or when the complete string is interpreted, whichever is the sooner.

graphics-data (specified by user) (character)
A data area of the indicated byte length containing graphics data in Graphics Data Format. The detailed rules for formatting the GDF string are given in "GDF order descriptions" in topic 10.0.

Description

Restores the graphics data provided in the graphics-data parameter into the current graphics viewport, using the current graphics window coordinates system. The default graphics field, picture space, viewport, and window are defaulted if they were not already specified.

Any series of graphics primitives (such as lines, arcs, areas, character strings) together with their attributes can be coded as a string of data bytes in graphics data format (GDF). This consists of a series of GDF orders; see "GDF order descriptions" in topic 10.0. Each order defines a graphics primitive or an attribute setting that applies to following primitives.

If graphics data is held by an application program as a series of GDF orders, it can be supplied to GDDM by a single GSPUT call, rather than by many calls to the individual primitives.

The interpretation of a GDF order string is equivalent to the execution of call statements corresponding to the orders in the string. The current position depends on the last order executed, and the current values of the attributes (such as color and line type) depends on the attribute setting orders that have occurred. If the data was generated by previous calls to GSGET, orders exist within that data to set the segment attributes to those that were in effect when the data was obtained. These GDF orders may change any attribute settings that are currently in effect; see GSSATI.

Principal errors

ADM0153 E

CONTROL VALUE n IS INVALID

ADM0173 E

STRING LENGTH n IS INVALID

ADM0174 E

INVALID OR UNSUPPORTED GDF ORDER X'xx'

ADM0175 E

INVALID OR UNSUPPORTED LENGTH IN GDF ORDER X'xx' OFFSET X'xxxxxxxx'

ADM0182 W

INVALID CHARACTER CODE X'xx' IN STRING

Note: Errors can also arise during interpretation of the individual orders, as if the corresponding calls had been made directly.

If such an error occurs, the individual orders before the order in error will be processed, but all remaining orders in the graphics-data will be ignored.

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