11.9 CBL_GET_SCR

This routine returns a one-byte or two-byte code to display a graphic character.

Specification

Parameter data definition

01 graphic-parameters.
   02 graphic-flag         PIC 9(4) BINARY.
   02 graphic-buffer-size  PIC 9(4) BINARY.
   02 graphic-buffer OCCURS 15.
      03 high-order-byte   PIC X.                          
      03 low-order-byte    PIC X.                          
01 status-code:            PIC S9(4) COMP-5.

Calling format

CALL "CBL_GET_SCR_GRAPHICS"
    USING graphic-parameters
    RETURNING status-code.

Interface

graphic-flag

Specifies the graphic character code as follows:

0: The graphic character code suited to the screen is returned. (When one-byte code is valid, one-byte code is set in the graphic buffer. If one-byte code is invalid, two-byte code is set in the graphic buffer.)
1: One-byte code is returned.
2: Two-byte code is returned.

graphic-buffer-size: Specifies the size of the graphic buffer to be used for output. To obtain all graphic characters, 30 must be specified.

graphic-buffer

Specifies the area used to set the graphic code. When a one-byte graphic character code is obtained, a low value is set in the high-order byte and the graphic character code is set in the low-order byte. When a two-byte graphic character code is obtained, the graphic character code is set in the high-order and low-order bytes.

If no valid graphic character code is found, a low value is set in both the high-order and low-order bytes.

Examples of graphic characters are include the up arrow, down arrow, right arrow, left arrow, black up pointing triangle, black down pointing triangle, check, restoration, down zigzag arrow, scroll, black square, black diamond, closing angle bracket, opening angle bracket, and BTAB graphics.

Return code

The return code is set in the status-code specified in the RETURNING clause.

status-code

0: Successful
1: Requested graphic character code partially invalid
2: Reserved
3: Failure

Note

The graphic character gotten by this subroutine displays using Terminal Fonts.

There are graphic characters, which are not able to get, causing different operating system or locale of operating system.

On the operating system, which supports DBCS, one byte graphic character may not be gotten without Japan.

11.9 CBL_GET_SCR_GRAPHICS