COBOL/400 Language Help

SPECIAL-NAMES Paragraph

Definition
The SPECIAL-NAMES paragraph:
                     *-----------------------------------------------<-1
                     V
->->---SPECIAL-NAMES. -*------------------------------------------------>2
                     *-environment-name-1----------------------------->3
                     +
                     *-environment-name-2----------------------------->4
 
 
1<-------------------------------------------------------------------*
                                                                    +
2->------------------------------------------------------------------*->
3->-*--*mnemonic-name-1----------------------------------------------*
   *IS*                                                             +
4->**--*mnemonic-name-2*--------------------------------------------**
  +*IS*               +                                            +
  +                   *ON*------**--*cond-1*---------------------***
  +                   +  *STATUS**IS*      +                     +++
  +                   +                    *OFF*------**--*cond-2*++
  +                   +                        *STATUS**IS*       ++
  +                   *OFF*------**--*cond-2*--------------------**+
  +                       *STATUS**IS*      +                    + +
  +                                         *ON*------**--*cond-1* +
  +                                            *STATUS**IS*        +
  +                                                                +
  *-ON*------**--*cond-1-*---------------------**------------------*
  +   *STATUS**IS*       +                     ++
  +                      *OFF*------**--*cond-2*+
  +                          *STATUS**IS*       +
  *-OFF*------**--*cond-2*---------------------**
       *STATUS**IS*      +                     +
                         *ON*------**--*cond-1-*
                            *STATUS**IS*
 
 
->-*---------------------------------------------------------------*--->
  + *------------------------------------------------------------*+
  + V                                                            ++
  *-ALPHABET alphabet-name-1*--**STANDARD-1*--------------------***
                            *IS**STANDARD-2*                    +
                                *NATIVE----*                    +
                                *EBCDIC----*                    +
                                *NLSSORT---*                    +
                                +*-----------------------------*+
                                +V                             ++
                                *-literal-1*------------------***
                                           **THROUGH*literal-2*
                                           +*THRU---*         +
                                           + *--------------* +
                                           + V              + +
                                           *--ALSO literal-3*-*
   *-------------------------------------------------------------*
   V                                                             +
->--*-------------------------------------------------------------*---->
   +                        *----------------------------------* +
   +                        V                                  + +
   *-CLASS class-name-1-*--*--literal-4*-----------------------*-*
                        *IS*           *-*-THROUGH-*-literal-5-*
                                         *-THRU----*
 
->--*----------------------------*--*------------------------*--------->
   *CURRENCY*----**--*literal-6-*  *-DECIMAL-POINT*--*COMMA-*
            *SIGN**IS*                            *IS*
 
->--*--------------------*---*---------------------------*------------->
   *-CONSOLE-*----*-CRT-*   *-CURSOR-*----*-data-name-1-*
             *-IS-*                  *-IS-*
 
->--*-------------------------------*---------------*---*--------------><-
   *-CRT STATUS-*----*-data-name-2-*               *-.-*
                *-IS-*
 

Environment-name-1

Environment-name-1 represents the system devices or standard system actions taken by the compiler.

Valid specifications for environment-name-1 are as follows:

Environment-name-1         Meaning                           Allowed In
 
CSP                        Suppress spacing when             WRITE
                           printing a line
 
C01                        Skip to the next page.            WRITE
 
ATTRIBUTE-DATA             Retrieve attribute data           ACCEPT
                           about a program device
                           acquired by a transaction
                           file
 
I-O-FEEDBACK               Give information about the        ACCEPT
                           last I-O operation on a file
 
OPEN-FEEDBACK              Give information about a file     ACCEPT
 
CONSOLE,                   Communicate with the system       ACCEPT, DISPLAY
SYSTEM-CONSOLE             operator's message queue
                           (QSYSOPR)
 
LOCAL-DATA                 Retrieve data from, or move       ACCEPT, DISPLAY
                           data to the local data area
 
PIP-DATA                   Retrieve data from the            ACCEPT
                           Program Initialization
                           Parameters (PIP) data area
                           for programs running as part
                           of a prestart job
 
REQUESTOR                  Communicate with the user         ACCEPT, DISPLAY
                           work station (interactive
                           jobs) or the batch stream
                           or job log (batch jobs)
 
SYSIN                      The equivalent of REQUESTOR       ACCEPT
                           (for the ACCEPT statement
                           only)
 
SYSOUT                     The equivalent of REQUESTOR       DISPLAY
                           (for the DISPLAY statement
                           only)

environment-name-2

Environment-name-2 is a 1-byte User Programmable Status Indicator (UPSI) switch, defined as UPSI-0 through UPSI-7, or as SYSTEM-SHUTDOWN.

UPSI-0 through UPSI-7 represent eight 1-byte program switches. They are COBOL names that identify program switches defined outside the COBOL program at object time. Their contents are considered alphanumeric. A value of zero is off; a value of one is on.

SYSTEM-SHUTDOWN is an internal switch that is set to ON status when the system operator puts the system in a shutdown-pending state or when the job is canceled in a controlled manner. The associated ON or OFF condition-names can be referenced anywhere a condition-name is valid. The program cannot alter their status.

mnemonic-name-1 or -2

Mnemonic-name-1 and mnemonic-name-2 follow the rules of formation for user-defined names. You can use mnemonic-name-1 in ACCEPT, DISPLAY, and WRITE statements. You can use mnemonic-name-2 only in the SET statement. Mnemonic-name-2 can be used to qualify cond-1 or cond-2 names.

Cond-1, Cond-2

ALPHABET Clause

assignment-name-1 or literal-1

You can specify assignment-name-1 or literal-1 as a user-defined word or a nonnumeric literal. Any assignment-name or literal after the first is syntax-checked, but has no effect on the execution of the program.

STANDARD-1

STANDARD-1 specifies the ASCII character set.

STANDARD-2

STANDARD-2 specifies the International Reference Version of the ISO 7-bit code defined in the International Standard 646, 7-bit Coded Character Set for Information Processing Interchange.

NATIVE

NATIVE specifies the native character code set. If you omit the alphabet-name clause, EBCDIC is assumed.

EBCDIC

EBCDIC specifies the EBCDIC character set.

NLSSORT

NLSSORT specifies that the Sort sequence (SRTSEQ) and Language identifier (LANGID) specifications in the compiler options (or implied defaults) are used to determine the character code set used for all nonnumeric comparisons.

Literal-1, Literal-2, Literal-3

ALSO

CLASS class-name-1

CLASS class-name-1 IS provides a means for relating a name to the specified set of characters listed in that clause. Class-name-1 can be referenced only in a class condition. The characters specified by the values of the literals in this clause define the exclusive set of characters of which this class-name-1 consists.

THROUGH or THRU

When you specify the THROUGH phrase, the contiguous EBCDIC characters beginning with the character specified by literal-1 and ending with the character specified by literal-2 are assigned successively ascending positions in this collating sequence. This sequence may be either ascending or descending within the original EBCDIC sequence.

Literal-4, Literal-5

CURRENCY or SIGN

The CURRENCY SIGN IS clause specifies the currency symbol to be used in the PICTURE clause.

When you omit the CURRENCY SIGN clause, you can use only the dollar sign ($) as the PICTURE symbol for the currency sign.

literal-6

Literal-6 must be a one-character, nonnumeric literal, and must not be any of the following:

COMMA or DECIMAL-POINT

DECIMAL-POINT IS COMMA exchanges the functions of the period and the comma in PICTURE character strings and in numeric literals.

CONSOLE or CRT

The CONSOLE IS CRT clause treats any ACCEPT or DISPLAY statement without format-specific phrases (such as LOCAL-DATA or PIP-DATA) as an extended ACCEPT or DISPLAY statement.

CURSOR

The CURSOR IS data-name-1 clause specifies the data item that will contain the cursor address used by the ACCEPT statement.

data-name-1

Data-name-1 must be a 4- or 6-byte alphanumeric field or a 4- or 6-byte unsigned zoned integer field. If data-name-1 is 4 characters in length, interpret the first two characters as line number, and the second two as column number. If data-name-1 is 6 characters in length, interpret the first three characters as line number, and the second three as column number.

The clause has no effect if data-name-1 contains an invalid position value, such as: zeros, a nonnumeric value, or a value that is beyond the range of the screen.

Data-name-1 must be declared in the WORKING-STORAGE SECTION of the program.

CRT STATUS

The CRT STATUS IS data-name-2 clause specifies a data item into which a status value returns after an extended ACCEPT statement.

data-name-2

Data-name-2 must be a 6-byte alphanumeric field or a 6-byte unsigned zoned integer, and it must be described in the WORKING-STORAGE SECTION of the program.


[ Top of Page | Previous Page | Next Page | Table of Contents ]