Documente Academic
Documente Profesional
Documente Cultură
Language Reference
Version 5.2
SC14-7381-03
Enterprise COBOL for z/OS
Language Reference
Version 5.2
SC14-7381-03
Note
Before using this information and the product it supports, be sure to read the general information under Notices on page
625.
First edition
| This edition applies to Version 5 Release 2 of IBM Enterprise COBOL for z/OS (program number 5655-W32) and to
| all subsequent releases and modifications until otherwise indicated in new editions. Make sure that you are using
| the correct edition for the level of the product.
You can view or download softcopy publications free of charge at www.ibm.com/shop/publications/order/.
Copyright IBM Corporation 1991, 2015.
US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract
with IBM Corp.
Contents
Tables . . . . . . . . . . . . . . . ix XML-EVENT . . . . . . . . . . . . . 26
XML-INFORMATION . . . . . . . . . . 31
Preface . . . . . . . . . . . . . . . xi XML-NAMESPACE. . . . . . . . . . . 32
XML-NNAMESPACE . . . . . . . . . . 33
About this information. . . . . . . . . . . xi
XML-NAMESPACE-PREFIX . . . . . . . . 33
How to read the syntax diagrams . . . . . . xi
XML-NNAMESPACE-PREFIX . . . . . . . 34
IBM extensions . . . . . . . . . . . . xiv
XML-NTEXT . . . . . . . . . . . . . 35
Obsolete language elements . . . . . . . xiv
XML-TEXT . . . . . . . . . . . . . 36
DBCS notation . . . . . . . . . . . . xv
Literals . . . . . . . . . . . . . . . . 36
Acknowledgment . . . . . . . . . . . xv
Alphanumeric literals . . . . . . . . . . 36
Additional documentation and support . . . . . xvi
Numeric literals . . . . . . . . . . . . 40
Summary of changes . . . . . . . . . . . xvi
DBCS literals . . . . . . . . . . . . . 41
| Version 5 Release 2 . . . . . . . . . . xvi
National literals . . . . . . . . . . . . 42
Version 5 Release 1 Modification 1 . . . . . xvii
PICTURE character-strings . . . . . . . . . 45
Version 5 Release 1 . . . . . . . . . . xvii
Comments. . . . . . . . . . . . . . . 45
How to send your comments . . . . . . . . xviii
Accessibility . . . . . . . . . . . . . xviii
Interface information . . . . . . . . . . xix Chapter 4. Separators . . . . . . . . 47
Keyboard navigation . . . . . . . . . . xix Rules for separators . . . . . . . . . . . 47
Accessibility of this information . . . . . . xix
IBM and accessibility . . . . . . . . . . xix Chapter 5. Sections and paragraphs . . 51
Sentences, statements, and entries . . . . . . . 51
Part 1. COBOL language structure . . 1 Entries . . . . . . . . . . . . . . . 52
Clauses . . . . . . . . . . . . . . . 52
Sentences . . . . . . . . . . . . . . 52
Chapter 1. Characters . . . . . . . . . 3 Statements. . . . . . . . . . . . . . 52
Phrases . . . . . . . . . . . . . . . 52
Chapter 2. Character sets and code
pages. . . . . . . . . . . . . . . . 5 Chapter 6. Reference format . . . . . 53
Character encoding units . . . . . . . . . . 5 Sequence number area. . . . . . . . . . . 53
Indicator area. . . . . . . . . . . . . . 53
Chapter 3. Character-strings . . . . . . 9 Area A . . . . . . . . . . . . . . . . 54
COBOL words with single-byte characters . . . . 9 Division headers. . . . . . . . . . . . 54
User-defined words with DBCS characters . . . . 10 Section headers . . . . . . . . . . . . 54
User-defined words. . . . . . . . . . . . 10 Paragraph headers or paragraph names . . . . 54
System-names . . . . . . . . . . . . . 12 Level indicators (FD and SD) or level-numbers
Function-names . . . . . . . . . . . . . 12 (01 and 77) . . . . . . . . . . . . . 55
Reserved words . . . . . . . . . . . . . 12 DECLARATIVES and END DECLARATIVES . . 55
Figurative constants . . . . . . . . . . . 13 End program, end class, and end method
Special registers . . . . . . . . . . . . . 16 markers . . . . . . . . . . . . . . 55
ADDRESS OF . . . . . . . . . . . . 17 Area B . . . . . . . . . . . . . . . . 56
DEBUG-ITEM . . . . . . . . . . . . 17 Entries, sentences, statements, clauses . . . . 56
JNIENVPTR . . . . . . . . . . . . . 19 Continuation lines . . . . . . . . . . . 56
LENGTH OF . . . . . . . . . . . . . 19 Area A or Area B . . . . . . . . . . . . 58
LINAGE-COUNTER . . . . . . . . . . 20 Level-numbers . . . . . . . . . . . . 58
RETURN-CODE . . . . . . . . . . . . 21 Comment lines . . . . . . . . . . . . 58
SHIFT-OUT and SHIFT-IN . . . . . . . . 21 Floating comment indicators (*>) . . . . . . 59
SORT-CONTROL . . . . . . . . . . . 22 Compiler-directing statements . . . . . . . 59
SORT-CORE-SIZE . . . . . . . . . . . 22 | Compiler directives . . . . . . . . . . . 59
SORT-FILE-SIZE . . . . . . . . . . . . 23 Debugging lines . . . . . . . . . . . . 59
SORT-MESSAGE . . . . . . . . . . . 23 Pseudo-text . . . . . . . . . . . . . 60
SORT-MODE-SIZE . . . . . . . . . . . 23 Blank lines . . . . . . . . . . . . . 60
SORT-RETURN . . . . . . . . . . . . 24
TALLY . . . . . . . . . . . . . . . 24 Chapter 7. Scope of names . . . . . . 61
WHEN-COMPILED . . . . . . . . . . 25 Types of names . . . . . . . . . . . . . 61
XML-CODE . . . . . . . . . . . . . 25 External and internal resources . . . . . . . . 63
Contents v
Chapter 20. PROCEDURE DIVISION PERFORM with TIMES phrase . . . . . . 393
statements . . . . . . . . . . . . 299 PERFORM with UNTIL phrase . . . . . . 394
ACCEPT statement . . . . . . . . . . . 300 PERFORM with VARYING phrase . . . . . 395
Data transfer . . . . . . . . . . . . 300 READ statement . . . . . . . . . . . . 402
System date-related information transfer . . . 301 Processing files with variable-length records or
DATE, DATE YYYYMMDD, DAY, DAY multiple record descriptions . . . . . . . 404
YYYYDDD, DAY-OF-WEEK, and TIME. . . . 302 Sequential access mode . . . . . . . . . 405
ADD statement . . . . . . . . . . . . . 304 Random access mode. . . . . . . . . . 407
ALTER statement . . . . . . . . . . . . 307 Dynamic access mode . . . . . . . . . 407
Segmentation considerations . . . . . . . 307 READ statement notes . . . . . . . . . 407
CALL statement . . . . . . . . . . . . 309 RELEASE statement . . . . . . . . . . . 409
CANCEL statement . . . . . . . . . . . 317 RETURN statement . . . . . . . . . . . 411
CLOSE statement . . . . . . . . . . . . 319 REWRITE statement . . . . . . . . . . . 413
Effect of CLOSE statement on file types . . . 320 Reusing a logical record . . . . . . . . . 414
COMPUTE statement. . . . . . . . . . . 323 Sequential files . . . . . . . . . . . . 414
CONTINUE statement . . . . . . . . . . 325 Indexed files . . . . . . . . . . . . 414
DELETE statement . . . . . . . . . . . 326 Relative files. . . . . . . . . . . . . 415
DISPLAY statement . . . . . . . . . . . 328 SEARCH statement . . . . . . . . . . . 416
DIVIDE statement . . . . . . . . . . . . 331 Serial search . . . . . . . . . . . . . 417
ENTRY statement . . . . . . . . . . . . 336 Binary search . . . . . . . . . . . . 420
EVALUATE statement . . . . . . . . . . 337 Search statement considerations . . . . . . 422
Determining values . . . . . . . . . . 338 SET statement . . . . . . . . . . . . . 423
Comparing selection subjects and objects . . . 339 Format 1: SET for basic table handling . . . . 423
Executing the EVALUATE statement . . . . 340 Format 2: SET for adjusting indexes . . . . . 424
EXIT statement . . . . . . . . . . . . . 341 Format 3: SET for external switches . . . . . 425
| Format 1 (simple) . . . . . . . . . . . 341 Format 4: SET for condition-names . . . . . 425
| Format 2 (program) . . . . . . . . . . 342 Format 5: SET for USAGE IS POINTER data
| Format 3 (method) . . . . . . . . . . 343 items . . . . . . . . . . . . . . . 426
| Format 5 (inline-perform) . . . . . . . . 343 Format 6: SET for procedure-pointer and
| Format 6 (procedure) . . . . . . . . . . 344 function-pointer data items . . . . . . . . 427
GOBACK statement . . . . . . . . . . . 345 Format 7: SET for USAGE OBJECT REFERENCE
GO TO statement . . . . . . . . . . . . 346 data items . . . . . . . . . . . . . 428
Unconditional GO TO . . . . . . . . . 346 SORT statement . . . . . . . . . . . . 430
Conditional GO TO . . . . . . . . . . 346 SORT special registers . . . . . . . . . 438
Altered GO TO . . . . . . . . . . . . 347 Segmentation considerations . . . . . . . 438
IF statement . . . . . . . . . . . . . . 348 START statement . . . . . . . . . . . . 440
Transferring control . . . . . . . . . . 349 Indexed files . . . . . . . . . . . . 441
Nested IF statements . . . . . . . . . . 349 Relative files. . . . . . . . . . . . . 442
INITIALIZE statement . . . . . . . . . . 350 STOP statement . . . . . . . . . . . . 443
INITIALIZE statement rules . . . . . . . 351 STRING statement. . . . . . . . . . . . 444
INSPECT statement . . . . . . . . . . . 353 Data flow . . . . . . . . . . . . . 446
Data flow . . . . . . . . . . . . . 360 Example of the STRING statement . . . . . 447
Comparison cycle . . . . . . . . . . . 361 SUBTRACT statement . . . . . . . . . . 449
Example of the INSPECT statement . . . . . 361 UNSTRING statement . . . . . . . . . . 452
INVOKE statement . . . . . . . . . . . 363 Data flow . . . . . . . . . . . . . 456
Interoperable data types for COBOL and Java 368 Values at the end of execution of the
Miscellaneous argument types for COBOL and UNSTRING statement . . . . . . . . . 458
Java . . . . . . . . . . . . . . . 369 Example of the UNSTRING statement . . . . 458
MERGE statement . . . . . . . . . . . . 371 WRITE statement . . . . . . . . . . . . 460
MERGE special registers. . . . . . . . . 375 WRITE for sequential files . . . . . . . . 465
Segmentation considerations . . . . . . . 375 WRITE for indexed files . . . . . . . . . 467
MOVE statement . . . . . . . . . . . . 376 WRITE for relative files . . . . . . . . . 467
Elementary moves. . . . . . . . . . . 377 XML GENERATE statement . . . . . . . . 468
Moves involving file record areas. . . . . . 381 Nested XML GENERATE or XML PARSE
Group moves . . . . . . . . . . . . 381 statements . . . . . . . . . . . . . 476
MULTIPLY statement . . . . . . . . . . . 383 Operation of XML GENERATE . . . . . . 476
OPEN statement . . . . . . . . . . . . 386 Format conversion of elementary data . . . . 477
General rules . . . . . . . . . . . . 388 Trimming of generated XML data . . . . . 479
OPEN statement notes . . . . . . . . . 389 XML element name and attribute name
PERFORM statement . . . . . . . . . . . 391 formation. . . . . . . . . . . . . . 479
Basic PERFORM statement . . . . . . . . 392 XML PARSE statement . . . . . . . . . . 480
Contents vii
Appendix D. Source language Appendix G. Industry specifications 617
debugging. . . . . . . . . . . . . 595
Debugging lines . . . . . . . . . . . . 595 | Appendix H. 2002 COBOL Standard
Debugging sections . . . . . . . . . . . 595 | features implemented in Enterprise
DEBUG-ITEM special register . . . . . . . . 596 | COBOL Version 5 . . . . . . . . . 619
Activate compile-time switch . . . . . . . . 596
Activate object-time switch . . . . . . . . . 596
Notices . . . . . . . . . . . . . . 625
Programming interface information . . . . . . 626
Appendix E. Reserved words . . . . 599
Trademarks . . . . . . . . . . . . . . 626
See the IBM Enterprise COBOL for z/OS Programming Guide for information and
examples that will help you write, compile, and debug programs and classes.
Use the following description to read the syntax diagrams in this document:
v Read the syntax diagrams from left to right, from top to bottom, following the
path of the line.
The >>--- symbol indicates the beginning of a syntax diagram.
The ---> symbol indicates that the syntax diagram is continued on the next line.
The >--- symbol indicates that the syntax diagram is continued from the
previous line.
The --->< symbol indicates the end of a syntax diagram.
Diagrams of syntactical units other than complete statements start with the >---
symbol and end with the ---> symbol.
v Required items appear on the horizontal line (the main path).
Format
Format
STATEMENT
optional item
v When you can choose from two or more items, they appear vertically, in a stack.
If you must choose one of the items, one item of the stack appears on the main
path.
If choosing one of the items is optional, the entire stack appears below the main
path.
Format
STATEMENT
optional choice 1
optional choice 2
v An arrow returning to the left above the main line indicates an item that can be
repeated.
Format
A repeat arrow above a stack indicates that you can make more than one choice
from the stacked items, or repeat a single choice.
v Variables appear in italic lowercase letters (for example, parmx). They represent
user-supplied names or values.
v If punctuation marks, parentheses, arithmetic operators, or other such symbols
are shown, they must be entered as part of the syntax.
(1) (2)
STATEMENT identifier-1
literal-1 (3)
item 1
(4)
TO identifier-3
ROUNDED
(5)
SIZE ERROR imperative-statement-1
ON
(6)
END-STATEMENT
item 1:
identifier-2
literal-2
arithmetic-expression-1
Notes:
1 The STATEMENT keyword must be specified and coded as shown.
2 This operand is required. Either identifier-1 or literal-1 must be coded.
3 The item 1 fragment is optional; it can be coded or not, as required by the
application. If item 1 is coded, it can be repeated with each entry separated
by one or more COBOL separators. Entry selections allowed for this
fragment are described at the bottom of the diagram.
4 The operand identifier-3 and associated TO keyword are required and can
be repeated with one or more COBOL separators separating each entry.
Each entry can be assigned the keyword ROUNDED.
5 The ON SIZE ERROR phrase with associated imperative-statement-1 is
optional. If the ON SIZE ERROR phrase is coded, the keyword ON is
optional.
6 The END-STATEMENT keyword can be coded to end the statement. It is
not a required delimiter.
Preface xiii
IBM extensions
IBM extensions generally add features, syntax, or rules that are not specified in the
ANSI and ISO COBOL standards that are listed in Appendix G, Industry
specifications, on page 617. In this document, the term 85 COBOL Standard refers
to those standards.
Extensions range from minor relaxation of rules to major capabilities, such as XML
support, Unicode support, object-oriented COBOL for Java interoperability, and
DBCS character handling.
The rest of this document describes the complete language without identifying
extensions. You will need to review Appendix A, IBM extensions, on page 571
and the Compiler options in the Enterprise COBOL Programming Guide if you want to
use only standard language elements.
This does not imply that IBM will remove the 85 COBOL Standard obsolete
elements from a future release of Enterprise COBOL.
The <> symbol denotes contiguous shift-out and shift-in characters. The >< symbol
denotes contiguous shift-in and shift-out characters.
DBCS characters are shown in this form: D1D2D3. Latin alphabet characters in
DBCS representation are shown in this form: .A.B.C. The dots that precede the
letters represent the hexadecimal value X'42'.
Notes
v In EBCDIC DBCS data containing mixed single-byte and double-byte characters,
double-byte character strings are delimited by shift-out and shift-in characters.
v In ASCII DBCS data containing mixed single-byte and double-byte characters,
double-byte character strings are not delimited by shift-out and shift-in
characters.
Acknowledgment
The following extract from Government Printing Office Form Number
1965-0795689 is presented for the information and guidance of the user:
Preface xv
have specifically authorized the use of this material in whole or in part, in the
COBOL specifications. Such authorization extends to the reproduction and
use of COBOL specifications in programming manuals or similar publications.
Summary of changes
This section lists the key changes that have been made to this document for
| Enterprise COBOL for z/OS in Version 5. The technical changes are marked by a
vertical bar (|) in the left margin in the PDF version.
| Version 5 Release 2
| v New keywords LEADING and TRAILING are added to the REPLACING phrase
| of the COPY statement and the REPLACE statement to improve partial-word
| replacement operations. The new keywords are part of the 2002 COBOL
| Standard (COPY statement on page 542 and REPLACE statement on page
| 555).
| v The new CALLINTERFACE directive specifies the interface convention for CALL
| and SET statements. The convention specified stays in effect until another
| CALLINTERFACE directive is encountered in the source. The CALLINTERFACE
| directive has three suboptions: DLL, DYNAMIC, and STATIC.
| v The EXIT statement includes the following new formats, which provide a
| structured way to exit without using a GO TO statement. The new formats are
| part of the 2002 COBOL Standard.
| Format 5, EXIT PERFORM statement for exiting from an inline PERFORM
| statement
| Format 6, EXIT PARAGRAPH or EXIT SECTION statement for exiting from
| the middle of a paragraph or exiting from a section respectively
| v A new format of the SORT statement, the table SORT statement, arranges table
| elements in a user-specified sequence. It is part of the 2002 COBOL Standard
| (SORT statement on page 430).
| v A new compiler option, VLR(COMPAT|STANDARD), affects the READ
| statement processing of variable-length records (READ statement notes on
| page 407).
| v XML PARSE COMPAT support is restored. You can specify the
| XMLPARSE(XMLSS|COMPAT) compiler option to choose between parsing with
| the z/OS XML System Services parser, or with the compatibility-mode COBOL
| XML parser from the COBOL library. It can ease your migration to the
| Enterprise COBOL V5 compiler.
| v Enhancements are made to the XML GENERATE statement on page 468:
Version 5 Release 1
v A new special register, XML-INFORMATION, provides a mechanism to easily
determine whether the XML content delivered for an XML event is complete or
will be continued on the next event. (XML-INFORMATION on page 31)
| v New phrases, NAME, TYPE and SUPPRESS are added to the XML GENERATE
| statement. The generic-suppression-phrase of the XML GENERATE statement
| behavior is changed to be more flexible by deferring the decision about what
| gets excluded until run time. This way entire classes and categories of data items
| can be excluded from the generated XML output based on suppression criteria.
| The data items to which the suppression specifications apply and that meet the
| criteria at run time will be excluded. (XML GENERATE statement on page
| 468)
v New intrinsic functions are added to provide additional Unicode capability:
ULENGTH (ULENGTH on page 527)
UPOS (UPOS on page 528)
USUBSTR (USUBSTR on page 529)
USUPPLEMENTARY (USUPPLEMENTARY on page 530)
UVALID (UVALID on page 531)
UWIDTH (UWIDTH on page 533)
v Several compiler limits are raised (Appendix B, Compiler limits, on page 583).
v The information about reference format has been updated to reflect that:
A new floating comment indicator (the character string '*>') can be coded to
indicate that the ensuing text on a line is an inline comment (Floating
comment indicators (*>) on page 59).
Add inline comments as another format of comments (Comments on page
45).
v The Millennium Language Extensions are no longer supported, which include
the following compiler options and language elements:
DATE FORMAT clause on data description entries
DATEVAL intrinsic function
UNDATE intrinsic function
YEARWINDOW intrinsic function
DATEPROC compiler option
YEARWINDOW compiler option
Preface xvii
v Format 2 declarative syntax: USE...AFTER...LABEL PROCEDURE..., and the
syntax: GO TO MORE-LABELS are no longer supported.
v The compatibility-mode COBOL XML parser from the COBOL library is no
longer supported for use by Enterprise COBOL V5 programs. XML PARSE
statements in V5 programs always use the z/OS XML System Services parser.
v Correct the READ statement processing of wrong-length records (READ
statement on page 402).
v The following compiler options are no longer supported, but are tolerated with
Enterprise COBOL V5 to ease migration. Informational or warning diagnostics
will be displayed if you specify any of these options.
DATEPROC - Year 2000 support is no longer provided.
YEARWINDOW - Year 2000 support is no longer provided.
XMLPARSE - The XML System Services parser is always used.
v A new keyword UNBOUNDED is added to the OCCURS...DEPENDING ON
clause, which enables you to define unbounded tables and groups
(Variable-length tables on page 197).
v To be compatible with the convention used by C and C++, the linkage
convention for returning a doubleword binary item specified in the
RETURNING phrase of the PROCEDURE DIVISION header and the CALL
statement is changed (CALL statement).
Be sure to include the name of the document, the publication number of the
document, the version of the product, and, if applicable, the specific location (for
example, page number or section heading) of the text that you are commenting on.
When you send information to IBM, you grant IBM a nonexclusive right to use or
distribute the information in any way that IBM believes appropriate without
incurring any obligation to you.
Accessibility
Accessibility features help users who have a disability, such as restricted mobility
or limited vision, to use software products successfully. The accessibility features in
z/OS provide accessibility for Enterprise COBOL.
Keyboard navigation
Users can access z/OS user interfaces by using TSO/E or ISPF. For information
about accessing TSO/E or ISPF interfaces, see the following publications:
v z/OS TSO/E Primer
v z/OS TSO/E User's Guide
v z/OS ISPF User's Guide Volume I
These guides describe how to use TSO/E and ISPF, including the use of keyboard
shortcuts or function keys (PF keys). Each guide includes the default settings for
the PF keys and explains how to modify their functions.
To enable your screen reader to accurately read syntax diagrams, source code
examples, and text that contains the period or comma PICTURE symbols, you
must set the screen reader to speak all punctuation.
Preface xix
xx Enterprise COBOL for z/OS, V5.2 Language Reference
Part 1. COBOL language structure
For certain language elements, the basic character set is extended with the EBCDIC
Double-Byte Character Set (DBCS).
The content of alphanumeric literals, comment lines, and comment entries can
include any of the characters in the computer's compile-time character set, and can
include both single-byte and DBCS characters.
Runtime data can include any characters from the runtime character set of the
computer. The runtime character set of the computer can include alphanumeric
characters, DBCS characters, and national characters. National characters are
represented in UTF-16, a 16-bit encoding form of Unicode.
For details, see User-defined words with DBCS characters on page 10, DBCS
literals on page 41, and National literals on page 42.
Table 1. Basic COBOL character set. This table lists basic COBOL character set.
Character Meaning
Space
+ Plus sign
- Minus sign or hyphen
* Asterisk
/ Forward slash or solidus
= Equal sign
$ Currency sign1
, Comma
; Semicolon
. Decimal point or period
1. The currency sign is the character with the value X'5B', regardless of the code page in
effect. The assigned graphic character can be the dollar sign or a local currency sign.
2. The quotation mark is the character with the value X'7F'.
Each code page that IBM defines is identified by a code page name, for example
IBM-1252, and a coded character set identifier (CCSID), for example 1252.
Some COBOL operations can override the encoding established by the CODEPAGE
compiler option, for example:
v The DISPLAY-OF and NATIONAL-OF intrinsic functions can specify a CCSID as
argument-2.
v The XML PARSE and XML GENERATE statements can specify a code page in
the ENCODING phrase.
For further details about the CODEPAGE compiler option, see CODEPAGE in the
Enterprise COBOL Programming Guide.
If you do not specify a code page, the default is code page IBM-1140, CCSID 1140.
The encoding of national data is not affected by the CODEPAGE compiler option.
The encoding for national literals and data items described with usage NATIONAL
is UTF-16BE (big endian), CCSID 1200. A reference to UTF-16 in this document is a
reference to UTF-16BE.
The size of an encoding unit for data items and literals depends on the USAGE
clause of the data item or the category of the literal as follows:
v For data items described with USAGE DISPLAY and for alphanumeric literals,
an encoding unit is 1 byte, regardless of the code page used and regardless of
the number of bytes used to represent a given graphic character.
The relationship between a graphic character and an encoding unit depends on the
type of code page used for the data item or literal. See the following types of
runtime code pages:
v Single-byte EBCDIC
v EBCDIC DBCS
v Unicode UTF-16
See the following sections for the details of each type of code page.
Also see the section Specifying the encoding in the Enterprise COBOL Programming
Guide.
You can use a single-byte EBCDIC code page in data items described with USAGE
DISPLAY and in literals of category alphanumeric. An encoding unit is 1 byte and
each graphic character is represented in 1 byte. For these data items and literals,
you need not be concerned with encoding units.
USAGE DISPLAY
You can use a mixture of single-byte and double-byte EBCDIC characters in data
items described with USAGE DISPLAY and in literals of category alphanumeric.
Double-byte characters must be delimited by shift-out and shift-in characters. An
encoding unit is 1 byte and the size of a graphic character is 1 byte or 2 bytes.
When alphanumeric data items or literals contain DBCS data, programmers are
responsible for ensuring that operations do not unintentionally separate the
multiple encoding units that form a graphic character. Care should be taken with
reference modification, and truncation during moves should be avoided. The
COBOL runtime system does not check for a split between the encoding units that
form a graphic character or for the loss of shift-out or shift-in codes.
To avoid problems, you can convert alphanumeric literals and data items described
with usage DISPLAY to national data (UTF-16) by moving the data items or literals
to data items described with usage NATIONAL or by using the NATIONAL-OF
intrinsic function. You can then perform operations on the national data with less
concern for splitting graphic characters. You can convert the data back to USAGE
DISPLAY by using the DISPLAY-OF intrinsic function.
USAGE DISPLAY-1
You can use double-byte characters of an EBCDIC DBCScode page in data items
described with USAGE DISPLAY-1 and in literals of category DBCS. An encoding
unit is 2 bytes and each graphic character is represented in a single 2-byte
encoding unit. For these data items and literals, you need not be concerned with
encoding units.
You can use UTF-16 in data items described with USAGE NATIONAL. National
literals are stored as UTF-16 characters regardless of the code page used for the
source program. An encoding unit for data items of usage NATIONAL and
national literals is 2 bytes.
For most of the characters in UTF-16, a graphic character is one encoding unit.
Characters converted to UTF-16 from an EBCDIC, ASCII, or EUC code page are
represented in one UTF-16 encoding unit. Some of the other graphic characters in
UTF-16 are represented by a surrogate pair or a combining character sequence. A
surrogate pair consists of two encoding units (4 bytes). A combining character
sequence consists of a base character and one or more combining marks or a
sequence of one or more combining marks (4 bytes or more, in 2-byte increments).
In data items of usage NATIONAL, each 2-byte encoding unit is treated as a
character.
Character strings and certain separators form text words. A text word is a character
or a sequence of contiguous characters (possibly continued across lines) between
character positions 8 and 72 inclusive in source text, library text, or pseudo-text.
For more information about pseudo-text, see Pseudo-text on page 60.
Source text, library text, and pseudo-text can be written in single-byte EBCDIC
and, for some character-strings, DBCS. (The compiler cannot process source code
written in ASCII or Unicode.)
You can use single-byte and double-byte character-strings to form the following
items:
v COBOL words
v Literals
v Comment text
Except for arithmetic operators and relation characters, each character of a COBOL
word is selected from the following set:
v Latin uppercase letters A through Z
v Latin lowercase letters a through z
v digits 0 through 9
v - (hyphen)
v _ (underscore)
The hyphen cannot appear as the first or last character in such words. The
underscore cannot appear as the first character in such words. Most user-defined
words (all except section-names, paragraph-names, priority-numbers, and
level-numbers) must contain at least one alphabetic character. Priority numbers and
level numbers need not be unique; a given specification of a priority-number or
level-number can be identical to any other priority-number or level-number.
In COBOL words (but not in the content of alphanumeric, DBCS, and national
literals), each lowercase single-byte alphabetic letter is considered to be equivalent
to its corresponding single-byte uppercase alphabetic letter.
User-defined words
A user-defined word is a COBOL word that must be supplied by the user to satisfy
the format of a clause or statement.
The following sets of user-defined words are supported. The second column
indicates whether DBCS characters are allowed in words of a given set.
A given user-defined word can belong to only one of these sets, except that a given
number can be both a priority-number and a level-number. Each user-defined
word within a set must be unique, except for priority-numbers and level-numbers
and except as specified in Chapter 8, Referencing data names, copy libraries, and
PROCEDURE DIVISION names, on page 67.
The following types of names, when they are declared within a configuration
section, can be referenced by statements and entries in the program that contains
the configuration section or in any program contained within that program:
v Alphabet-name
v Class-name
v Condition-name
v Mnemonic-name
Chapter 3. Character-strings 11
v Symbolic-character
v XML-schema-name
System-names
A system-name is a character string that has a specific meaning to the system.
Function-names
A function-name specifies the mechanism provided to determine the value of an
intrinsic function.
Reserved words
A reserved word is a character-string with a predefined meaning in a COBOL source
unit.
Reserved words are listed in Appendix E, Reserved words, on page 599. There
are six types of reserved words:
v Keywords
v Optional words
v Figurative constants
v Special character words
v Special object identifiers
v Special registers
Figurative constants
Figurative constants are reserved words that name and refer to specific constant
values. The reserved words for figurative constants and their meanings are listed
in this section.
Chapter 3. Character-strings 13
ZERO, ZEROS, ZEROES
Represents the numeric value zero (0) or one or more occurrences of the
character zero, depending on context.
When the figurative constant ZERO, ZEROS, or ZEROES is used in a
context that requires an alphanumeric character, an alphanumeric character
zero is used. When the context requires a national character zero, a
national character zero is used (value NX'0030'). When the context cannot
be determined, an alphanumeric character zero is used.
SPACE, SPACES
Represents one or more blanks or spaces. SPACE is treated as an
alphanumeric literal when used in a context that requires an alphanumeric
character, as a DBCS literal when used in a context that requires a DBCS
character, and as a national literal when used in a context that requires a
national character. The EBCDIC DBCS space character has the value
X'4040', and the national space character has the value NX'0020'.
HIGH-VALUE, HIGH-VALUES
Represents one or more occurrences of the character that has the highest
ordinal position in the collating sequence used.
HIGH-VALUE is treated as an alphanumeric literal in a context that
requires an alphanumeric character. For alphanumeric data with the
EBCDIC collating sequence, the value is X'FF'. For other alphanumeric
data, the value depends on the collating sequence in effect.
HIGH-VALUE is treated as a national literal when used in a context that
requires a national literal. The value is national character NX'FFFF'.
When the context cannot be determined, an alphanumeric context is
assumed and the value X'FF' is used.
Usage note: You should not use HIGH-VALUE (or a value assigned from
HIGH-VALUE) in a way that results in conversion between one data
representation and another. X'FF' does not represent a valid EBCDIC
character, and NX'FFFF' does not represent a valid national character.
Conversion of either the alphanumeric or the national HIGH-VALUE
representation to another representation results in a substitution character.
For example, conversion of X'FF' to UTF-16 would give a substitution
character, not NX'FFFF'.
LOW-VALUE, LOW-VALUES
Represents one or more occurrences of the character that has the lowest
ordinal position in the collating sequence used.
LOW-VALUE is treated as an alphanumeric literal in a context that requires
an alphanumeric character. For alphanumeric data with the EBCDIC
collating sequence, the value is X'00'. For other alphanumeric data, the
value depends on the collating sequence in effect.
LOW-VALUE is treated as a national literal when used in a context that
requires a national literal. The value is national character NX'0000'.
When the context cannot be determined, an alphanumeric context is
assumed and the value X'00' is used.
QUOTE, QUOTES
Represents one or more occurrences of:
v The quotation mark character ("), if the QUOTE compiler option is in
effect
When the rules of COBOL permit any one spelling of a figurative constant name,
any alternative spelling of that figurative constant name can be specified.
You can use a figurative constant wherever literal appears in a syntax diagram,
except where explicitly prohibited. When a numeric literal appears in a syntax
diagram, only the figurative constant ZERO (or ZEROS or ZEROES) can be used.
Figurative constants are not allowed as function arguments except in an arithmetic
expression, where the expression is an argument to a function.
Chapter 3. Character-strings 15
The length of a figurative constant depends on the context of its use. The following
rules apply:
v When a figurative constant is specified in a VALUE clause or associated with a
data item (for example, when it is moved to or compared with another item), the
length of the figurative constant character-string is equal to 1 or the number of
character positions in the associated data item, whichever is greater.
v When a figurative constant, other than the ALL literal, is not associated with
another data item (for example, in a CALL, INVOKE, STOP, STRING, or
UNSTRING statement), the length of the character-string is one character.
Special registers
Special registers are reserved words that name storage areas generated by the
compiler. Their primary use is to store information produced through specific
COBOL features. Each such storage area has a fixed name, and must not be
defined within the program.
For programs with the RECURSIVE attribute, for programs compiled with the
THREAD option, and for methods, storage for the following special registers is
allocated on a per-invocation basis:
| v ADDRESS OF
v RETURN-CODE
v SORT-CONTROL
v SORT-CORE-SIZE
v SORT-FILE-SIZE
v SORT-MESSAGE
v SORT-MODE-SIZE
v SORT-RETURN
v TALLY
v XML-CODE
v XML-EVENT
v XML-INFORMATION
v XML-NAMESPACE
v XML-NAMESPACE-PREFIX
v XML-NNAMESPACE
v XML-NNAMESPACE-PREFIX
v XML-NTEXT
v XML-TEXT
For the first call to a program after a cancel of that program, or for a method
invocation, the compiler initializes the special register fields to their initial values.
the following special registers are reset to their initial value on each program or
method entry:
Further, in the above four cases, values set in ADDRESS OF special registers persist
only for the span of the particular program or method invocation.
In all other cases, the special registers will not be reset; they will be unchanged
from the value contained on the previous CALL or INVOKE.
ADDRESS OF
The ADDRESS OF special register references the address of a data item in the
LINKAGE SECTION, the LOCAL-STORAGE SECTION, or the
WORKING-STORAGE SECTION.
For 01 and 77 level items in the LINKAGE SECTION, the ADDRESS OF special
register can be used as either a sending item or a receiving item. For all other
operands, the ADDRESS OF special register can be used only as a sending item.
DEBUG-ITEM
The DEBUG-ITEM special register provides information for a debugging
declarative procedure about the conditions that cause debugging section execution.
Chapter 3. Character-strings 17
02 DEBUG-SUB-2 PICTURE IS S9999 SIGN IS LEADING SEPARATE CHARACTER.
02 FILLER PICTURE IS X VALUE SPACE.
02 DEBUG-SUB-3 PICTURE IS S9999 SIGN IS LEADING SEPARATE CHARACTER.
02 FILLER PICTURE IS X VALUE SPACE.
02 DEBUG-CONTENTS PICTURE IS X(n).
Before each debugging section is executed, DEBUG-ITEM is filled with spaces. The
contents of the DEBUG-ITEM subfields are updated according to the rules for the
MOVE statement, with one exception: DEBUG-CONTENTS is updated as if the
move were an alphanumeric-to-alphanumeric elementary move without conversion
of data from one form of internal representation to another.
1. If this procedure is preceded by a section header, and control is passed through the section header, the statement
number refers to the section header.
For information about using JNIENVPTR and JNI callable services, see Accessing
JNI services in the Enterprise COBOL Programming Guide.
LENGTH OF
The LENGTH OF special register contains the number of bytes used by a data
item.
LENGTH OF creates an implicit special register that contains the current byte
length of the data item referenced by the identifier.
For data items described with usage DISPLAY-1 (DBCS data items) and data items
described with usage NATIONAL, each character occupies 2 bytes of storage.
If the data item referenced by the identifier contains the GLOBAL clause, the
LENGTH OF special register is a global data item.
The LENGTH OF special register can appear within either the starting character
position or the length expressions of a reference-modification specification.
However, the LENGTH OF special register cannot be applied to any operand that
is reference-modified.
Chapter 3. Character-strings 19
When a table element is specified, the LENGTH OF special register contains the
length in bytes of one occurrence. When referring to a table element, the element
name need not be subscripted.
A value is returned for any identifier whose length can be determined, even if the
area referenced by the identifier is currently not available to the program.
A separate LENGTH OF special register exists for each identifier referenced with
the LENGTH OF phrase. For example:
MOVE LENGTH OF A TO B
DISPLAY LENGTH OF A, A
ADD LENGTH OF A TO B
CALL "PROGX" USING BY REFERENCE A BY CONTENT LENGTH OF A
The intrinsic function LENGTH can also be used to obtain the length of a data
item. For data items of usage NATIONAL, the length returned by the LENGTH
function is the number of national character positions, rather than bytes; thus the
LENGTH OF special register and the LENGTH intrinsic function have different
results for data items of usage NATIONAL. For all other data items, the result is
the same.
LINAGE-COUNTER
A separate LINAGE-COUNTER special register is generated for each FD entry that
contains a LINAGE clause. When more than one is generated, you must qualify
each reference to a LINAGE-COUNTER with its related file-name.
The value in LINAGE-COUNTER at any given time is the line number at which
the device is positioned within the current page. LINAGE-COUNTER can be
referred to in PROCEDURE DIVISION statements; it must not be modified by
them.
If the file description entry for a sequential file contains the LINAGE clause and
the EXTERNAL clause, the LINAGE-COUNTER data item is an external data item.
If the file description entry for a sequential file contains the LINAGE clause and
the GLOBAL clause, the LINAGE-COUNTER data item is a global data item.
When used in nested programs, this special register is implicitly defined with the
GLOBAL clause in the outermost program.
The following examples show how to set the RETURN-CODE special register:
v COMPUTE RETURN-CODE = 8.
v MOVE 8 to RETURN-CODE.
The RETURN-CODE special register does not return a value from an invoked
method or from a program that uses CALL ... RETURNING. For more information,
see INVOKE statement on page 363 or CALL statement on page 309.
The RETURN-CODE special register does not return information from a service
call for a Language Environment callable service. For more information, see Using
Language Environment callable services in the Enterprise COBOL Programming Guide
and the Language Environment Programming Guide.
When used in nested programs, these special registers are implicitly defined with
the global attribute in the outermost program.
These special registers represent EBCDIC shift-out and shift-in control characters,
which are unprintable characters.
These special registers cannot be receiving items. SHIFT-OUT and SHIFT-IN cannot
be used in place of the keyboard control characters when you are defining DBCS
user-defined words or specifying EBCDIC DBCS literals.
Chapter 3. Character-strings 21
The following example shows how SHIFT-OUT and SHIFT-IN might be used:
DATA DIVISION.
WORKING-STORAGE.
01 DBCSGRP.
05 SO PIC X.
05 DBCSITEM PIC G(3) USAGE DISPLAY-1.
05 SI PIC X.
...
PROCEDURE DIVISION.
MOVE SHIFT-OUT TO SO
MOVE G"<D1D2D3>" TO DBCSITEM
MOVE SHIFT-IN TO SI
DISPLAY DBCSGRP
SORT-CONTROL
The SORT-CONTROL special register is the name of an alphanumeric data item.
When used in nested programs, this special register is implicitly defined with the
global attribute in the outermost program.
This register contains the ddname of the data set that holds the control statements
used to improve the performance of a sorting or merging operation.
You can provide a DD statement for the data set identified by the
SORT-CONTROL special register. Enterprise COBOL will attempt to open the data
set at execution time. Any error will be diagnosed with an informational message.
The sort control file takes precedence over the SORT special registers.
SORT-CORE-SIZE
The SORT-CORE-SIZE special register is the name of a binary data item that you
can use to specify the number of bytes of storage available to the sort utility.
When used in nested programs, this special register is implicitly defined with the
global attribute in the outermost program.
SORT-FILE-SIZE
The SORT-FILE-SIZE special register is the name of a binary data item that you can
use to specify the estimated number of records in the sort input file, file-name-1.
When used in nested programs, this special register is implicitly defined with the
global attribute in the outermost program.
SORT-MESSAGE
The SORT-MESSAGE special register is the name of an alphanumeric data item
that is available to both sort and merge programs.
When used in nested programs, this special register is implicitly defined with the
global attribute in the outermost program.
You can use the SORT-MESSAGE special register to specify the ddname of a data
set that the sort utility should use in place of the SYSOUT data set.
SORT-MODE-SIZE
The SORT-MODE-SIZE special register is the name of a binary data item that you
can use to specify the length of variable-length records that occur most frequently.
Chapter 3. Character-strings 23
| Restriction: The SORT-MODE-SIZE special register is not applicable to sorting a
| table with the format 2 SORT statement.
When used in nested programs, this special register is implicitly defined with the
global attribute in the outermost program.
SORT-RETURN
The SORT-RETURN special register is the name of a binary data item and is
available to both sort and merge programs.
When used in nested programs, this special register is implicitly defined with the
global attribute in the outermost program.
TALLY
The TALLY special register is the name of a binary data item.
When used in nested programs, this special register is implicitly defined with the
global attribute in the outermost program.
You can specify the TALLY special register in a function wherever an integer
argument is allowed.
When used in nested programs, this special register is implicitly defined with the
global attribute in the outermost program.
The compilation date and time can also be accessed with the intrinsic function
WHEN-COMPILED (see WHEN-COMPILED on page 534). That function
supports four-digit year values and provides additional information.
XML-CODE
The XML-CODE special register is used to communicate status between the XML
parser and the processing procedure that was identified in an XML PARSE
statement, and to indicate either that an XML GENERATE statement executed
successfully or that an exception occurred during XML generation.
When used in nested programs, this special register is implicitly defined with the
global attribute in the outermost program.
When the XML parser encounters an XML event, it sets XML-CODE and then
passes control to the processing procedure. For all events except an EXCEPTION
event, XML-CODE contains zero when the processing procedure receives control.
For an EXCEPTION event, the parser sets XML-CODE to an exception code that
indicates the nature of the exception. XML PARSE exception codes are discussed in
Handling XML PARSE exceptions in the Enterprise COBOL Programming Guide.
| For some XML events, you can set XML-CODE before returning to the parser to
| control subsequent processing of the document. For details, see XML-CODE in the
| Enterprise COBOL Programming Guide.
When the parser returns control to the XML PARSE statement, XML-CODE
contains the most recent value set by the processing procedure or the parser. In
some cases, the parser overrides the value set by the processing procedure.
Chapter 3. Character-strings 25
indicating that an exception occurred during XML generation. XML GENERATE
exception codes are detailed in XML GENERATE exceptions in the Enterprise COBOL
Programming Guide.
| RELATED CONCEPTS
| XML-CODE (Enterprise COBOL Programming Guide)
| RELATED TASKS
| Handling XML PARSE exceptions (Enterprise COBOL Programming Guide)
| RELATED REFERENCES
| XML GENERATE exceptions (Enterprise COBOL Programming Guide)
| XML-EVENT
The XML-EVENT special register communicates event information from the XML
parser to the processing procedure identified in the XML PARSE statement.
Before passing control to the processing procedure, the XML parser sets the
| XML-EVENT special register to the name of the XML event. The specific events
| and the associated special registers that are set depend on the setting of the
| XMLPARSE compiler option, XMLPARSE(XMLSS) or XMLPARSE(COMPAT).
The parser sets XML-NTEXT to associated XML text when the XML document is in
a national data item, and sets XML-TEXT when the XML document is in an
| alphanumeric data item. When the XMLPARSE(COMPAT) compiler option is in
| effect, the parser sets XML-NTEXT to the text of any numeric character reference
| (for events ATTRIBUTE-NATIONAL-CHARACTER and CONTENT-NATIONAL-
| CHARACTER) regardless of the type of the XML document data item.
| Table 3 on page 27 shows XML events and special register contents for parsing
| with the XMLPARSE(XMLSS) and XMLPARSE(COMPAT) options.
When used in nested programs, this special register is implicitly defined with the
global attribute in the outermost program.
Chapter 3. Character-strings 27
| Table 3. XML events and associated special register contents (continued)
| XML-EVENT XMLPARSE(XMLSS)1 XMLPARSE(COMPAT)1
| CONTENT-CHARACTERS XML-TEXT or XML-NTEXT contains XML-TEXT or XML-NTEXT
| the character content of the element contains the character content of
| between start and end tags. This can be the element between start and
| a substring of the content. end tags. This can be a substring
| of the character content if the
| content includes a character
| reference or an entity reference.
| CONTENT-NATIONAL-CHARACTER Regardless of the type of the XML XML-TEXT or XML-NTEXT
| document, XML-TEXT is empty with content is the same as for
| length zero and XML-NTEXT contains XMLPARSE(XMLSS).
| the single national character that
| corresponds with the numeric character
| reference.2
| DOCUMENT-TYPE-DECLARATION XML-TEXT or XML-NTEXT contains XML-TEXT or XML-NTEXT
| the name of the root element, as contains the entire document type
| specified in the document type declaration, including the
| delcaration. opening and closing character
| sequences "<!DOCTYPE" and ">".
| ENCODING-DECLARATION XML-TEXT or XML-NTEXT contains XML-TEXT or XML-NTEXT
| the value, between quotation marks or content is the same as for
| apostrophes, of the encoding XMLPARSE(XMLSS).
| declaration in the XML declaration.
| END-OF-CDATA-SECTION All XML special registers except XML-TEXT or XML-NTEXT
| XML-CODE and XML-EVENT are contains the string "]]>".
| empty with length zero.
| END-OF-DOCUMENT All XML special registers except XML-TEXT or XML-NTEXT
| XML-CODE and XML-EVENT are content is the same as for
| empty with length zero. XMLPARSE(XMLSS).
| END-OF-ELEMENT XML-TEXT or XML-NTEXT contains XML-TEXT or XML-NTEXT
| the local part of the end element tag or contains the name of the end
| empty element tag name. element tag or empty element
| tag.
| If the element name is in a nondefault
| namespace, XML-NAMESPACE or
| XML-NNAMESPACE contains the
| namespace identifier.
| XML-NAMESPACE-PREFIX or
| XML-NNAMESPACE-PREFIX contains
| the prefix if the namespace declaration
| is of the form xmlns:prefix =
| "namespace-identifier"; otherwise, if the
| declaration is for the default
| namespace and thus the attribute name
| is xmlns, XML-NAMESPACE-PREFIX
| and XML-NNAMESPACE-PREFIX are
| both empty with length zero.
| PROCESSING-INSTRUCTION-DATA XML-TEXT or XML-NTEXT contains XML-TEXT or XML-NTEXT
| the rest of the processing instruction always contains the complete
| (after the target name), not including processing instruction data.
| the closing sequence "?>", but including
| trailing, and not leading, white space
| characters. This can be a substring of
| the processing instruction data.
| PROCESSING-INSTRUCTION- XML-TEXT or XML-NTEXT contains XML-TEXT or XML-NTEXT
| TARGET the processing instruction target name, content is the same as for
| which occurs immediately after the XMLPARSE(XMLSS). This event
| processing instruction opening occurs only once for a given
| sequence, "<?". This event can occur processing instruction.
| multiple times for a given processing
| instruction: one occurrence preceding
| each substring of the data.
| STANDALONE-DECLARATION XML-TEXT or XML-NTEXT contains XML-TEXT or XML-NTEXT
| the value, between quotation marks or content is the same as for
| apostrophes ("yes" or "no"), of the XMLPARSE(XMLSS).
| stand-alone declaration in the XML
| declaration.
| START-OF-CDATA-SECTION All XML special registers except XML-TEXT or XML-NTEXT
| XML-CODE and XML-EVENT are contains the string "<![CDATA[".
| empty with length zero.
Chapter 3. Character-strings 29
| Table 3. XML events and associated special register contents (continued)
| XML-EVENT XMLPARSE(XMLSS)1 XMLPARSE(COMPAT)1
| START-OF-DOCUMENT All XML special registers except XML-TEXT or XML-NTEXT
| XML-CODE and XML-EVENT are contains the entire document.
| empty with length zero.
| START-OF-ELEMENT XML-TEXT or XML-NTEXT contains XML-TEXT or XML-NTEXT
| the local part of the start element tag contains the name of the start
| name or the local part of the empty element tag or empty element
| element tag name. tag, also known as the element
| type.
| If the element name is in a namespace,
| XML-NAMESPACE or
| XML-NNAMESPACE contains the
| namespace identifier.
| 1. For all events except EXCEPTION, XML-CODE contains zero. Unless stated otherwise, the namespace XML
| registers (XML-NAMESPACE, XML-NNAMESPACE, XML-NAMESPACE-PREFIX, and XML-NNAMESPACE-
| PREFIX) are empty and have length zero.
| 2. National characters with scalar values greater than 65,535 (NX"FFFF") are represented using two encoding units
| (a "surrogate pair"). Programmers are responsible for ensuring that operations on the content of XML-NTEXT do
| not split the pair of encoding units that together form a graphic character, thereby forming invalid data.
| 3. For XMLPARSE(COMPAT), exceptions for encoding conflicts are signaled before parsing begins. For these
| exceptions, XML-TEXT or XML-NTEXT is either zero length or contains only the encoding declaration value
| from the document. See XML PARSE exceptions with XMLPARSE(COMPAT) in effect in the Enterprise COBOL
| Programming Guide for information about XML exception codes.
| 4. If an END-OF-INPUT XML event previously occurred and the processing procedure provided a new document
| segment, XML-TEXT or XML-NTEXT contains only the new segment.
| If the anomaly occurs before parsing begins (for example, the encoding specification is invalid), XML-TEXT or
| XML-NTEXT are empty with length zero.
| The fragment might or might not include the anomaly. For a duplicate attribute name, for example, the fragment
| includes the incorrect attribute. For an invalid character, the fragment includes document text up to, but not
| including, the invalid character.
| 5. n/a. Not applicable; occurs only with XMLPARSE(COMPAT).
| 6. n/a. Not applicable; occurs only wtih XMLPARSE(XMLSS).
Unresolved References:
XML-INFORMATION
The XML-INFORMATION special register is used to provide additional
information to an XML PARSE processing procedure about the status of the parse.
Chapter 3. Character-strings 31
application must concatenate the pieces of content together. The
XML-INFORMATION register is used to indicate whether or not content of the
XML event is complete.
The value of the XML-INFORMATION register is set as follows for the various
XML events:
v ATTRIBUTE-CHARACTERS
1 indicates that the attribute value in XML-TEXT or XML-NTEXT special
register is complete
2 indicates that the attribute value in XML-TEXT or XML-NTEXT special
register is not complete
4, 8, 16, ... are reserved for future use
v CONTENT-CHARACTERS
1 indicates that the content value in XML-TEXT or XML-NTEXT special
register is complete
2 indicates that the content value in XML-TEXT or XML-NTEXT special
register is not complete
4, 8, 16, ... are reserved for future use
v All other events
0 indicates that no additional information is currently available
2, 4, 8, 16, ... are reserved for future use
XML-NAMESPACE
The XML-NAMESPACE special register is defined during XML parsing to contain
the identifier of the namespace, if any, associated with the name in XML-TEXT for
XML events START-OF-ELEMENT, END-OF-ELEMENT, and ATTRIBUTE-NAME,
and to contain the declared namespace identifier for XML event
NAMESPACE-DECLARATION.
When used in nested programs, this special register is implicitly defined with the
global attribute in the outermost program.
Use the LENGTH function or the LENGTH OF special register to determine the
number of bytes that XML-NAMESPACE contains.
XML-NNAMESPACE
The XML-NNAMESPACE special register is defined during XML parsing to
contain the identifier of the namespace, if any, associated with the name in
XML-NTEXT for XML events START-OF-ELEMENT, END-OF-ELEMENT, and
ATTRIBUTE-NAME, and to contain the declared namespace identifier for XML
event NAMESPACE-DECLARATION.
When used in nested programs, this special register is implicitly defined with the
global attribute in the outermost program.
Use the LENGTH function to determine the number of national character positions
that XML-NNAMESPACE contains; use the LENGTH OF special register to
determine the number of bytes.
XML-NAMESPACE-PREFIX
The XML-NAMESPACE-PREFIX special register is defined during XML parsing to
contain the prefix, if any, of the name in XML-TEXT for XML events
Chapter 3. Character-strings 33
START-OF-ELEMENT, END-OF-ELEMENT, and ATTRIBUTE-NAME, and to
contain the local attribute name for XML event NAMESPACE-DECLARATION.
The namespace prefix is used as an alias for the complete namespace identifier.
When used in nested programs, this special register is implicitly defined with the
global attribute in the outermost program.
Use the LENGTH function or the LENGTH OF special register to determine the
number of bytes that XML-NAMESPACE-PREFIX contains.
XML-NNAMESPACE-PREFIX
The XML-NNAMESPACE-PREFIX special register is defined during XML parsing
to contain the prefix, if any, of the name in XML-NTEXT for XML events
START-OF-ELEMENT, END-OF-ELEMENT, and ATTRIBUTE-NAME, and to
contain the local attribute name for XML event NAMESPACE-DECLARATION.
The namespace prefix is used as an alias for the complete namespace identifier.
When used in nested programs, this special register is implicitly defined with the
global attribute in the outermost program.
Use the LENGTH function to determine the number of national character positions
that XML-NNAMESPACE contains; use the LENGTH OF special register to
determine the number of bytes.
XML-NTEXT
The XML-NTEXT special register is defined during XML parsing to contain
document fragments that are represented in usage NATIONAL.
When used in nested programs, this special register is implicitly defined with the
global attribute in the outermost program.
The parser sets XML-NTEXT to the document fragment associated with an event
before transferring control to the processing procedure in these cases:
v When the operand of the XML PARSE statement is a data item of category
national or the RETURNING NATIONAL phrase is specified in the XML PARSE
statement
v For the ATTRIBUTE-NATIONAL-CHARACTER event
v For the CONTENT-NATIONAL-CHARACTER event
When XML-NTEXT is set, the XML-TEXT special register has a length of zero. At
any given time, only one of the two special registers XML-NTEXT and XML-TEXT
has a nonzero length.
Chapter 3. Character-strings 35
Use the LENGTH function to determine the number of national characters that
XML-NTEXT contains. Use the LENGTH OF special register to determine the
number of bytes, rather than the number of national characters, that XML-NTEXT
contains.
XML-TEXT
The XML-TEXT special register is defined during XML parsing to contain
document fragments that are represented in usage DISPLAY.
When used in nested programs, this special register is implicitly defined with the
global attribute in the outermost program.
The parser sets XML-TEXT to the document fragment associated with an event
before transferring control to the processing procedure when the operand of the
XML PARSE statement is an alphanumeric data item and the RETURNING
NATIONAL phrase is not specified in the XML PARSE statement, except for the
ATTRIBUTE-NATIONAL-CHARACTER event and the CONTENT-NATIONAL-
CHARACTER event.
When XML-TEXT is set, the XML-NTEXT special register has a length of zero. At
any given time, only one of the two special registers XML-NTEXT and XML-TEXT
has a nonzero length.
Use the LENGTH function or the LENGTH OF special register for XML-TEXT to
determine the number of bytes that XML-TEXT contains.
Literals
A literal is a character-string whose value is specified either by the characters of
which it is composed or by the use of a figurative constant.
For descriptions of the different types of literals, see the following topics:
v Alphanumeric literals
v DBCS literals on page 41
v National literals on page 42
v Numeric literals on page 40
Alphanumeric literals
Enterprise COBOL provides several formats of alphanumeric literals.
"single-byte-characters"
single-byte-characters
The enclosing quotation marks or apostrophes are excluded from the literal when
the program is compiled.
The delimiter character used as the opening delimiter for a literal must be used as
the closing delimiter for that literal. For example:
THIS IS RIGHT
"THIS IS RIGHT"
THIS IS WRONG"
You can use apostrophes or quotation marks as the literal delimiters independent
of the APOST/QUOTE compiler option.
Any punctuation characters included within an alphanumeric literal are part of the
value of the literal.
The maximum length of an alphanumeric literal is 160 bytes. The minimum length
is 1 byte.
Alphanumeric literals are in the alphanumeric data class and category. (Data
classes and categories are described in Classes and categories of data on page
164.)
Chapter 3. Character-strings 37
Format 2: Alphanumeric literals with DBCS characters
"mixed-SBCS-and-DBCS-characters"
mixed-SBCS-and-DBCS-characters
" or The opening and closing delimiter. The closing delimiter must match the
opening delimiter.
mixed-SBCS-and-DBCS-characters
Any mix of single-byte and DBCS characters.
Shift-out and shift-in control characters are part of the literal and must be
paired. They must contain zero or an even number of intervening bytes.
Nested shift codes are not allowed in the DBCS portion of the literal.
The syntax rules for single-byte characters in the literal follow the rules for
basic alphanumeric literals. The syntax rules for DBCS characters in the
literal follow the rules for DBCS literals.
The move and comparison rules for alphanumeric literals with DBCS characters
are the same as those for any alphanumeric literal.
The length of an alphanumeric literal with DBCS characters is its byte length,
including the shift control characters. The maximum length is limited by the
available space on one line in Area B. An alphanumeric literal with DBCS
characters cannot be continued.
X"hexadecimal-digits"
Xhexadecimal-digits
X" or X
The opening delimiter for the hexadecimal notation of an alphanumeric
literal.
" or The closing delimiter for the hexadecimal notation of an alphanumeric
literal. If a quotation mark is used in the opening delimiter, a quotation
mark must be used as the closing delimiter. Similarly, if an apostrophe is
used in the opening delimiter, an apostrophe must be used as the closing
delimiter.
Hexadecimal digits are characters in the range '0' to '9', 'a' to 'f', and 'A' to 'F',
inclusive. Two hexadecimal digits represent one character in a single-byte character
set (EBCDIC or ASCII). Four hexadecimal digits represent one character in a DBCS
character set. A string of EBCDIC DBCS characters represented in hexadecimal
notation must be preceded by the hexadecimal representation of a shift-out control
character (X'0E') and followed by the hexadecimal representation of a shift-in
control character (X'0F'). An even number of hexadecimal digits must be specified.
The maximum length of a hexadecimal literal is 320 hexadecimal digits.
The continuation rules are the same as those for any alphanumeric literal. The
opening delimiter (X" or X) cannot be split across lines.
The DBCS compiler option has no effect on the processing of hexadecimal notation
of alphanumeric literals.
Chapter 3. Character-strings 39
Z" or Z
The opening delimiter for a null-terminated alphanumeric literal. Both
characters of the opening delimiter (Z" or Z) must be on the same source
line.
" or The closing delimiter for a null-terminated alphanumeric literal.
If a quotation mark is used in the opening delimiter, a quotation mark
must be used as the closing delimiter. Similarly, if an apostrophe is used in
the opening delimiter, an apostrophe must be used as the closing delimiter.
mixed-characters
Can be any of the following characters:
v Solely single-byte characters
v Mixed single-byte and DBCS characters
v Solely DBCS characters
However, you cannot specify the single-byte character with the value X'00'.
X'00' is the null character automatically appended to the end of the literal.
The content of the literal is otherwise subject to the same rules and
restrictions as an alphanumeric literal with DBCS characters (format 2).
The length of the string of characters in the literal content can be 0 to 159 bytes.
The actual length of the literal includes the terminating null character, and is a
maximum of 160 bytes.
Numeric literals
A numeric literal is a character-string whose characters are selected from the digits 0
through 9, a sign character (+ or -), and the decimal point.
If the literal contains no decimal point, it is an integer. (In this documentation, the
word integer appearing in a format represents a numeric literal of nonzero value
that contains no sign and no decimal point, except when other rules are included
with the description of the format.) The following rules apply:
v If the ARITH(COMPAT) compiler option is in effect, one through 18 digits are
allowed. If the ARITH(EXTEND) compiler option is in effect, one through 31
digits are allowed.
v Only one sign character is allowed. If included, it must be the leftmost character
of the literal. If the literal is unsigned, it is a positive value.
v Only one decimal point is allowed. If a decimal point is included, it is treated as
an assumed decimal point (that is, as not taking up a character position in the
literal). The decimal point can appear anywhere within the literal except as the
rightmost character.
The value of a numeric literal is the algebraic quantity expressed by the characters
in the literal. The size of a numeric literal is equal to the number of digits specified
by the user.
Numeric literals are in the numeric data class and category. (Data classes and
categories are described under Classes and categories of data on page 164.)
The format and rules for floating-point literals are listed below.
Format
mantissa E exponent
+ +
- -
v The sign is optional before the mantissa and the exponent; if you omit the sign,
the compiler assumes a positive number.
v The mantissa can contain between one and 16 digits. A decimal point must be
included in the mantissa.
v The exponent is represented by an E followed by an optional sign and one or
two digits.
v The magnitude of a floating-point literal value must fall between 0.54E-78 and
0.72E+76. For values outside of this range, an E-level diagnostic message is
produced and the value is replaced by either 0 or 0.72E+76, respectively.
DBCS literals
The formats and rules for DBCS literals are listed in this section.
G"<DBCS-characters>"
G<DBCS-characters>
N"<DBCS-characters>"
N<DBCS-characters>
G", G, N", or N
Opening delimiters.
N" and N identify a DBCS literal when the NSYMBOL(DBCS) compiler
option is in effect. They identify a national literal when the
NSYMBOL(NATIONAL) compiler option is in effect, and the rules
specified in National literals on page 42 apply.
The opening delimiter must be followed immediately by a shift-out control
character.
For literals with opening delimiter N" or N, when embedded quotes or
apostrophes are specified as part of DBCS characters in a DBCS literal, a
single embedded DBCS quote or apostrophe is represented by two DBCS
quotes or apostrophes. If a single embedded DBCS quote or apostrophe is
found, an E-level compiler message will be issued and a second embedded
DBCS quote or apostrophe will be assumed.
< Represents the shift-out control character (X'0E')
Chapter 3. Character-strings 41
> Represents the shift-in control character (X'0F')
" or The closing delimiter. If a quotation mark is used in the opening delimiter,
a quotation mark must be used as the closing delimiter. Similarly, if an
apostrophe is used in the opening delimiter, an apostrophe must be used
as the closing delimiter.
The closing delimiter must appear immediately after the shift-in control
character.
DBCS-characters
DBCS-characters can be one or more characters in the range of X'00'
through X'FF' for either byte. Any value will be accepted in the content of
the literal, although whether it is a valid value at run time depends on the
CCSID in effect for the CODEPAGE compiler option.
Maximum length
28 characters
Continuation rules
Cannot be continued across lines
National literals
The national literal formats that Enterprise COBOL provides are Basic national
literals and Hexadecimal notation for national literals.
For more information about the formats, see Basic national literals on page 43
and Hexadecimal notation for national literals on page 44.
N"character-data"
Ncharacter-data
When the NSYMBOL(DBCS) compiler option is in effect, the opening delimiter N"
or N identifies a DBCS literal, and the rules specified in DBCS literals on page
41 apply.
N" or N
Opening delimiters. The opening delimiter must be coded as single-byte
characters. It cannot be split across lines.
" or The closing delimiter. The closing delimiter must be coded as a single-byte
character. If a quotation mark is used in the opening delimiter, it must be
used as the closing delimiter. Similarly, if an apostrophe is used in the
opening delimiter, it must be used as the closing delimiter.
To include the quotation mark or apostrophe used in the opening delimiter
in the content of the literal, specify a pair of quotation marks or
apostrophes, respectively. Examples:
NThis literals content includes an apostrophe
NThis literal includes ", which is not used in the opening delimiter
N"This literal includes "", which is used in the opening delimiter"
character-data
The source text representation of the content of the national literal.
character-data can include any combination of EBCDIC single-byte
characters and double-byte characters encoded in the Coded Character Set
ID (CCSID) specified by the CODEPAGE compiler option.
DBCS characters in the content of the literal must be delimited by shift-out
and shift-in control characters.
Maximum length
The maximum length of a national literal is 80 character positions,
excluding the opening and closing delimiters. If the source content of the
literal contains one or more DBCS characters, the maximum length is
limited by the available space in Area B of a single source line.
The literal must contain at least one character. Each single-byte character in
the literal counts as one character position and each DBCS character in the
literal counts as one character position. Shift-in and shift-out delimiters for
DBCS characters are not counted.
Continuation rules
When the content of the literal includes DBCS characters, the literal cannot
be continued. When the content of the literal does not include DBCS
characters, normal continuation rules apply.
Chapter 3. Character-strings 43
Hexadecimal notation for national literals
The format and rules for the hexadecimal notation format of national literals are
listed in this section.
NX"hexadecimal-digits"
NXhexadecimal-digits
A national literal in hexadecimal notation has data class and category national and
can be used anywhere that a basic national literal can be used.
A national literal can be used only as specified in the detailed rules in this
document.
PICTURE character-strings
A PICTURE character-string is composed of the currency symbol and certain
combinations of characters in the COBOL character set. PICTURE character-strings
are delimited only by the separator space, separator comma, separator semicolon,
or separator period.
Comments
A comment is a character-string that can contain any combination of characters from
the character set of the computer.
It has no effect on the execution of the program. There are three forms of
comments:
Comment entry (IDENTIFICATION DIVISION)
This form is described under Optional paragraphs on page 107.
Comment line (any division)
This form is described under Comment lines on page 58.
Inline comments (any division)
An inline comment is identified by a floating comment indicator (*>)
preceded by one or more character-strings in the program-text area, and
can be written on any line of a compilation group. All characters that
follow the floating comment indicator up to the end of area B are comment
text.
Chapter 3. Character-strings 45
Character-strings that form comments can contain DBCS characters or a
combination of DBCS and single-byte EBCDIC characters.
Multiple comment lines that contain DBCS strings are allowed. The embedding of
DBCS characters in a comment line must be done on a line-by-line basis. Words
containing those characters cannot be continued to a following line. No syntax
checking for valid strings is provided in comment lines.
1. b represents a blank.
2. N" and N are the opening delimiter for a DBCS literal when the NSYMBOL(DBCS)
compiler option is in effect.
Chapter 4. Separators 49
50 Enterprise COBOL for z/OS, V5.2 Language Reference
Chapter 5. Sections and paragraphs
Sections and paragraphs define a program. Sections and paragraphs are
subdivided into sentences, statements, and entries.
Sentences are subdivided into statements, and statements are subdivided into
phrases. Entries are subdivided into clauses.
For more information about sections, paragraphs, and statements, see Procedures
on page 256.
Clauses
A clause is an ordered set of consecutive COBOL character-strings that specifies an
attribute of an entry. Clauses are constructed in the identification, environment,
and data divisions.
Sentences
A sentence is a sequence of one or more statements that ends with a separator
period. Sentences are constructed in the PROCEDURE DIVISION.
Statements
A statement specifies an action to be taken by the program. Statements are
constructed in the PROCEDURE DIVISION.
Phrases
Each clause or statement in a program can be subdivided into smaller units called
phrases.
1 2 3 4 5 6 7 8 9 10 11 12 13 ... 71 72
Indicator area
Use the indicator area to specify the continuation of words or alphanumeric literals
from the previous line onto the current line, the treatment of text as
documentation, and debugging lines.
See Continuation lines on page 56, Comment lines on page 58, and
Debugging lines on page 59.
The indicator area can be used for source listing formatting. A slash (/) placed in
the indicator column causes the compiler to start a new page for the source listing,
and the corresponding source record to be treated as a comment. The effect can be
dependent on the LINECOUNT compiler option. For information about the
LINECOUNT compiler option, see LINECOUNT in the Enterprise COBOL
Programming Guide.
Division headers
A division header is a combination of words, followed by a separator period to
indicate the beginning of a division.
Section headers
In the environment and procedure divisions, a section header indicates the
beginning of a series of paragraphs.
For example:
INPUT-OUTPUT SECTION.
In the DATA DIVISION, a section header indicates the beginning of an entry; for
example:
FILE SECTION.
LINKAGE SECTION.
LOCAL-STORAGE SECTION.
WORKING-STORAGE SECTION.
A level indicator must begin in Area A and be followed by a space. (See FILE
SECTION on page 176.) A level-number that must begin in Area A is a one- or
two-digit integer with a value of 01 or 77. It must be followed by a space or
separator period.
For example:
END PROGRAM program-name.
END CLASS class-name.
END METHOD "method-name".
END OBJECT.
END FACTORY.
For programs
program-name must be identical to the program-name of the corresponding
PROGRAM-ID paragraph. Every COBOL program, except an outermost
program that contains no nested programs and is not followed by another
batch program, must end with an END PROGRAM marker.
For classes
class-name must be identical to the class-name in the corresponding
CLASS-ID paragraph.
For methods
method-name must be identical to the method-name in the corresponding
METHOD-ID paragraph.
For object paragraphs
There is no name in an object paragraph header or in its end marker. The
syntax is simply END OBJECT.
For factory paragraphs
There is no name in a factory paragraph header or in its end marker. The
syntax is simply END FACTORY.
Within an entry or sentence, successive lines in Area B can have the same format
or can be indented to clarify program logic. The output listing is indented only if
the input statements are indented. Indentation does not affect the meaning of the
program. The programmer can choose the amount of indentation, subject only to
the restrictions on the width of Area B. See also Chapter 5, Sections and
paragraphs, on page 51.
Continuation lines
Any sentence, entry, clause, or phrase that requires more than one line can be
continued in Area B of the next line that is neither a comment line nor a blank line.
The line being continued is a continued line; the succeeding lines are continuation
lines. Area A of a continuation line must be blank.
If there is no hyphen (-) in the indicator area (column 7) of a line, the last character
of the preceding line is assumed to be followed by a space.
All characters that make up an opening literal delimiter must be on the same line.
For example, Z", G", N", NX", or X".
Both characters that make up the pseudo-text delimiter separator "==" must be on
the same line.
If there is a hyphen in the indicator area of a line, the first nonblank character of
the continuation line immediately follows the last nonblank character of the
continued line without an intervening space.
Alphanumeric and national literals can be continued only when there are no DBCS
characters in the content of the literal.
The following rules apply to alphanumeric and national literals that do not contain
DBCS characters:
v If the continued line contains an alphanumeric or national literal without a
closing quotation mark, all spaces at the end of the continued line (through
column 72) are considered to be part of the literal. The continuation line must
contain a hyphen in the indicator area, and the first nonblank character must be
a quotation mark. The continuation of the literal begins with the character
immediately following the quotation mark.
v If an alphanumeric or national literal that is to be continued on the next line has
as its last character a quotation mark in column 72, the continuation line must
start with two consecutive quotation marks. This will result in a single quotation
mark as part of the value of the literal.
If the last character on the continued line of an alphanumeric or national literal
is a single quotation mark in Area B, the continuation line can start with a single
quotation mark. This will result in two consecutive literals instead of one
continued literal.
The rules are the same when an apostrophe is used instead of a quotation mark in
delimiters.
If you want to continue a literal such that the continued lines and the continuation
lines are part of one literal:
v Code a hyphen in the indicator area of each continuation line.
v Code the literal value using all columns of each continued line, up to and
including column 72. (Do not terminate the continued lines with a single
quotation mark followed by a space.)
v Code a quotation mark before the first character of the literal on each
continuation line.
v Terminate the last continuation line with a single quotation mark followed by a
space.
In the following examples, the number and size of literals created are indicated
below the example:
|...+.*..1....+....2....+....3....+....4....+....5....+....6....+....7..
000001 "AAAAAAAAAABBBBBBBBBBCCCCCCCCCCDDDDDDDDDDEEEEEEEEEE
- "GGGGGGGGGGHHHHHHHHHHIIIIIIIIIIJJJJJJJJJJKKKKKKKKKK
- "LLLLLLLLLLMMMMMMMMMM"
v Literal 000001 is interpreted as one alphanumeric literal that is 120 bytes long.
Each character between the starting quotation mark and up to and including
column 72 of continued lines is counted as part of the literal.
|...+.*..1....+....2....+....3....+....4....+....5....+....6....+....7..
000003 N"AAAAAAAAAABBBBBBBBBBCCCCCCCCCCDDDDDDDDDDEEEEEEEEEE
- "GGGGGGGGGG"
v Literal 000003 is interpreted as one national literal that is 60 national character
positions in length (120 bytes). Each character between the starting quotation
mark and the ending quotation mark on the continued line is counted as part of
the literal. Although single-byte characters are entered, the value of the literals is
stored as national characters.
To code a continued literal where the length of each continued part of the literal is
less than the length of Area B, adjust the starting column such that the last
character of the continued part is in column 72.
Area A or Area B
Certain items can begin in either Area A or Area B.
Level-numbers
A level-number that can begin in Area A or B is a one- or two-digit integer with a
value of 02 through 49, 66, or 88.
Comment lines
A comment line is any line with an asterisk (*) or slash (/) in the indicator area
(column 7) of the line, or with a floating comment indicator (*>) as the first
character-string in the program text area (Area A plus Area B).
The comment can be written anywhere in the program text area of that line, and
can consist of any combination of characters from the character set of the
computer.
Multiple comment lines are allowed. Each must begin with an asterisk (*) or a
slash (/) in the indicator area, or with a floating comment indicator (*>).
For more information about floating comment indicators, see Floating comment
indicators (*>).
An asterisk (*) comment line is printed on the next available line in the output
listing. The effect can be dependent on the LINECOUNT compiler option. For
information about the LINECOUNT compiler option, see LINECOUNT in the
Enterprise COBOL Programming Guide. A slash (/) comment line is printed on the
first line of the next page, and the current page of the output listing is ejected.
The compiler treats a comment line as documentation, and does not check it
syntactically.
Compiler-directing statements
Most compiler-directing statements, including COPY and REPLACE, can start in
either Area A or Area B.
| Compiler directives
| Compiler directives must start in Area B.
Debugging lines
A debugging line is any line with a D (or d) in the indicator area of the line.
Pseudo-text
The character-strings and separators that comprise pseudo-text can start in either
Area A or Area B.
If, however, there is a hyphen in the indicator area (column 7) of a line that follows
the opening pseudo-text delimiter, Area A of the line must be blank, and the rules
for continuation lines apply to the formation of text words. See Continuation
lines on page 56 for details.
Blank lines
A blank line contains nothing but spaces in column 7 through column 72. A blank
line can be anywhere in a program.
The sections below define the types of names in COBOL and explain where the
names can be referenced:
v Types of names
v External and internal resources on page 63
v Resolution of names on page 64
Types of names
In addition to identifying a resource, a name can have global or local attributes.
Some names are always global, some names are always local, and some names are
either local or global depending on specifications in the program in which the
names are defined.
For programs
A global name can be used to refer to the resource with which it is
associated both:
v From within the program in which the global name is defined
v From within any other program that is contained in the program that
defines the global name
Use the GLOBAL clause in the data description entry to indicate that a
name is global. For more information about using the GLOBAL clause, see
GLOBAL clause on page 177.
A local name can be used only to refer to the resource with which it is
associated from within the program in which the local name is defined.
By default, if a data-name, a file-name, a record-name, or a condition-name
definition in a data description entry does not include the GLOBAL clause,
the name is local.
For methods
All names defined in methods are implicitly local.
For classes
Names defined in a class definition are global to all the methods contained
in that class definition.
For object paragraphs
Names defined in the DATA DIVISION of an object paragraph are global
to the methods contained in that object paragraph.
For factory paragraphs
Names defined in the DATA DIVISION of a factory paragraph are global
to the methods contained in that factory paragraph.
Restriction: Specific rules sometimes prohibit specifying the GLOBAL clause for
certain data description, file description, or record description entries.
A data item or file connector is external if the storage associated with that resource
is associated with the run unit rather than with any particular program or method
within the run unit. An external resource can be referenced by any program or
method in the run unit that describes the resource. References to an external
resource from different programs or methods using separate descriptions of the
resource are always to the same resource. In a run unit, there is only one
representation of an external resource.
A resource is internal if the storage associated with that resource is associated only
with the program or method that describes the resource.
External and internal resources can have either global or local names.
Two programs or methods in a run unit can reference the same file connector in
the following circumstances:
v An external file connector can be referenced from any program or method that
describes that file connector.
v If a program is contained within another program, both programs can refer to a
global file connector by referring to an associated global file-name either in the
containing program or in any program that directly or indirectly contains the
containing program.
Two programs or methods in a run unit can reference common data in the
following circumstances:
v The data content of an external data record can be referenced from any program
or method provided that program or method has described that data record.
v If a program is contained within another program, both programs can refer to
data that possesses the global attribute either in the program or in any program
that directly or indirectly contains the containing program.
The data records described as subordinate to a file description entry that does not
contain the EXTERNAL clause or to a sort-merge file description entry, as well as
any data items described subordinate to the data description entries for such
records, are always internal to the program or method that describes the file-name.
If the EXTERNAL clause is included in the file description entry, the data records
and the data items attain the external attribute.
Resolution of names
The rules for resolution of names depend on whether the names are specified in a
program or in a class definition.
Within a class definition, resources can be defined within the following units:
v The factory data division
v The object data division
v A method data division
If a resource is defined within a method, any reference within the method to that
resource name is always a reference to the resource in the method.
The normal rules for qualification and uniqueness of reference apply when the
same name is associated with more than one resource within a given method data
division, object data division, or factory data division.
For more information about rules for qualification, and for explicit and implicit
data references, see the following topics:
v Uniqueness of reference
v Data attribute specification on page 80
Uniqueness of reference
Every user-defined name in a COBOL program is assigned by the user to name a
resource for solving a data processing problem. To use a resource, a statement in a
COBOL program must contain a reference that uniquely identifies that resource.
When the same name has been assigned in separate programs to two or more
occurrences of a resource of a given type, and when qualification by itself does not
allow the references in one of those programs to differentiate between the
identically named resources, then certain conventions that limit the scope of names
apply. The conventions ensure that the resource identified is that described in the
program containing the reference. For more information about resolving
program-names, see Resolution of names on page 64.
Unless otherwise specified by the rules for a statement, any subscripts and
reference modification are evaluated only once as the first step in executing that
statement.
Qualification
A name that exists within a hierarchy of names can be made unique by specifying
one or more higher-level names in the hierarchy. The higher-level names are called
qualifiers, and the process by which such names are made unique is called
qualification.
| If there is only one 01 level with a given name, that name can be referenced even if
| it is not unique when the QUALIFY(EXTEND) option is in effect.
Qualification rules
Identical names
When programs are directly or indirectly contained within other programs, each
program can use identical user-defined words to name resources.
A program references the resources that program describes rather than the
same-named resources described in another program, even if the names are
different types of user-defined words.
Format
text-name-1
IN library-name-1
OF
For rules on referencing COPY libraries, see COPY statement on page 542.
paragraph-name-1
IN section-name-1
OF
Format 2
section-name-1
The most basic method of referencing data items in a COBOL program is simple
data reference, which is data-name-1 without qualification, subscripting, or reference
modification. Simple data reference is used to reference a single elementary or
group item.
Format
data-name-1
data-name-1
Can be any data description entry.
data-name-1 must be unique in a program.
Chapter 8. Referencing data names, copy libraries, and PROCEDURE DIVISION names 69
Identifiers
When used in a syntax diagram in this information, the term identifier refers to a
valid combination of a data-name or function-identifier with its qualifiers,
subscripts, and reference-modifiers as required for uniqueness of reference.
Rules for identifiers associated with a format can however specifically prohibit
qualification, subscripting, or reference modification.
The term data-name refers to a name that must not be qualified, subscripted, or
reference modified unless specifically permitted by the rules for the format.
v For a description of qualification, see Qualification on page 67.
v For a description of subscripting, see Subscripting on page 73.
v For a description of reference modification, see Reference modification on
page 76.
Format 1
data-name-1
IN data-name-2 IN file-name-1
OF OF
( subscript )
( leftmost-character-position : )
length
data-name-1 , data-name-2
Can be a record-name.
file-name-1
Must be identified by an FD or SD entry in the DATA DIVISION.
file-name-1 must be unique within this program.
condition-name-1
data-name-1 IN data-name-2
OF
IN file-name-1
OF
Format 3
LINAGE-COUNTER
IN file-name-2
OF
data-name-1 , data-name-2
Can be a record-name.
condition-name-1
Can be referenced by statements and entries either in the program that
contains the configuration section or in a program contained within that
program.
file-name-1
Must be identified by an FD or SD entry in the DATA DIVISION.
Must be unique within this program.
LINAGE-COUNTER
Must be qualified each time it is referenced if more than one file
description entry that contains a LINAGE clause has been specified in the
source unit.
file-name-2
Must be identified by the FD or SD entry in the DATA DIVISION.
file-name-2 must be unique within this program.
Duplication of data-names must not occur in those places where the data-names
cannot be made unique by qualification.
In the same program, the data-name specified as the subject of the entry whose
level-number is 01 that includes the EXTERNAL clause must not be the same
data-name specified for any other data description entry that includes the
EXTERNAL clause.
In the same DATA DIVISION, the data description entries for any two data items
for which the same data-name is specified must not include the GLOBAL clause.
Chapter 8. Referencing data names, copy libraries, and PROCEDURE DIVISION names 71
DATA DIVISION names that are explicitly referenced must either be uniquely
defined or made unique through qualification. Unreferenced data items need not
be uniquely defined. The highest level in a data hierarchy (a data item associated
with a level indicator (FD or SD in the FILE SECTION) or with level-number 01)
must be uniquely named if referenced. Data items associated with level-numbers
02 through 49 are successively lower levels of the hierarchy.
Condition-name
See the syntax and description for details.
condition-name-1
IN data-name-1 IN file-name-1
OF OF
( subscript )
condition-name-1
IN mnemonic-name-1
OF
condition-name-1
Can be referenced by statements and entries either in the program that
contains the definition of condition-name-1, or in a program contained
within that program.
If explicitly referenced, a condition-name must be unique or be made
unique through qualification or subscripting (or both) except when the
scope of names by itself ensures uniqueness of reference.
If qualification is used to make a condition-name unique, the associated
conditional variable can be used as the first qualifier. If qualification is
used, the hierarchy of names associated with the conditional variable itself
must be used to make the condition-name unique.
If references to a conditional variable require subscripting, reference to any
of its condition-names also requires the same combination of subscripting.
Index-name
An index-name identifies an index. An index can be regarded as a private special
register that the compiler generates for working with a table. You name an index
by specifying the INDEXED BY phrase in the OCCURS clause that defines a table.
An index-name is not the same as the name of an index data item, and an
index-name cannot be used like a data-name.
You define an index data item by specifying the USAGE IS INDEX clause in a data
description entry. The name of an index data item is a data-name. An index data
item can be used anywhere a data-name or identifier can be used, unless stated
otherwise in the rules of a particular statement. You can use the SET statement to
save the value of an index (referenced by index-name) in an index data item.
Subscripting
Subscripting is a method of providing table references through the use of
subscripts. A subscript is a positive integer whose value specifies the occurrence
number of a table element.
Chapter 8. Referencing data names, copy libraries, and PROCEDURE DIVISION names 73
Format
condition-name-1
data-name-1 IN data-name-2
OF
IN file-name-1
OF
( integer-1 )
ALL
data-name-3
+ integer-2
-
index-name-1
+ integer-3
-
condition-name-1
The conditional variable for condition-name-1 must contain an OCCURS
clause or must be subordinate to a data description entry that contains an
OCCURS clause.
data-name-1
Must contain an OCCURS clause or must be subordinate to a data
description entry that contains an OCCURS clause.
data-name-2 , file-name-1
Must name data items or records that contain data-name-1.
integer-1
Can be signed. If signed, it must be positive.
data-name-3
Must be a numeric elementary item representing an integer.
data-name-3 can be qualified.
index-name-1
Corresponds to a data description entry in the hierarchy of the table being
referenced that contains an INDEXED BY phrase that specifies that name.
integer-2 , integer-3
Cannot be signed.
Subscripted references can also be reference modified. See the third example under
Reference modification examples on page 78. A reference to an item must not be
subscripted unless the item is a table element or an item or condition-name
associated with a table element.
Each table element reference must be subscripted except when such reference
appears:
v In a USE FOR DEBUGGING statement
v As the subject of a SEARCH statement
v In a REDEFINES clause
v In the KEY is phrase of an OCCURS clause
Chapter 8. Referencing data names, copy libraries, and PROCEDURE DIVISION names 75
The INDEXED BY phrase, by which the index-name is identified and associated
with its table, is an optional part of the OCCURS clause. There is no separate entry
to describe the index associated with index-name. At run time, the contents of the
index corresponds to an occurrence number for that specific dimension of the table
with which the index is associated.
The initial value of an index at run time is undefined, and the index must be
initialized before it is used as a subscript. An initial value is assigned to an index
with one of the following statements:
v The PERFORM statement with the VARYING phrase
v The SEARCH statement with the ALL phrase
v The SET statement
An index-name can be used to reference any table. However, the element length of
the table being referenced and of the table that the index-name is associated with
should match. Otherwise, the reference will not be to the same table element in
each table, and you might get runtime errors.
Data that is arranged in the form of a table is often searched. The SEARCH
statement provides facilities for producing serial and nonserial searches. It is used
to search for a table element that satisfies a specific condition and to adjust the
value of the associated index to indicate that table element.
Relative subscripting
The operators + and - must be preceded and followed by a space. The value of the
subscript used is the same as if the index-name or data-name had been set up or
down by the value of the integer. The use of relative indexing does not cause the
program to alter the value of the index.
Reference modification
Reference modification defines a data item by specifying a leftmost character and
optional length for the data item.
data-name-1
FUNCTION function-name-1
( argument-1 )
( leftmost-character-position : )
length
data-name-1
Must reference a data item described explicitly or implicitly with usage
DISPLAY, DISPLAY-1, or NATIONAL. A national group item is processed
as an elementary data item of category national.
data-name-1 can be qualified or subscripted.
function-name-1
Must reference an alphanumeric or national function.
leftmost-character-position
Must be an arithmetic expression. The evaluation of leftmost-character-
position must result in a positive nonzero integer that is less than or equal
to the number of characters in the data item referenced by data-name-1.
length
Must be an arithmetic expression.
The evaluation of length must result in a positive nonzero integer.
The sum of leftmost-character-position and length minus the value 1 must be
less than or equal to the number of character positions in data-name-1. If
length is omitted, the length used will be equal to the number of character
positions in data-name-1 plus 1, minus leftmost-character-position.
For usages DISPLAY-1 and NATIONAL, each character position occupies 2 bytes.
Reference modification operates on whole character positions and not on the
individual bytes of the characters in usages DISPLAY-1 and NATIONAL. For usage
DISPLAY, reference modification operates as though each character were a
single-byte character.
Chapter 8. Referencing data names, copy libraries, and PROCEDURE DIVISION names 77
If data-name-1 is described with usage NATIONAL and category numeric,
numeric-edited, national-edited, or external floating-point, data-name-1 is operated
upon for purposes of reference modification as if it were redefined as a data item
of category national with the same size as the data item referenced by data-name-1.
When a function is reference-modified, the unique data item has class, category,
and usage national if the type of the function is national; otherwise, it has class
and category alphanumeric and usage display.
When data-name-1 is reference-modified, the unique data item has the same class,
category, and usage as that defined for the data item referenced by data-name-1
except that:
v If data-name-1 has category national-edited, the unique data item has category
national.
v If data-name-1 has usage NATIONAL and category numeric-edited, numeric, or
external floating-point, the unique data item has category national.
v If data-name-1 has usage DISPLAY, and category numeric-edited,
alphanumeric-edited, numeric, or external floating-point, the unique data item
has category alphanumeric.
v If data-name-1 references an alphanumeric group item, the unique data item is
considered to have usage DISPLAY and category alphanumeric.
v If data-name-1 references a national group item, the unique data item has usage
NATIONAL and category national.
If length is not specified, the unique data item created extends from and includes
the character position identified by leftmost-character-position up to and including
the rightmost character position of the data item referenced by data-name-1.
Evaluation of operands
The statements in the examples transfer the first 10 characters of the data-item
referenced by WHOLE-NAME to the data-item referenced by FIRST-NAME.
77 WHOLE-NAME PIC X(25).
77 FIRST-NAME PIC X(10).
77 START-P PIC 9(4) BINARY VALUE 1.
77 STR-LENGTH PIC 9(4) BINARY VALUE 10.
The following statement transfers the last 15 characters of the data-item referenced
by WHOLE-NAME to the data-item referenced by LAST-NAME.
77 WHOLE-NAME PIC X(25).
77 LAST-NAME PIC X(15).
...
MOVE WHOLE-NAME(11:) TO LAST-NAME.
The following statement transfers the fourth and fifth characters of the third
occurrence of TAB to the variable SUFFIX.
01 TABLE-1.
02 TAB OCCURS 10 TIMES PICTURE X(5).
77 SUFFIX PICTURE X(2).
...
MOVE TAB OF TABLE-1 (3) (4:2) TO SUFFIX.
Function-identifier
A function-identifier is a sequence of character strings and separators that uniquely
references the data item that results from the evaluation of a function.
Format
FUNCTION function-name-1
( argument-1 )
reference-modifier
argument-1
Must be an identifier, literal (other than a figurative constant), or arithmetic
expression.
For more information, see Chapter 21, Intrinsic functions, on page 489.
function-name-1
function-name-1 must be one of the intrinsic function names.
reference-modifier
Can be specified only for functions of the type alphanumeric or national.
Chapter 8. Referencing data names, copy libraries, and PROCEDURE DIVISION names 79
A function-identifier that makes reference to an integer or numeric function can be
used wherever an arithmetic expression can be used.
For example, you need not specify the USAGE of a data item. If USAGE is omitted
and the symbol N is not specified in the PICTURE clause, the default is USAGE
DISPLAY, which is the implicit data attribute. When PICTURE symbol N is used,
USAGE DISPLAY-1 is the default when the NSYMBOL(DBCS) compiler option is
in effect; USAGE NATIONAL is the default when the NSYMBOL(NATIONAL)
compiler option is in effect. These are implicit data attributes.
COBOL also provides explicit control transfers through the execution of any
procedure branching, program call, or conditional statement. (Lists of procedure
branching and conditional statements are contained in Statement categories on
page 280.)
Definition: The term next executable statement refers to the next COBOL statement
to which control is transferred, according to the rules given above. There is no next
executable statement under the following circumstances:
v When the program contains no PROCEDURE DIVISION
v Following the last statement in a declarative section when the paragraph in
which it appears is not being executed under the control of some other COBOL
statement
v Following the last statement in a program or method when the paragraph in
which it appears is not being executed under the control of some other COBOL
statement in that program
v Following the last statement in a declarative section when the statement is in the
range of an active PERFORM statement executed in a different section and this
last statement of the declarative section is not also the last statement of the
procedure that is the exit of the active PERFORM statement
When there is no next executable statement and control is not transferred outside
the COBOL program, the program flow of control is undefined unless the program
execution is in the nondeclarative procedures portion of a program under control
of a CALL statement, in which case an implicit EXIT PROGRAM statement is
executed.
With the exception of the COPY and REPLACE statements and the end program
marker, the statements, entries, paragraphs, and sections of a COBOL source
program are grouped into the following four divisions:
v IDENTIFICATION DIVISION
v ENVIRONMENT DIVISION
v DATA DIVISION
v PROCEDURE DIVISION
The end of a COBOL source program is indicated by the END PROGRAM marker.
If there are no nested programs, the absence of additional source program lines
also indicates the end of a COBOL program.
The following format is for the entries and statements that constitute a separately
compiled COBOL source program.
RECURSIVE . identification-division-content
IS INITIAL PROGRAM
ENVIRONMENT DIVISION. environment-division-content
DATA DIVISION. data-division-content PROCEDURE DIVISION. procedure-division-content
END PROGRAM program-name-1.
COMMON . identification-division-content
IS INITIAL PROGRAM
INITIAL
COMMON
ENVIRONMENT DIVISION. environment-division-content
DATA DIVISION. data-division-content PROCEDURE DIVISION. procedure-division-content
A sequence of separate COBOL programs can also be input to the compiler. The
following format is for the entries and statements that constitute a sequence of
source programs (batch compile).
COBOL-source-program
Nested programs
A COBOL program can contain other COBOL programs, which in turn can contain
still other COBOL programs. These contained programs are called nested programs.
Nested programs can be directly or indirectly contained in the containing program.
Nested programs are not supported for programs compiled with the THREAD
option.
The following figure describes a more complex nested program structure with
directly and indirectly contained programs.
Names of programs that constitute a run unit are not necessarily unique, but when
two programs in a run unit are identically named, at least one of the programs
must be directly or indirectly contained within another separately compiled
program that does not contain the other of those two programs.
A separately compiled program and all of its directly and indirectly contained
programs must have unique program-names within that separately compiled
program.
If Program-D does not possess the COMMON attribute, then Program-D can be
referenced only by the program that directly contains Program-D, that is,
Program-C.
Java String data is represented at run time in Unicode. The Unicode support
provided in Enterprise COBOL with the national data type enables COBOL
programs to exchange String data with Java.
The following entities and concepts are used in object-oriented COBOL for Java
interoperability:
Class The entity that defines operations and state for zero, one, or more object
instances and defines operations and state for a common object (a factory
object) that is shared by multiple object instances.
You create object instances using the NEW operand of the COBOL
INVOKE statement or using a Java class instance creation expression.
Object instances are automatically freed by the Java runtime system's
garbage collection when they are no longer in use. You cannot explicitly
free individual objects.
Instance method
Procedural code that defines one of the operations supported for the object
instances of a class. Instance methods introduced by a COBOL class are
defined within the object paragraph of the class definition.
COBOL instance methods are equivalent to public nonstatic methods in
Java.
You execute instance methods on a particular object instance by using a
COBOL INVOKE statement or a Java method invocation expression.
Instance data
Data that defines the state of an individual object instance. Instance data in
a COBOL class is defined in the WORKING-STORAGE SECTION of the
DATA DIVISION within the object paragraph of a class definition.
With the exception of the COPY and REPLACE statements and the END CLASS
marker, the statements, entries, paragraphs, and sections of a COBOL class
definition are grouped into the following structure:
v IDENTIFICATION DIVISION
v ENVIRONMENT DIVISION (configuration section only)
v Factory definition
IDENTIFICATION DIVISION
DATA DIVISION
PROCEDURE DIVISION (containing one or more method definitions)
v Object definition
IDENTIFICATION DIVISION
DATA DIVISION
PROCEDURE DIVISION (containing one or more method definitions)
The end of a COBOL class definition is indicated by the END CLASS marker.
other-identification-division-content
Object-definition END CLASS class-name-1.
Factory-definition:
END FACTORY.
PROCEDURE DIVISION.
method-definition
Object-definition:
END OBJECT.
PROCEDURE DIVISION.
method-definition
END CLASS
Specifies the end of a class definition.
END FACTORY
Specifies the end of a factory definition.
END OBJECT
Specifies the end of an object definition.
With the exception of COPY and REPLACE statements and the END METHOD
marker, the statements, entries, paragraphs, and sections of a COBOL method
definition are grouped into the following four divisions:
v IDENTIFICATION DIVISION
v ENVIRONMENT DIVISION (input-output section only)
v DATA DIVISION
v PROCEDURE DIVISION
The end of a COBOL method definition is indicated by the END METHOD marker.
other-identification-division-content
ENVIRONMENT DIVISION. method-environment-division-content
DATA DIVISION. method-data-division-content
method-procedure-division-header.
method-procedure-division-content
METHOD-ID
Identifies a method definition. See METHOD-ID paragraph on page 106
for details.
method-procedure-division-header
Indicates the start of the PROCEDURE DIVISION and identifies method
parameters and the returning item, if any. See The PROCEDURE
DIVISION header on page 251 for details.
END METHOD
Specifies the end of a method definition.
An instance method cannot directly access instance data defined in a parent class,
factory data defined in its own class, or method data defined in another method of
its class. It must invoke a method to access such data.
A factory method cannot directly access factory data defined in a parent class,
instance data defined in its own class, or method data defined in another method
of its class. It must invoke a method to access such data.
Methods can be invoked from COBOL programs and methods, and they can be
invoked from Java programs. A method can execute an INVOKE statement that
directly or indirectly invokes itself. Therefore, COBOL methods are implicitly
recursive (unlike COBOL programs, which support recursion only if the
RECURSIVE attribute is specified in the program-ID paragraph.)
RECURSIVE .
IS COMMON PROGRAM
INITIAL
INITIAL
COMMON
AUTHOR
.
comment-entry
INSTALLATION
.
comment-entry
DATE-WRITTEN
.
comment-entry
DATE-COMPILED.
comment-entry
SECURITY
.
comment-entry
INHERITS class-name-2.
AUTHOR
.
comment-entry
INSTALLATION
.
comment-entry
DATE-WRITTEN
.
comment-entry
DATE-COMPILED.
comment-entry
SECURITY
.
comment-entry
AUTHOR
.
comment-entry
INSTALLATION
.
comment-entry
DATE-WRITTEN
.
comment-entry
DATE-COMPILED.
comment-entry
SECURITY
.
comment-entry
PROGRAM-ID paragraph
The PROGRAM-ID paragraph specifies the name by which the program is known
and assigns selected program attributes to that program. It is required and must be
the first paragraph in the IDENTIFICATION DIVISION.
program-name
A user-defined word or alphanumeric literal, but not a figurative constant,
that identifies your program. It must follow the following rules of
formation, depending on the setting of the PGMNAME compiler option:
102 Enterprise COBOL for z/OS, V5.2 Language Reference
PGMNAME(COMPAT)
The name can be up to 30 characters in length.
Only the hyphen, underscore, digits 0-9, and alphabetic characters
are allowed in the name when it is specified as a user-defined
word.
At least one character must be alphabetic.
The hyphen cannot be the first or last character.
If program-name is an alphanumeric literal, the rules for the name
are the same except that the extension characters $, #, and @ can be
included in the name of the outermost program and the
underscore can be the first character.
PGMNAME (LONGUPPER)
If program-name is a user-defined word, it can be up to 30
characters in length.
If program-name is an alphanumeric literal, the literal can be up to
160 characters in length. The literal cannot be a figurative constant.
Only the hyphen, underscore, digits 0-9, and alphabetic characters
are allowed in the name when the name is specified as a
user-defined word.
At least one character must be alphabetic.
The hyphen cannot be the first or last character.
If program-name is an alphanumeric literal, the underscore character
can be the first character.
External program-names are processed with alphabetic characters
folded to uppercase.
PGMNAME (LONGMIXED)
program-name must be specified as an alphnumeric literal, which
can be up to 160 characters in length. The literal cannot be a
figurative constant.
program-name can consist of any character in the range X'41' to
X'FE'.
For information about the PGMNAME compiler option and how the compiler
processes the names, see PGMNAME in the Enterprise COBOL Programming Guide.
RECURSIVE
An optional clause that allows COBOL programs to be recursively
reentered.
You can specify the RECURSIVE clause only on the outermost program of
a compilation unit. Recursive programs cannot contain nested
subprograms.
If the RECURSIVE clause is specified, program-name can be recursively
reentered while a previous invocation is still active. If the RECURSIVE
clause is not specified, an active program cannot be recursively reentered.
The WORKING-STORAGE SECTION of a recursive program defines
storage that is statically allocated and initialized on the first entry to a
program and is available in a last-used state to any of the recursive
invocations.
CLASS-ID paragraph
The CLASS-ID paragraph specifies the name by which the class is known and
assigns selected attributes to that class. The CLASS-ID paragraph is required and
must be the first paragraph in a class IDENTIFICATION DIVISION.
class-name-1
A user-defined word that identifies the class. class-name-1 can optionally
have an entry in the REPOSITORY paragraph of the configuration section
of the class definition.
INHERITS
A clause that defines class-name-1 to be a subclass (or derived class) of
class-name-2 (the parent class). class-name-1 cannot directly or indirectly
inherit from class-name-1.
class-name-2
The name of a class inherited by class-name-1. You must specify class-name-2
in the REPOSITORY paragraph of the configuration section of the class
definition.
General rules
class-name-1 and class-name-2 must conform to the normal rules of formation for a
COBOL user-defined word, using single-byte characters.
Inheritance
Every method available on instances of a class is also available on instances of any
subclass directly or indirectly derived from that class.
A subclass can introduce new methods that do not exist in the parent or ancestor
class and can override a method from the parent or ancestor class. When a
subclass overrides an existing method, it defines a new implementation for that
method, which replaces the inherited implementation.
The semantics of inheritance are as defined by Java. All classes must be derived
directly or directly from the java.lang.Object class.
FACTORY paragraph
The factory IDENTIFICATION DIVISION introduces the factory definition, which
is the portion of a class definition that defines the factory object of the class.
A factory object is the single common object that is shared by all object instances of
the class. The factory definition contains factory data and factory methods.
OBJECT paragraph
The object IDENTIFICATION DIVISION introduces the object definition, which is
the portion of a class definition that defines the instance objects of the class.
METHOD-ID paragraph
The METHOD-ID paragraph specifies the name by which a method is known and
assigns selected attributes to that method. The METHOD-ID paragraph is required
and must be the first paragraph in a method identification division.
method-name-1
An alphanumeric literal or national literal that contains the name of the
method. The name must conform to the rules of formation for a Java
method name. Method names are used directly, without translation. The
method name is processed in a case-sensitive manner.
Method signature
The signature of a method consists of the name of the method and the number and
types of the formal parameters to the method as specified in the PROCEDURE
DIVISION USING phrase.
COBOL methods can be overloaded, overridden, or hidden, based on the rules of the
Java language.
Method overloading
Method names that are defined for a class are not required to be unique.
(The set of methods defined for a class includes the methods introduced by
the class definition and the methods inherited from parent classes.)
Method names defined for a class must have unique signatures. Two
methods defined for a class and that have the same name but different
signatures are said to be overloaded.
The type of the method return value, if any, is not included in the method
signature.
A class must not define two methods with the same signature but different
return value types, or with the same signature but where one method
specifies a return value and the other does not.
Optional paragraphs
Some optional paragraphs in the IDENTIFICATION DIVISION can be omitted.
Format:
CONFIGURATION SECTION.
source-computer-paragraph
object-computer-paragraph special-names-paragraph
repository-paragraph
SOURCE-COMPUTER paragraph
The SOURCE-COMPUTER paragraph describes the computer on which the source
text is to be compiled.
Format
SOURCE-COMPUTER.
computer-name .
DEBUGGING MODE
WITH
computer-name
A system-name. For example:
IBM-system
WITH DEBUGGING MODE
Activates a compile-time switch for debugging lines written in the source
text.
A debugging line is a statement that is compiled only when the
compile-time switch is activated. Debugging lines allow you, for example,
to check the value of a data-name at certain points in a procedure.
To specify a debugging line in your program, code a D in column 7
(indicator area). You can include successive debugging lines, but each must
have a D in column 7, and you cannot break character strings across lines.
All your debugging lines must be written so that the program is
syntactically correct, whether the debugging lines are compiled or treated
as comments.
The presence or absence of the DEBUGGING MODE clause is logically
determined after all COPY and REPLACE statements have been processed.
You can code debugging lines in the ENVIRONMENT DIVISION (after the
OBJECT-COMPUTER paragraph), and in the data and procedure divisions.
If a debugging line contains only spaces in Area A and in Area B, the
debugging line is treated the same as a blank line.
All of the SOURCE-COMPUTER paragraph is syntax checked, but only the WITH
DEBUGGING MODE clause has an effect on the execution of the program.
OBJECT-COMPUTER paragraph
The OBJECT-COMPUTER paragraph specifies the system for which the object
program is designated.
OBJECT-COMPUTER.
computer-name entry 1 .
MEMORY integer WORDS
SIZE CHARACTERS
MODULES
entry 1:
SEQUENCE alphabet-name
PROGRAM COLLATING IS
SEGMENT-LIMIT priority-number
IS
computer-name
A system-name. For example:
IBM-system
MEMORY SIZE integer
integer specifies the amount of main storage needed to run the object
program, in words, characters or modules. The MEMORY SIZE clause is
syntax checked but has no effect on the execution of the program.
PROGRAM COLLATING SEQUENCE IS alphabet-name
The collating sequence used in this program is the collating sequence
associated with the specified alphabet-name.
The collating sequence pertains to this program and to any programs that
this program might contain.
PROGRAM COLLATING SEQUENCE determines the truth value of the
following alphanumeric comparisons:
v Those explicitly specified in relation conditions
v Those explicitly specified in condition-name conditions
The PROGRAM COLLATING SEQUENCE clause also applies to any
merge or sort keys described with usage DISPLAY, unless the COLLATING
SEQUENCE phrase is specified in the MERGE or SORT statement.
The PROGRAM COLLATING SEQUENCE clause does not apply to DBCS
data items or data items of usage NATIONAL.
If the PROGRAM COLLATING SEQUENCE clause is omitted, the EBCDIC
collating sequence is used. (See Appendix C, EBCDIC and ASCII collating
sequences, on page 587.)
SEGMENT-LIMIT IS
The SEGMENT-LIMIT clause is syntax checked but has no effect on the
execution of the program.
priority-number
An integer ranging from 1 through 49. All sections with priority-numbers 0
Chapter 14. Configuration section 113
through 49 are fixed permanent segments. See Procedures on page 256
for a description of priority-numbers and segmentation support.
Segmentation is not supported for programs compiled with the THREAD
option.
SPECIAL-NAMES paragraph
The SPECIAL-NAMES paragraph is the name of an ENVIRONMENT DIVISION
paragraph in which environment-names are related to user-specified
mnemonic-names.
SPECIAL-NAMES.
environment-name-1 mnemonic-name-1
IS
environment-name-2 mnemonic-name-2
IS entry 1
entry 1
literal-1 phrase 1
SYMBOLIC symbolic
CHARACTERS IN alphabet-name-2
CURRENCY literal-6
SIGN IS PICTURE SYMBOL literal-7
WITH
DECIMAL-POINT COMMA
IS
(1)
.
XML-SCHEMA xml-schema-name-1 external-fileid-1
IS literal-8
Notes:
1 This separator period is optional when no clauses are selected. If you use
any clauses, you must code the period after the last clause.
entry 1:
ON condition-1
STATUS IS OFF condition-2
STATUS IS
OFF condition-2
STATUS IS ON condition-1
STATUS IS
phrase 1:
THROUGH literal-2
THRU
ALSO literal-3
symbolic:
symbolic-character-1 integer-1
ARE
IS
environment-name-1
System devices or standard system actions taken by the compiler.
environment-name-2
A 1-byte user-programmable status indicator (UPSI) switch. Valid
specifications for environment-name-2 are UPSI-0 through UPSI-7.
mnemonic-name-1 , mnemonic-name-2
mnemonic-name-1 and mnemonic-name-2 follow the rules of formation for
user-defined names. mnemonic-name-1 can be used in ACCEPT, DISPLAY,
and WRITE statements. mnemonic-name-2 can be referenced only in the SET
statement. mnemonic-name-2 can qualify condition-1 or condition-2 names.
Mnemonic-names and environment-names need not be unique. If you
choose a mnemonic-name that is also an environment-name, its definition
as a mnemonic-name will take precedence over its definition as an
environment-name.
ON STATUS IS, OFF STATUS IS
UPSI switches process special conditions within a program, such as
year-beginning or year-ending processing. For example, at the beginning of
the PROCEDURE DIVISION, an UPSI switch can be tested; if it is ON, the
special branch is taken. (See Switch-status condition on page 274.)
condition-1, condition-2
Condition-names follow the rules for user-defined names. At least one
character must be alphabetic. The value associated with the
condition-name is considered to be alphanumeric. A condition-name can be
associated with the on status or off status of each UPSI switch specified.
In the PROCEDURE DIVISION, the UPSI switch status is tested through
the associated condition-name. Each condition-name is the equivalent of a
level-88 item; the associated mnemonic-name, if specified, is considered the
conditional variable and can be used for qualification.
Condition-names specified in the SPECIAL-NAMES paragraph of a
containing program can be referenced in any contained program.
ALPHABET clause
The ALPHABET clause provides a means of relating an alphabet-name to a
specified character code set or collating sequence.
The related character code set or collating sequence can be used for alphanumeric
data, but not for DBCS or national data.
ALPHABET alphabet-name-1 IS
alphabet-name-1 specifies a collating sequence when used in:
v The PROGRAM COLLATING SEQUENCE clause of the object-computer
paragraph
v The COLLATING SEQUENCE phrase of the SORT or MERGE statement
alphabet-name-1 specifies a character code set when used in:
v The FD entry CODE-SET clause
v The SYMBOLIC CHARACTERS clause
CLASS clause
The CLASS clause provides a means for relating a name to the specified set of
characters listed in that clause.
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 consists.
The class-name in the CLASS clause can be a DBCS user-defined word.
literal-4, literal-5
Must be category numeric or alphanumeric, and both must be of the same
category.
If numeric, literal-4 and literal-5 must be unsigned integers and must have
a value that is greater than or equal to 1 and less than or equal to the
number of characters in the alphabet specified. Each number corresponds
to the ordinal position of each character in the single-byte EBCDIC or
ASCII collating sequence.
If alphanumeric, literal-4 and literal-5 are an actual single-byte EBCDIC
character.
literal-4 and literal-5 must not specify a symbolic-character figurative
constant. If the value of the alphanumeric literal contains multiple
characters, each character in the literal is included in the set of characters
identified by class-name.
Floating-point literals cannot be used in the CLASS clause.
If the alphanumeric literal is associated with a THROUGH phrase, the
literal must be one character in length.
THROUGH, THRU
THROUGH and THRU are equivalent. If THROUGH is specified,
class-name includes those characters that begin with the value of
literal-4 and that end with the value of literal-5. In addition, the
characters specified by a THROUGH phrase can be in either
ascending or descending order.
Typically, currency sign values identify the monetary units stored in a data item.
For example: '$', 'EUR', 'CHF', 'JPY', 'HK$', 'HKD', or X'9F' (hexadecimal code point
120 Enterprise COBOL for z/OS, V5.2 Language Reference
in some EBCDIC code pages for , the Euro currency sign). For details on
programming techniques for handling the Euro, see Using currency signs in the
Enterprise COBOL Programming Guide.
The CURRENCY SIGN clause specifies a currency sign value and the currency
symbol used to represent that currency sign value in a PICTURE clause.
XML-SCHEMA clause
The XML-SCHEMA clause provides the means of relating xml-schema-name-1 to an
external file identifier: a ddname or environment variable that identifies the actual
external file that contains the optimized XML schema.
The external file identifier must be either the name specified in the DD statement
for the file or the name of an environment variable that contains the file
identification information.
The environment variable name must be defined using only uppercase because the
COBOL compiler automatically folds the external file identifier to uppercase.
For an XML schema in an MVS data set, the environment variable must contain a
DSN option in the format shown below.
DSN(data-set-name )
(member-name)
data-set-name must be fully qualified. You must not code blanks within the
parentheses.
For an XML schema in a z/OS UNIX file, the environment variable must contain a
PATH option in the format shown below.
Format: environment variable for XML schema in a z/OS UNIX file, PATH
option
PATH(path-name)
path-name must be an absolute path name; that is, it must begin with a slash.
Special characters in the path name must be "escaped" by preceding them with a
backslash. For example, to include a backslash in the path name, code two
backslashes in sequence.
For more information about specifying path-name, see the description of the PATH
parameter in the z/OS MVS JCL Reference.
For both formats, blanks at the beginning and end of the environment variable
contents are ignored. You must not code blanks between a keyword and the left
parenthesis that immediately follows the keyword.
REPOSITORY paragraph
The REPOSITORY paragraph is used in a program or class definition to identify all
the object-oriented classes that are intended to be referenced in that program or
class definition. Optionally, the REPOSITORY paragraph defines associations
between class-names and external class-names.
REPOSITORY.
CLASS class-name-1
external-class-name-1
IS java-array-class-reference
class-name-1
A user-defined word that identifies the class.
external-class-name-1
An alphanumeric literal containing a name that enables a COBOL program
to define or access classes with class-names that are defined using Java
rules of formation.
The name must conform to the rules of formation for a fully qualified Java
class-name. If the class is part of a Java package, external-class-name-1 must
specify the fully qualified name of the package, followed by a period,
followed by the simple name of the Java class.
See Java Language Specification, Third Edition, by Gosling et al., for Java
class-name formation rules.
java-array-class-reference
A reference that enables a COBOL program to access a class that represents
an array object, where the elements of the array are themselves objects.
java-array-class-reference must be an alphanumeric literal with content in the
following format:
Format
jobjectArray
: external-class-name-2
jobjectArray
Specifies a Java object array class.
: A required separator when external-class-name-2 is specified. The
colon must not be preceded or followed by space characters.
external-class-name-2
The external class-name of the type of the elements of the array.
external-class-name-2 must follow the same rules of formation as
external-class-name-1.
When the repository entry specifies jobjectArray without the colon
separator and external-class-name-2, the elements of the object array are of
type java.lang.Object.
General rules
See the general rules of the REPOSITORY paragraph.
When defining a COBOL class that is to be part of a Java package, specify an entry
in the repository paragraph of that class itself, giving the full Java
package-qualified name as the external class-name.
The exact contents of the input-output section depend on the file organization and
access methods used. See ORGANIZATION clause on page 137 and ACCESS
MODE clause on page 140.
Program input-output section
The same rules apply to program and method I-O sections.
Class input-output section
The input-output section is not valid for class definitions.
Method input-output section
The same rules apply to program and method I-O sections.
I-O-CONTROL.
i-o-control-paragraph .
FILE-CONTROL
The keyword FILE-CONTROL identifies the file-control paragraph. This
keyword can appear only once, at the beginning of the FILE-CONTROL
paragraph. It must begin in Area A and be followed by a separator period.
The keyword FILE-CONTROL and the period can be omitted if no
file-control-paragraph is specified and there are no files defined in the
program.
file-control-paragraph
Names the files and associates them with the external data sets.
Must begin in Area B with a SELECT clause. It must end with a separator
period. See FILE-CONTROL paragraph on page 128.
file-control-paragraph can be omitted if there are no files defined in the
program, even if the FILE-CONTROL keyword is specified.
I-O-CONTROL
The keyword I-O-CONTROL identifies the I-O-CONTROL paragraph.
FILE-CONTROL paragraph
The FILE-CONTROL paragraph associates each file in the COBOL program with
an external data set, and specifies file organization, access mode, and other
information.
The table below lists the different type of files available to programs and methods.
Table 6. Types of files
File organization Access method
Sequential QSAM, VSAM1
Relative VSAM1
Indexed VSAM1
Line sequential2 Text stream I-O
Within each entry, the SELECT clause must appear first. The other clauses can
appear in any order, except that the PASSWORD clause for indexed files, if
specified, must immediately follow the RECORD KEY or ALTERNATE RECORD
KEY data-name with which it is associated.
RESERVE integer SEQUENTIAL
AREA ORGANIZATION
AREAS IS
PADDING data-name-5
CHARACTER IS literal-2
RECORD DELIMITER STANDARD-1 ACCESS SEQUENTIAL
IS assignment-name-2 MODE IS
PASSWORD data-name-6 STATUS data-name-1
IS FILE IS data-name-8
.
INDEXED
RESERVE integer ORGANIZATION
AREA IS
AREAS
RECORD data-name-2
ACCESS SEQUENTIAL KEY IS
MODE IS RANDOM
DYNAMIC
PASSWORD data-name-6 entry 1
IS
.
STATUS data-name-1
FILE IS data-name-8
entry 1:
ALTERNATE data-name-3
RECORD KEY IS DUPLICATES
WITH
PASSWORD data-name-7
IS
RELATIVE
RESERVE integer ORGANIZATION
AREA IS
AREAS
ACCESS SEQUENTIAL
MODE IS RELATIVE data-name-4
KEY IS
RANDOM RELATIVE data-name-4
DYNAMIC KEY IS
PASSWORD data-name-6 STATUS data-name-1
IS FILE IS data-name-8
.
Format 4: line-sequential-file-control-entry
LINE SEQUENTIAL
ORGANIZATION ACCESS SEQUENTIAL
IS MODE IS
.
STATUS data-name-1
FILE IS
When file-name-1 specifies a sort or a merge file, only the ASSIGN clause can
follow the SELECT clause.
ASSIGN clause
The ASSIGN clause associates the name of a file in a program with the actual
external name of the data file.
assignment-name-1
Identifies the external data file. It can be specified as a name or as an
alphanumeric literal.
assignment-name-1 is not the name of a data item, and assignment-name-1
cannot be contained in a data item. It is just a character string. It cannot
contain an underscore character.
Any assignment-name after the first is syntax checked, but has no effect on
the execution of the program.
assignment-name-1 has the following formats:
name
label- S-
AS- name
label-
name
label-
label- Documents (for the programmer) the device and device class to which a
file is assigned. It must end in a hyphen; the specified value is not
otherwise checked. It has no effect on the execution of the program. If
specified, it must end with a hyphen.
S- For QSAM files, the S- (organization) field can be omitted.
AS- For VSAM sequential files, the AS- (organization) field must be specified.
For VSAM indexed and relative files, the organization field must be
omitted.
name A required field that specifies the external name for this file.
It must be either the name specified in the DD statement for this file or the
name of an environment variable that contains file allocation information.
For details on specifying an environment variable, see Assignment name
for environment variable on page 134.
name must conform to the following rules of formation:
v If assignment-name-1 is a user-defined word:
The name can contain from one to eight characters.
The name can contain the characters A-Z, a-z, and 0-9.
The leading character must be alphabetic.
The name cannot contain an underscore.
v If assignment-name-1 is a literal:
The name can contain from one to eight characters.
The name can contain the characters A-Z, a-z, 0-9, @, #, and $.
The leading character must be alphabetic.
The name cannot contain an underscore.
For both user-defined words and literals, the compiler folds name to
uppercase to form the ddname for the file.
In a sort or merge file, name is treated as a comment.
The environment variable name must be defined using only uppercase because the
COBOL compiler automatically folds the external file-name to uppercase.
If this environment variable exists and contains a valid PATH or DSN option
(described below), then the file is dynamically allocated using the information
supplied by that option.
If the environment variable does not contain a valid PATH or DSN option or if the
dynamic allocation fails, then attempting to open the file results in file status 98.
The contents of the environment variable are checked at each OPEN statement. If a
file was dynamically allocated by a previous OPEN statement and the contents of
the environment variable have changed since the previous OPEN, then the
previous allocation is dynamically deallocated prior to dynamically reallocating the
file using the options currently set in the environment variable.
When the run unit terminates, the COBOL runtime system automatically
deallocates all automatically generated dynamic allocations.
For a QSAM file, the environment variable must contain either a DSN or a PATH
option in the format shown below.
DSN(data-set-name )
(member-name) NEW TRACKS
OLD CYL
SHR
MOD
SPACE(nnn,mmmm) VOL(volume-serial) UNIT(type)
KEEP STORCLAS(storage-class)
DELETE
CATALOG
UNCATALOG
MGMTCLAS(management-class) DATACLAS(data-class)
After data-set-name or member-name, the data set attributes can follow in any order.
The options that follow DSN (such as NEW or TRACKS) must be separated by a
comma or by one or more blanks.
Blanks at the beginning and end of the environment variable contents are ignored.
You must not code blanks within the parentheses or between a keyword and the
left parenthesis that immediately follows the keyword.
COBOL does not provide a default for data set disposition (NEW, OLD, SHR, or
MOD); however, your operating system might provide one. To avoid unexpected
results when opening the file, you should always specify NEW, OLD, SHR, or
MOD with the DSN option when you use environment variables for dynamic
allocation of QSAM files.
For information about specifying the values of the data set attributes, see the
description of the DD statement in the z/OS MVS JCL Reference.
PATH(path-name)
path-name must be an absolute path name; that is, it must begin with a slash. For
more information about specifying path-name, see the description of the PATH
parameter in z/OS MVS JCL Reference.
Blanks at the beginning and end of the environment variable contents are ignored.
You must not code blanks within the parentheses or between a keyword and the
left parenthesis that immediately follows the keyword.
For a line-sequential file, the environment variable must contain a PATH option in
the following format:
PATH(path-name)
path-name must be an absolute path name; that is, it must begin with a slash. For
more information about specifying path-name, see the description of the PATH
parameter in z/OS MVS JCL Reference.
For an indexed, relative, or sequential VSAM file, the environment variable must
contain a DSN option in the following format:
DSN(data-set-name)
OLD
SHR
data-set-name specifies the data set name for the base cluster. data-set-name must be
fully qualified and must reference an existing predefined and cataloged VSAM
data set.
The options that follow DSN (such as SHR) must be separated by a comma or by
one or more blanks.
Blanks at the beginning and end of the environment variable contents are ignored.
You must not code blanks within the parentheses or between a keyword and the
left parenthesis that immediately follows the keyword.
COBOL does not provide a default for data set disposition (OLD or SHR);
however, your operating system might provide one. To avoid unexpected results
when opening the file, you should always specify OLD or SHR with the DSN
option when you use environment variables for dynamic allocation of VSAM files.
If the RESERVE clause is omitted, the number of buffers at run time is taken from
the DD statement. If none is specified, the system default is taken.
ORGANIZATION clause
The ORGANIZATION clause identifies the logical structure of the file. The logical
structure is established at the time the file is created and cannot subsequently be
changed.
You can find a discussion of the different ways in which data can be organized
and of the different access methods that you can use to retrieve the data under
File organization and access modes on page 141.
ORGANIZATION IS SEQUENTIAL (format 1)
A predecessor-successor relationship among the records in the file is
established by the order in which records are placed in the file when it is
created or extended.
ORGANIZATION IS INDEXED (format 2)
The position of each logical record in the file is determined by indexes
created with the file and maintained by the system. The indexes are based
on embedded keys within the file's records.
ORGANIZATION IS RELATIVE (format 3)
The position of each logical record in the file is determined by its relative
record number.
ORGANIZATION IS LINE SEQUENTIAL (format 4)
A predecessor-successor relationship among the records in the file is
established by the order in which records are placed in the file when it is
created or extended. A record in a LINE SEQUENTIAL file can consist only
of printable characters.
File organization
You establish the organization of the data when you create a file. Once the file has
been created, you can expand the file, but you cannot change the organization.
The physical order in which the records are placed in the file determines the
sequence of records. The relationships among records in the file do not change,
except that the file can be extended. Records can be fixed length or variable length;
there are no keys.
Each record in the file except the first has a unique predecessor record; and each
record except the last has a unique successor record.
Indexed organization
Each record in the file has one or more embedded keys (referred to as key data
items); each key is associated with an index. An index provides a logical path to
the data records according to the contents of the associated embedded record key
data items. Indexed files must be direct-access storage files. Records can be fixed
length or variable length.
Each record in an indexed file must have an embedded prime key data item. When
records are inserted, updated, or deleted, they are identified solely by the values of
their prime keys. Thus, the value in each prime key data item must be unique and
must not be changed when the record is updated. You tell COBOL the name of the
prime key data item in the RECORD KEY clause of the file-control paragraph.
In addition, each record in an indexed file can contain one or more embedded
alternate key data items. Each alternate key provides another means of identifying
which record to retrieve. You tell COBOL the name of any alternate key data items
on the ALTERNATE RECORD KEY clause of the file-control paragraph.
The key used for any specific input-output request is known as the key of reference.
Relative organization
Think of the file as a string of record areas, each of which contains a single record.
Each record area is identified by a relative record number; the access method stores
and retrieves a record based on its relative record number. For example, the first
record area is addressed by relative record number 1 and the 10th is addressed by
relative record number 10. The physical sequence in which the records were placed
in the file has no bearing on the record area in which they are stored, and thus no
effect on each record's relative record number. Relative files must be direct-access
files. Records can be fixed length or variable length.
Line-sequential organization
When a record is written, any trailing blanks are removed prior to adding the
record delimiter. The characters in the record area from the first character up to
and including the added record delimiter constitute one record and are written to
the file.
When a record is read, characters are read one at a time into the record area until:
v The first record delimiter is encountered. The record delimiter is discarded and
the remainder of the record is filled with spaces.
For external files, data-name-5, if specified, must reference an external data item.
The RECORD DELIMITER clause is syntax checked, but has no effect on the
execution of the program.
For sequentially accessed relative files, the ACCESS MODE clause does not have to
precede the RELATIVE KEY clause.
ACCESS MODE IS SEQUENTIAL
Can be specified in all formats.
Format 1: sequential
Records in the file are accessed in the sequence established when
the file is created or extended. Format 1 supports only sequential
access.
Format 2: indexed
Records in the file are accessed in the sequence of ascending record
key values according to the collating sequence of the file.
Format 3: relative
Records in the file are accessed in the ascending sequence of
relative record numbers of existing records in the file.
Format 4: line-sequential
Records in the file are accessed in the sequence established when
the file is created or extended. Format 4 supports only sequential
access.
ACCESS MODE IS RANDOM
Can be specified in formats 2 and 3 only.
Format 2: indexed
The value placed in a record key data item specifies the record to
be accessed.
Format 3: relative
The value placed in a relative key data item specifies the record to
be accessed.
For details on the access methods and data organization, see Table 6 on page 128.
Sequentially organized data can be accessed only sequentially; however, data that
has indexed or relative organization can be accessed in any of the three access
modes.
Access modes
See the descriptions of the following types of access modes.
Sequential-access mode
Allows reading and writing records of a file in a serial manner; the order
of reference is implicitly determined by the position of a record in the file.
Random-access mode
Allows reading and writing records in a programmer-specified manner; the
control of successive references to the file is expressed by specifically
defined keys supplied by the user.
Dynamic-access mode
Allows the specific input-output statement to determine the access mode.
Therefore, records can be processed sequentially or randomly or both.
For external files, every file-control entry in the run unit that is associated with
that external file must specify the same access mode. In addition, for relative file
entries, data-name-4 must reference an external data item, and the RELATIVE KEY
phrase in each associated file-control entry must reference that same external data
item.
For files defined with the EXTERNAL clause, all file description entries in the run
unit that are associated with the file must have data description entries for
data-name-3 that specify the same relative location in the record and the same
length. The file description entries must specify the same number of alternate
record keys and the same DUPLICATES phrase.
When the PASSWORD clause is specified, at object time the PASSWORD data item
must contain a valid password for this file before the file can be successfully
opened.
Format 1 considerations:
The PASSWORD clause, if specified, must immediately follow the RECORD KEY
or ALTERNATE RECORD KEY data-name with which it is associated.
For indexed files that have been completely predefined to VSAM, only the
PASSWORD data item for the RECORD KEY need contain the valid password
before the file can be successfully opened at file creation time.
For any other type of file processing (including the processing of dynamic calls at
file creation time through a COBOL runtime subroutine), every PASSWORD data
item for the file must contain a valid password before the file can be successfully
opened, regardless of whether all paths to the data are used in this object program.
For external files, data-name-6 and data-name-7 must reference external data items.
The PASSWORD clauses in each associated file-control entry must reference the
same external data items.
When the FILE STATUS clause is specified, the system moves a value into the file
status key data item after each input-output operation that explicitly or implicitly
refers to this file. The value indicates the status of execution of the statement. (See
the file status key description under Common processing facilities on page 291.)
data-name-1
The file status key data item can be defined in the WORKING-STORAGE,
LOCAL-STORAGE, or LINKAGE SECTION as one of the following items:
v A two-character data item of category alphanumeric
v A two-character data item of category national
v A two-digit data item of category numeric with usage DISPLAY or
NATIONAL (an external decimal data item)
data-name-1 must not contain the PICTURE symbol 'P'.
Chapter 15. Input-Output section 145
data-name-1 can be qualified.
The file status key data item must not be variably located; that is, the data
item cannot follow a data item that contains an OCCURS DEPENDING
ON clause.
data-name-8
Must be defined as an alphanumeric group item of 6 bytes in the
WORKING-STORAGE SECTION or LINKAGE SECTION of the DATA
DIVISION.
Specify data-name-8 only if the file is a VSAM file (that is, ESDS, KSDS,
RRDS).
data-name-8 holds the 6-byte VSAM return code, which is composed as
follows:
v The first 2 bytes of data-name-8 contain the VSAM return code in binary
format. The value for this code is defined (by VSAM) as 0, 8, or 12.
v The next 2 bytes of data-name-8 contain the VSAM function code in binary
format. The value for this code is defined (by VSAM) as 0, 1, 2, 3, 4, or
5.
v The last 2 bytes of data-name-8 contain the VSAM feedback code in binary
format. The code value is 0 through 255.
If VSAM returns a nonzero return code, data-name-8 is set.
If FILE STATUS is returned without having called VSAM, data-name-8 is
zero.
If data-name-1 is set to zero, the content of data-name-8 is undefined. VSAM
status return code information is available without transformation in the
currently defined COBOL FILE STATUS code. User identification and
handling of exception conditions are allowed at the same level as that
defined by VSAM.
Function code and feedback code are set if and only if the return code is set to
a nonzero value. If they are referenced when the return code is set to zero,
the contents of the fields are not dependable.
Values in the return code, function code, and feedback code fields are defined
by VSAM. There are no COBOL additions, deletions, or modifications to
the VSAM definitions.
For more information, see DFSMS Macro Instructions for Data Sets.
I-O-CONTROL paragraph
The I-O-CONTROL paragraph of the input-output section specifies when
checkpoints are to be taken and the storage areas to be shared by different files.
This paragraph is optional in a COBOL program.
The keyword I-O-CONTROL can appear only once, at the beginning of the
paragraph. The word I-O-CONTROL must begin in Area A and must be followed
by a separator period.
The order in which I-O-CONTROL paragraph clauses are written is not significant.
The I-O-CONTROL paragraph ends with a separator period.
file-name-4
(1)
MULTIPLE FILE file-name-5
TAPE CONTAINS POSITION integer-2
(1)
APPLY WRITE-ONLY file-name-2
ON
phrase 1:
Notes:
1 The MULTIPLE FILE clause and APPLY WRITE-ONLY clause are not supported for VSAM files.
file-name-4
phrase 1:
Format: sort/merge-i-o-control-entry
RERUN assignment-name-1
ON
phrase 1:
file-name-3
file-name-4
RERUN clause
The RERUN clause specifies that checkpoint records are to be taken. Subject to the
restrictions given with each phrase, more than one RERUN clause can be specified.
For information regarding the checkpoint data set definition and the checkpoint
method required for complete compliance to the 85 COBOL Standard, see DD
statements for defining checkpoint data sets in the Enterprise COBOL Programming
Guide.
name
label- S-
The QSAM file must reside on a tape or direct access device. See also
Appendix F, ASCII considerations, on page 613.
SORT/MERGE considerations:
When the RERUN clause is specified in the I-O-CONTROL paragraph,
checkpoint records are written at logical intervals determined by the
sort/merge program during execution of each SORT or MERGE statement
in the program. When the RERUN clause is omitted, checkpoint records
are not written.
There can be only one SORT/MERGE I-O-CONTROL paragraph in a
program, and it cannot be specified in contained programs. It will have a
global effect on all SORT and MERGE statements in the program unit.
EVERY integer-1 RECORDS
A checkpoint record is to be written for every integer-1 records in
file-name-1 that are processed.
When multiple integer-1 RECORDS phrases are specified, no two of them
can specify the same value for file-name-1.
If you specify the integer-1 RECORDS phrase, you must specify
assignment-name-1.
EVERY END OF REEL/UNIT
A checkpoint record is to be written whenever end-of-volume for
file-name-1 occurs. The terms REEL and UNIT are interchangeable.
When multiple END OF REEL/UNIT phrases are specified, no two of
them can specify the same value for file-name-1.
The END OF REEL/UNIT phrase can be specified only if file-name-1 is a
sequentially organized file.
More than one SAME AREA clause can be included in a program. However:
v A specific file-name must not appear in more than one SAME AREA clause.
v If one or more file-names of a SAME AREA clause appear in a SAME RECORD
AREA clause, all the file-names in that SAME AREA clause must appear in that
SAME RECORD AREA clause. However, the SAME RECORD AREA clause can
contain additional file-names that do not appear in the SAME AREA clause.
v The rule that in the SAME AREA clause only one file can be open at one time
takes precedence over the SAME RECORD AREA rule that all the files can be
open at the same time.
The files named in a SAME RECORD AREA clause need not have the same
organization or access.
file-name-3 , file-name-4
Must be specified in the file-control paragraph of the same program.
file-name-3 and file-name-4 must not reference a file that is defined with the
EXTERNAL clause.
All of the files can be opened at the same time. A logical record in the shared
storage area is considered to be both of the following ones:
v A logical record of each opened output file in the SAME RECORD AREA clause
v A logical record of the most recently read input file in the SAME RECORD
AREA clause
More than one SAME RECORD AREA clause can be included in a program.
However:
v A specific file-name must not appear in more than one SAME RECORD AREA
clause.
v If one or more file-names of a SAME AREA clause appear in a SAME RECORD
AREA clause, all the file-names in that SAME AREA clause must appear in that
SAME RECORD AREA clause. However, the SAME RECORD AREA clause can
contain additional file-names that do not appear in the SAME AREA clause.
v The rule that in the SAME AREA clause only one file can be open at one time
takes precedence over the SAME RECORD AREA rule that all the files can be
open at the same time.
v If the SAME RECORD AREA clause is specified for several files, the record
description entries or the file description entries for these files must not include
the GLOBAL clause.
The files named in the SAME RECORD AREA clause need not have the same
organization or access.
When the SAME SORT AREA clause is specified, at least one file-name specified
must name a sort file. Files that are not sort files can also be specified. The
following rules apply:
v More than one SAME SORT AREA clause can be specified. However, a given
sort file must not be named in more than one such clause.
v If a file that is not a sort file is named in both a SAME AREA clause and in one
or more SAME SORT AREA clauses, all the files in the SAME AREA clause must
also appear in that SAME SORT AREA clause.
v Files named in a SAME SORT AREA clause need not have the same organization
or access.
v Files named in a SAME SORT AREA clause that are not sort files do not share
storage with each other unless they are named in a SAME AREA or SAME
RECORD AREA clause.
v During the execution of a SORT or MERGE statement that refers to a sort or
merge file named in this clause, any nonsort or nonmerge files associated with
file-names named in this clause must not be in the open mode.
This clause is syntax checked, but has no effect on the execution of the program.
The function is performed by the system through the LABEL parameter of the DD
statement.
Each section in the DATA DIVISION has a specific logical function within a
COBOL program, object definition, factory definition, or method and can be
omitted when that logical function is not needed. If included, the sections must be
written in the order shown. The DATA DIVISION is optional.
Program data division
The DATA DIVISION of a COBOL source program describes, in a
structured manner, all the data to be processed by the program.
Object data division
The object data division contains data description entries for instance object
data (instance data). Instance data is defined in the WORKING-STORAGE
SECTION of the object paragraph of a class definition.
Factory data division
The factory data division contains data description entries for factory object
data (factory data). Factory data is defined in the WORKING-STORAGE
SECTION of the factory paragraph of a class definition.
Method data division
A method data division contains data description entries for data accessible
within the method. A method data division can contain a
LOCAL-STORAGE SECTION or a WORKING-STORAGE SECTION, or
both. The term method data applies to both. Method data in
LOCAL-STORAGE is dynamically allocated and initialized on each
invocation of the method; method data in WORKING-STORAGE is static
and persists across invocations of the method.
DATA DIVISION.
FILE SECTION.
file-description-entry record-description-entry
WORKING-STORAGE SECTION.
record-description-entry
data-item-description-entry
LOCAL-STORAGE SECTION.
record-description-entry
data-item-description-entry
LINKAGE SECTION.
record-description-entry
data-item-description-entry
DATA DIVISION.
WORKING-STORAGE SECTION.
record-description-entry
data-item-description-entry
FILE SECTION
The FILE SECTION defines the structure of data files. The FILE SECTION must
begin with the header FILE SECTION, followed by a separator period.
file-description-entry
Represents the highest level of organization in the FILE SECTION. It
provides information about the physical structure and identification of a
file, and gives the record-names associated with that file. For the format
Data areas described in the FILE SECTION are not available for processing unless
the file that contains the data area is open.
A method FILE SECTION can define external files only. A single run-unit-level file
connector is shared by all programs and methods that contain a definition of a
given external file.
WORKING-STORAGE SECTION
The WORKING-STORAGE SECTION describes data records that are not part of
data files but are developed and processed by a program or method. The
WORKING-STORAGE SECTION also describes data items whose values are
assigned in the source program or method and do not change during execution of
the object program.
LOCAL-STORAGE SECTION
The LOCAL-STORAGE SECTION defines storage that is allocated and freed on a
per-invocation basis.
For nested programs, data items defined in the LOCAL-STORAGE SECTION are
allocated upon each invocation of the containing outermost program. However,
each data item is reinitialized to the value specified in its VALUE clause each time
the nested program is invoked.
LINKAGE SECTION
The LINKAGE SECTION describes data made available from another program or
method.
record-description-entry
See WORKING-STORAGE SECTION on page 157 for a description.
data-item-description-entry
See WORKING-STORAGE SECTION on page 157 for a description.
Record description entries and data item description entries in the LINKAGE
SECTION provide names and descriptions, but storage within the program or
method is not reserved because the data area exists elsewhere.
Any data description clause can be used to describe items in the LINKAGE
SECTION with the following exceptions:
v You cannot specify the VALUE clause for items other than level-88 items.
v You cannot specify the EXTERNAL clause.
You can specify the GLOBAL clause in the LINKAGE SECTION. The GLOBAL
clause has no effect for methods, however.
Data units
Data is grouped into the conceptual units as listed in the topic.
v File data
v Program data
v Method data
v Factory data
v Instance data
File data
File data is contained in files. A file is a collection of data records that exist on
some input-output device. A file can be considered as a group of physical records;
it can also be considered as a group of logical records. The DATA DIVISION
describes the relationship between physical and logical records.
A physical record is a unit of data that is treated as an entity when moved into or
out of storage. The size of a physical record is determined by the particular
input-output device on which it is stored. The size does not necessarily have a
direct relationship to the size or content of the logical information contained in the
file.
File description entries specify the physical aspects of the data (such as the size
relationship between physical and logical records, the size and names of the logical
records, labeling information, and so forth).
Record description entries describe the logical records in the file (including the
category and format of data within each field of the logical record), different values
the data might be assigned, and so forth.
After the relationship between physical and logical records has been established,
only logical records are made available to you. For this reason, a reference in this
information to "records" means logical records, unless the term "physical records" is
used.
Program data
Program data is created by a program instead of being read from a file.
The concept of logical records applies to program data as well as to file data.
Program data can thus be grouped into logical records, and be defined by a series
of record description entries. Items that need not be so grouped can be defined in
independent data description entries (called data item description entries).
Method data
Method data is defined in the DATA DIVISION of a method and is processed by
the procedural code in that method. Method data is organized into logical records
and independent data description entries in the same manner as program data.
Factory data
Factory data is defined in the DATA DIVISION in the factory paragraph of a class
definition and is processed by procedural code in the factory methods of that class.
Factory data is organized into logical records and independent data description
entries in the same manner as program data.
There is one factory object for a given class in a run unit, and therefore only one
instance of factory data in a run unit for that class.
Instance data
Instance data is defined in the DATA DIVISION in the object paragraph of a class
definition and is processed by procedural code in the instance methods of that
class. Instance data is organized into logical records and independent data
description entries in the same manner as program data.
There is one copy of instance data in each object instance of a given class. There
can be many object instances for a given class. Each has its own separate copy of
instance data.
Data relationships
The relationships among all data to be used in a program are defined in the DATA
DIVISION through a system of level indicators and level-numbers.
A level-number, with its descriptive entry, indicates the properties of specific data.
Level-numbers can be used to describe a data hierarchy; they can indicate that this
data has a special purpose. Although they can be associated with (and subordinate
to) level indicators, they can also be used independently to describe internal data
or data common to two or more programs. (See Level-numbers on page 188 for
level-number rules.)
Levels of data
After a record has been defined, it can be subdivided to provide more detailed
data references.
For example, in a customer file for a department store, one complete record could
contain all data that pertains to one customer. Subdivisions within that record
could be, for example, customer name, customer address, account number,
department number of sale, unit amount of sale, dollar amount of sale, previous
balance, and other pertinent information.
The basic subdivisions of a record (that is, those fields not further subdivided) are
called elementary items. Thus a record can be made up of a series of elementary
items or can itself be an elementary item.
The relationship between level-numbers within a group item defines the hierarchy
of data within that group.
15 ELEM-1 PIC... .
15 ELEM-2 PIC... .
10 SUBGROUP-2.
This entry includes
15 ELEM-3 PIC... .
15 ELEM-4 PIC... .
05 GROUP-2.
This entry includes
15 SUBGROUP-3.
This entry includes
25 ELEM-5 PIC... .
25 ELEM-6 PIC... .
15 SUBGROUP-4 PIC... .
RECORD ENTRY
GROUP 1 GROUP 2
SUBGROUP-1 SUBGROUP-2 SUBGROUP-3
You can also define groups with subordinate items that have different
level-numbers for the same level in the hierarchy. For example, 05 EMPLOYEE-NAME
and 04 EMPLOYEE-ADDRESS in EMPLOYEE-RECORD below define the same level in the
hierarchy. The compiler renumbers the levels in a relative fashion, as shown in
MAP output.
01 EMPLOYEE-RECORD.
05 EMPLOYEE-NAME.
10 FIRST-NAME PICTURE X(10).
10 LAST-NAME PICTURE X(10).
04 EMPLOYEE-ADDRESS.
08 STREET PICTURE X(10).
08 CITY PICTURE X(10).
The following record description entry defines the same data hierarchy as the
preceding record description entry:
01 EMPLOYEE-RECORD.
02 EMPLOYEE-NAME.
03 FIRST-NAME PICTURE X(10).
Special level-numbers
Special level-numbers identify items that do not structure a record.
Indentation
Successive data description entries can begin in the same column as preceding
entries, or can be indented.
Indentation is useful for documentation but does not affect the action of the
compiler.
The table below summarizes the classes and categories of group items.
Table 7. Classes and categories of group items
USAGE of
elementary
Category of items within a USAGE of a
Group description Class of group group group group
Without a Alphanumeric Alphanumeric Any Treated as
GROUP-USAGE (even though the DISPLAY
clause elementary items when usage is
in the group can relevant
have any
category)
With explicit or National National NATIONAL NATIONAL
implicit
GROUP-USAGE
clause
For more information about data categories, see Category descriptions on page
166.
The following elementary data items do not have a class and category:
v Index data items
v Items described with USAGE POINTER, USAGE FUNCTION-POINTER, USAGE
PROCEDURE-POINTER, or USAGE OBJECT REFERENCE
All other types of elementary data items have a class and category as shown in
Table 8 on page 165.
A function references an elementary data item and belongs to the data class and
category associated with the type of the function, as shown in Table 9 on page 165.
Literals have a class and category as shown in Table 10 on page 165. Figurative
constants (except NULL) have a class and category that depends on the literal or
value represented by the figurative constant in the context of its use. For details,
see Figurative constants on page 13.
Alphabetic
Alphanumeric
Alphanumeric-edited
DBCS
When the usage is DISPLAY, the item is referred to as a display floating-point data
item.
Internal floating-point
National
National-edited
Numeric
Numeric-edited
Alignment rules
The standard alignment rules for positioning data in an elementary item depend
on the category of a receiving item.
A receiving item is an item into which the data is moved. For more details about a
receiving item, see Elementary moves on page 377).
Numeric
For numeric receiving items, the following rules apply:
1. The data is aligned on the assumed decimal point and, if necessary,
truncated or padded with zeros. (An assumed decimal point is one that
has logical meaning but that does not exist as an actual character in the
data.)
2. If an assumed decimal point is not explicitly specified, the receiving
item is treated as though an assumed decimal point is specified
immediately to the right of the field. The data is then treated according
to the preceding rule.
Numeric-edited
The data is aligned on the decimal point, and (if necessary) truncated or
padded with zeros at either end except when editing causes replacement of
leading zeros.
Internal floating-point
A decimal point is assumed immediately to the left of the field. The data is
then aligned on the leftmost digit position that follows the decimal point,
with the exponent adjusted accordingly.
For items described with USAGE DISPLAY-1 (category DBCS), 2 bytes of storage
are reserved for each character position described by the item's PICTURE
character-string.
For internal floating-point items, the size of the item in storage is determined by its
USAGE clause. USAGE COMPUTATIONAL-1 reserves 4 bytes of storage for the
item; USAGE COMPUTATIONAL-2 reserves 8 bytes of storage.
Normally, when an arithmetic item is moved from a longer field into a shorter one,
the compiler truncates the data to the number of digits represented in the shorter
item's PICTURE character-string by truncating leading digits. For example, if a
sending field with PICTURE S99999 that contains the value +12345 is moved to a
BINARY receiving field with PICTURE S99, the data is truncated to +45. For
additional information, see USAGE clause on page 230.
Signed data
There are two categories of algebraic signs used in COBOL: operational signs and
editing signs.
Operational signs
Operational signs are associated with signed numeric items, and indicate their
algebraic properties.
Editing signs
Editing signs are associated with numeric-edited items. Editing signs are PICTURE
symbols that identify the sign of the item in edited output.
FD file-name-1
EXTERNAL GLOBAL
IS IS
BLOCK integer-2 CHARACTERS
CONTAINS integer-1 TO RECORDS
RECORD integer-3
CONTAINS CHARACTERS
integer-4 TO integer-5
CONTAINS CHARACTERS
clause 1
DEPENDING data-name-1
ON
LABEL RECORD STANDARD
IS OMITTED
RECORDS
ARE
data-name-2
LINAGE data-name-5 clause 2 RECORDING mode
IS integer-8 LINES MODE IS
.
CODE-SET alphabet-name
IS
clause 1:
VARYING
IS IN SIZE integer-6 TO integer-7 CHARACTERS
FROM
clause 2:
FOOTING data-name-6 TOP data-name-7
WITH AT integer-9 LINES AT integer-10
BOTTOM data-name-8
LINES AT integer-11
FD file-name-1
EXTERNAL GLOBAL
IS IS
BLOCK integer-2 CHARACTERS
CONTAINS integer-1 TO RECORDS
RECORD integer-3
CONTAINS CHARACTERS
integer-4 TO integer-5
CONTAINS CHARACTERS
clause 1
DEPENDING data-name-1
ON
LABEL RECORD STANDARD
IS OMITTED
RECORDS
ARE
.
clause 1:
VARYING
IS IN SIZE integer-6 TO integer-7 CHARACTERS
FROM
FD file-name-1
EXTERNAL GLOBAL
IS IS
.
RECORD integer-3
CONTAINS CHARACTERS
clause 1
DEPENDING data-name-1
ON
clause 1:
VARYING
IS IN SIZE integer-6 TO integer-7 CHARACTERS
FROM
SD file-name-1
RECORD integer-3
CONTAINS CHARACTERS
integer-4 TO integer-5
CONTAINS CHARACTERS
clause 1
DEPENDING data-name-1
ON
BLOCK integer-2 CHARACTERS
CONTAINS integer-1 TO RECORDS
LABEL RECORD STANDARD
IS OMITTED
RECORDS
ARE
data-name-2
.
LINAGE data-name-5 clause 2 CODE-SET alphabet-name
IS integer-8 LINES IS
clause 1:
VARYING
IS IN SIZE integer-6 TO integer-7 CHARACTERS
FROM
clause 2:
FOOTING data-name-6 TOP data-name-7
WITH AT integer-9 LINES AT integer-10
BOTTOM data-name-8
LINES AT integer-11
EXTERNAL clause
The EXTERNAL clause specifies that a file connector is external, and permits
communication between two programs by the sharing of files.
A file connector is external if the storage associated with that file is associated with
the run unit rather than with any particular program within the run unit. An
external file can be referenced by any program in the run unit that describes the
file. References to an external file from different programs that use separate
descriptions of the file are always to the same file. In a run unit, there is only one
representative of an external file.
In the FILE SECTION, the EXTERNAL clause can be specified only in file
description entries.
The records appearing in the file description entry need not have the same name in
corresponding external file description entries. In addition, the number of such
records need not be the same in corresponding file description entries.
GLOBAL clause
The GLOBAL clause specifies that the file connector named by a file-name is a
global name. A global file-name is available to the program that declares it and to
every program that is contained directly or indirectly in that program.
A file-name is global if the GLOBAL clause is specified in the file description entry
for that file-name. A record-name is global if the GLOBAL clause is specified in the
record description entry by which the record-name is declared or, in the case of
record description entries in the FILE SECTION, if the GLOBAL clause is specified
in the file description entry for the file-name associated with the record description
entry. For details on using the GLOBAL clause, see Using data in input and output
operations and Scope of names in the Enterprise COBOL Programming Guide.
Two programs in a run unit can reference global file connectors in the following
circumstances:
v An external file connector can be referenced from any program that describes
that file connector.
v If a program is contained within another program, both programs can refer to a
global file connector by referring to an associated global file-name either in the
containing program or in any program that directly or indirectly contains the
containing program.
The CHARACTERS phrase indicates that the integer specified in the BLOCK
CONTAINS clause reflects the number of bytes in the record. For example, if you
have a block with 10 DBCS characters or 10 national characters, the BLOCK
CONTAINS clause should say BLOCK CONTAINS 20 CHARACTERS.
If the records in the file are not blocked, the BLOCK CONTAINS clause can be
omitted. When it is omitted, the compiler assumes that records are not blocked.
Even if each physical record contains only one complete logical record, coding
BLOCK CONTAINS 1 RECORD would result in fixed blocked records.
The BLOCK CONTAINS clause can be omitted when the associated file-control
entry specifies a VSAM file. The concept of blocking has no meaning for VSAM
files. The BLOCK CONTAINS clause is syntax checked but has no effect on the
execution of the program.
For external files, the value of all BLOCK CONTAINS clauses of corresponding
external files must match within the run unit. This conformance is in terms of
bytes and does not depend upon whether the value was specified as
CHARACTERS or as RECORDS.
integer-1 , integer-2
Must be unsigned integers. They specify:
For a way to apply BLOCK CONTAINS 0 to QSAM files that do not already have
a BLOCK CONTAINS clause, see the description of the compiler option, BLOCK0
in the Enterprise COBOL Programming Guide.
The BLOCK CONTAINS clause is syntax checked but has no effect on the
execution of the program when specified under an SD.
The BLOCK CONTAINS clause cannot be used with the RECORDING MODE U
clause.
For example, if you have a record with 10 DBCS characters, the RECORD clause
should say RECORD CONTAINS 20 CHARACTERS. For a record with 10 national
characters, the RECORD clause should say the same, RECORD CONTAINS 20
CHARACTERS.
The size of a record is determined according to the rules for obtaining the size of a
group item. (See USAGE clause on page 230 and SYNCHRONIZED clause
on page 225.)
When the RECORD clause is omitted, the compiler determines the record lengths
from the record descriptions. When one of the entries within a record description
contains an OCCURS DEPENDING ON clause, the compiler uses the maximum
value of the variable-length item to calculate the number of bytes needed to store
the record internally.
If the associated file connector is an external file connector, all file description
entries in the run unit that are associated with that file connector must specify the
same maximum number of bytes.
Format 1
Format 1 specifies the number of bytes for fixed-length records.
Format 1
RECORD integer-3
CONTAINS CHARACTERS
integer-3
Must be an unsigned integer that specifies the number of bytes contained
in each record in the file.
The RECORD CONTAINS 0 CHARACTERS clause can be specified for
input QSAM files containing fixed-length records; the record size is
determined at run time from the DD statement parameters or the data set
label. If, at run time, the actual record is larger than the 01 record
description, then only the 01 record length is available. If the actual record
is shorter, then only the actual record length can be referred to. Otherwise,
uninitialized data or an addressing exception can be produced.
Usage note: If the RECORD CONTAINS 0 clause is specified, then the
SAME AREA, SAME RECORD AREA, or APPLY WRITE-ONLY clauses
cannot be specified.
Do not specify the RECORD CONTAINS 0 clause for an SD entry.
Fixed-length records are obtained when all 01 record description entry lengths are
the same. The format-2 RECORD CONTAINS clause is never required, because the
minimum and maximum record lengths are determined from the record
description entries.
Format 2
integer-4, integer-5
Must be unsigned integers. integer-4 specifies the size of the smallest data
record, and integer-5 specifies the size of the largest data record.
Format 3
Format 3 is used to specify variable-length records.
Format 3
RECORD VARYING
IS IN SIZE integer-6
FROM
TO integer-7 CHARACTERS DEPENDING data-name-1
ON
integer-6
Specifies the minimum number of bytes to be contained in any record of
the file. If integer-6 is not specified, the minimum number of bytes to be
contained in any record of the file is equal to the least number of bytes
described for a record in that file.
integer-7
Specifies the maximum number of bytes in any record of the file. If
integer-7 is not specified, the maximum number of bytes to be contained in
any record of the file is equal to the greatest number of bytes described for
a record in that file.
If data-name-1 is specified:
v data-name-1 must be an elementary unsigned integer.
v The number of bytes in the record must be placed into the data item referenced
by data-name-1 before any RELEASE, REWRITE, or WRITE statement is executed
for the file.
v The execution of a DELETE, RELEASE, REWRITE, START, or WRITE statement
or the unsuccessful execution of a READ or RETURN statement does not alter
the content of the data item referenced by data-name-1.
v After the successful execution of a READ or RETURN statement for the file, the
contents of the data item referenced by data-name-1 indicate the number of bytes
in the record just read.
During the execution of a READ ... INTO or RETURN ... INTO statement, the
number of bytes in the current record that participate as the sending data items in
the implicit MOVE statement is determined by the following conditions:
v If data-name-1 is specified, by the content of the data item referenced by
data-name-1
v If data-name-1 is not specified, by the value that would have been moved into
the data item referenced by data-name-1 had data-name-1 been specified
VALUE OF clause
The VALUE OF clause describes an item in the label records associated with the
file.
data-name-3
Should be qualified when necessary, but cannot be subscripted. It must be
described in the WORKING-STORAGE SECTION. It cannot be described
with the USAGE IS INDEX clause.
literal-1
Can be numeric or alphanumeric, or a figurative constant of category
numeric or alphanumeric. Cannot be a floating-point literal.
The VALUE OF clause is syntax checked, but has no effect on the execution of the
program.
The data-name need not have an associated 01 level number record description
with the same name.
LINAGE clause
The LINAGE clause specifies the depth of a logical page in number of lines.
Optionally, it also specifies the line number at which the footing area begins and
the top and bottom margins of the logical page. (The logical page and the physical
page cannot be the same size.)
The following figure illustrates the use of each phrase of the LINAGE clause.
The logical page size specified in the LINAGE clause is the sum of all values
specified in each phrase except the FOOTING phrase. If the LINES AT TOP phrase
is omitted, the assumed value for the top margin is zero. Similarly, if the LINES AT
BOTTOM phrase is omitted, the assumed value for the bottom margin is zero.
Each logical page immediately follows the preceding logical page, with no
additional spacing provided.
If the FOOTING phrase is omitted, its assumed value is equal to that of the page
body (integer-8 or data-name-5).
At the time an OPEN statement with the OUTPUT phrase is executed for the file,
data-name-5, data-name-6, data-name-7, and data-name-8 determine the page body,
first footing line, top margin, and bottom margin for the first logical page only.
At the time a WRITE statement with the ADVANCING PAGE phrase is executed
or a page overflow condition occurs, the values of data-name-5, data-name-6,
data-name-7, and data-name-8 if specified, are used to determine the page body, first
footing line, top margin, and bottom margin for the next logical page.
If an external file connector is associated with this file description entry, all file
description entries in the run unit that are associated with this file connector must
have:
See ADVANCING phrase on page 462 for the behavior of carriage control
characters in external files.
If the RECORDING MODE clause is not specified for a QSAM file, the Enterprise
COBOL compiler determines the recording mode as follows:
F The compiler determines the recording mode to be F if the largest level-01
record associated with the file is not greater than the block size specified in
the BLOCK CONTAINS clause, and you do one of the following things:
v Use the RECORD CONTAINS integer clause. (For more information, see
the Enterprise COBOL Migration Guide.)
v Omit the RECORD clause and make sure that all level-01 records
associated with the file are the same size and none contains an OCCURS
DEPENDING ON clause.
V The compiler determines the recording mode to be V if the largest level-01
record associated with the file is not greater than the block size specified in
the BLOCK CONTAINS clause, and you do one of the following things:
v Use the RECORD IS VARYING clause.
v Omit the RECORD clause and make sure that all level-01 records
associated with the file are not the same size or some contain an
OCCURS DEPENDING ON clause.
v Use the RECORD CONTAINS integer-1 TO integer-2 clause, with integer-1
the minimum length and integer-2 the maximum length of the level-01
records associated with the file. The two integers must be different, with
values matching minimum and maximum length of either different
length records or records with an OCCURS DEPENDING ON clause.
S The compiler determines the recording mode to be S if the maximum block
size is smaller than the largest record size.
U Recording mode U is never obtained by default. The RECORDING MODE
U clause must be explicitly specified to get recording mode U.
CODE-SET clause
The CODE-SET clause specifies the character code used to represent data on a
magnetic tape file. When the CODE-SET clause is specified, an alphabet-name
identifies the character code convention used to represent data on the input-output
device.
The CODE-SET clause also specifies the algorithm for converting the character
codes on the input-output medium from and to the internal EBCDIC character set.
When the CODE-SET clause is specified for a file, all data in the file must have
USAGE DISPLAY; and if signed numeric data is present, it must be described with
the SIGN IS SEPARATE clause.
When the CODE-SET clause is omitted, the EBCDIC character set is assumed for
the file.
The CODE-SET clause is syntax checked but has no effect on the execution of the
program when specified under an SD.
Data description entries that define independent data items do not make up a
record. These entries are known as data item description entries.
Data description entries have three general formats, and all data description entries
must end with a separator period.
Format 1
Format 1 is used for data description entries in all DATA DIVISION sections.
| level-number
| data-name-1 redefines-clause blank-when-zero-clause
FILLER
|
| external-clause global-clause group-usage-clause justified-clause
|
| occurs-clause picture-clause sign-clause synchronized-clause
|
| usage-clause value-clause volatile-clause
|
||
The level-number in format 1 can be any number in the range 0149, or 77.
Format 2
Format 2 regroups previously defined items.
66 data-name-1 renames-clause.
A level-66 entry cannot rename another level-66 entry, nor can it rename a level-01,
level-77, or level-88 entry.
All level-66 entries associated with one record must immediately follow the last
data description entry in that record.
Format 3
Format 3 describes condition-names.
Format 3: condition-name
88 condition-name-1 value-clause.
condition-name-1
A user-specified name that associates a value, a set of values, or a range of
values with a conditional variable.
Level-88 entries must immediately follow the data description entry for the
conditional variable with which the condition-names are associated.
Level-numbers
The level-number specifies the hierarchy of data within a record, and identifies
special-purpose data entries. A level-number begins a data description entry, a
renamed or redefined item, or a condition-name entry.
A level-number has an integer value between 1 and 49, inclusive, or one of the
special level-number values 66, 77, or 88.
level-number
data-name-1
FILLER
level-number
01 and 77 must begin in Area A and be followed either by a separator
period or by a space followed by its associated data-name, FILLER, or
appropriate data description clause.
Level numbers 02 through 49 can begin in Areas A or B and must be
followed by a space or a separator period.
Level numbers 66 and 88 can begin in Areas A or B and must be followed
by a space.
Single-digit level-numbers 1 through 9 can be substituted for
level-numbers 01 through 09.
Successive data description entries can start in the same column as the first
entry or can be indented according to the level-number. Indentation does
not affect the magnitude of a level-number.
When level-numbers are indented, each new level-number can begin any
number of spaces to the right of Area A. The extent of indentation to the
right is limited only by the width of Area B.
For more information, see Levels of data on page 161.
data-name-1
Explicitly identifies the data being described.
data-name-1, if specified, identifies a data item used in the program.
data-name-1 must be the first word following the level-number.
The data item can be changed during program execution.
data-name-1 must be specified for level-66 and level-88 items. It must also
be specified for any entry containing the GLOBAL or EXTERNAL clause,
and for record description entries associated with file description entries
that have the GLOBAL or EXTERNAL clauses.
FILLER
A data item that is not explicitly referred to in a program. The keyword
FILLER is optional. If specified, FILLER must be the first word following
the level-number.
The keyword FILLER can be used with a conditional variable if explicit
reference is never made to the conditional variable but only to values that
it can assume. FILLER cannot be used with a condition-name.
In a MOVE CORRESPONDING statement or in an ADD
CORRESPONDING or SUBTRACT CORRESPONDING statement, FILLER
items are ignored. In an INITIALIZE statement, elementary FILLER items
are ignored.
If data-name-1 or the FILLER clause is omitted, the data item being described is
treated as though FILLER had been specified.
Format
BLANK ZERO
WHEN ZEROS
ZEROES
The BLANK WHEN ZERO clause may be specified only for an elementary item
described by its picture character string as category numeric-edited or numeric,
without the picture symbol S or *. These items must be described, either implicitly
or explicitly, as USAGE DISPLAY or USAGE NATIONAL.
A BLANK WHEN ZERO clause that is specified for an item defined as numeric by
its picture character string defines the item as category numeric-edited.
EXTERNAL clause
The EXTERNAL clause specifies that the storage associated with a data item is
associated with the run unit rather than with any particular program or method
within the run unit.
An external data item can be referenced by any program or method in the run unit
that describes the data item. References to an external data item from different
programs or methods using separate descriptions of the data item are always to
the same data item. In a run unit, there is only one representative of an external
data item.
The EXTERNAL clause can be specified only on data description entries whose
level-number is 01. It can be specified only on data description entries that are in
the WORKING-STORAGE SECTION of a program or method. It cannot be
specified in LINKAGE SECTION or FILE SECTION data description entries. Any
data item described by a data description entry subordinate to an entry that
describes an external record also attains the external attribute. Indexes in an
external data record do not possess the external attribute.
The data contained in the record named by the data-name clause is external and
can be accessed and processed by any program or method in the run unit that
describes and, optionally, redefines it. This data is subject to the following rules:
v If two or more programs or methods within a run unit describe the same
external data record, each record-name of the associated record description
entries must be the same, and the records must define the same number of
bytes. However, a program or method that describes an external record can
contain a data description entry including the REDEFINES clause that redefines
the complete external record, and this complete redefinition need not occur
identically in other programs or methods in the run unit.
v Use of the EXTERNAL clause does not imply that the associated data-name is a
global name.
In the same DATA DIVISION, the data description entries for any two data items
for which the same data-name is specified must not include the GLOBAL clause.
Two programs in a run unit can reference common data in the following
circumstances:
v The data content of an external data record can be referenced from any program
that describes the data record as external.
v If a program is contained within another program, both programs can refer to
data that possesses the global attribute either in the containing program or in
any program that directly or indirectly contains the containing program.
JUSTIFIED clause
The JUSTIFIED clause overrides standard positioning rules for receiving items of
category alphabetic, alphanumeric, DBCS, or national.
Format
JUSTIFIED
JUST RIGHT
You can specify the JUSTIFIED clause only at the elementary level. JUST is an
abbreviation for JUSTIFIED, and has the same meaning.
When the JUSTIFIED clause is specified for a receiving item, the data is aligned at
the rightmost character position in the receiving item. Also:
v If the sending item is larger than the receiving item, the leftmost character
positions are truncated.
v If the sending item is smaller than the receiving item, the unused character
positions at the left are filled with spaces. For a DBCS item, each unused
position is filled with a DBCS space (X'4040'); for an item described with usage
NATIONAL, each unused position is filled with the default Unicode space
(NX'0020'); otherwise, each unused position is filled with an alphanumeric space.
If you omit the JUSTIFIED clause, the rules for standard alignment are followed
(see Alignment rules on page 168).
The JUSTIFIED clause does not affect initial settings as determined by the VALUE
clause.
GROUP-USAGE clause
A GROUP-USAGE clause with the NATIONAL phrase specifies that the group
item defined by the entry is a national group item. A national group item contains
national characters in all subordinate data items and subordinate group items.
Format
GROUP-USAGE NATIONAL
IS
The table below summarizes the cases where a national group item is processed as
a group item.
Table 11. Where national group items are processed as groups
Language feature Processing of national group items
Name qualification The name of a national group item can be used to qualify the names of
elementary data items and subordinate group items in the national group. The
rules of qualification for a national group are the same as the rules of
qualification for an alphanumeric group.
RENAMES clause The rules for a national group item specified in the THROUGH phrase are the
same as the rules for an alphanumeric group item specified in the THROUGH
phrase. The result is an alphanumeric group item.
CORRESPONDING phrase A national group item is processed as a group in accordance with the rules of
the CORRESPONDING phrase. Elementary data items within a national group
are processed the same as they would be if defined within an alphanumeric
group.
INITIALIZE statement A national group item is processed as a group in accordance with the rules of
the INITIALIZE statement. Elementary items within the national group are
initialized the same as they would be if defined within an alphanumeric
group.
XML GENERATE statement A national group item specified in the FROM phrase is processed as a group in
accordance with the rules of the XML GENERATE statement. Elementary items
within the national group are processed the same as they would be if defined
within an alphanumeric group.
OCCURS clause
The DATA DIVISION language elements used for table handling are the OCCURS
clause and the INDEXED BY phrase.
For the INDEXED BY phrase description, see INDEXED BY phrase on page 196.
The OCCURS clause specifies tables whose elements can be referred to by indexing
or subscripting. It also eliminates the need for separate entries for repeated data
items.
Formats for the OCCURS clause include fixed-length tables and variable-length
tables.
The subject of an OCCURS clause is the data-name of the data item that contains
the OCCURS clause. Except for the OCCURS clause itself, data description clauses
used with the subject apply to each occurrence of the item described.
When subscripted or indexed, the subject refers to one occurrence within the table,
unless the ALL subscript is used in an intrinsic function.
Fixed-length tables
Fixed-length tables are specified using the OCCURS clause.
Because seven subscripts or indexes are allowed, six nested levels and one
outermost level of the format-1 OCCURS clause are allowed. The format-1
OCCURS clause can be specified as subordinate to the OCCURS DEPENDING ON
clause. In this way, a table of up to seven dimensions can be specified.
OCCURS integer-2
TIMES
ASCENDING data-name-2
DESCENDING KEY IS
INDEXED index-name-1
BY
integer-2
The exact number of occurrences. integer-2 must be greater than zero.
The order is determined by the rules for comparison of operands (see Relation
| conditions on page 263). The ASCENDING KEY and DESCENDING KEY data
| items are used in OCCURS clauses, the SEARCH ALL statements for a binary
| search of the table element, and the format 2 SORT statements. As an alternative,
| keys can be specified with the format 2 SORT statements.
data-name-2
Must be the name of the subject entry or the name of an entry subordinate
to the subject entry. data-name-2 can be qualified.
If data-name-2 names the subject entry, that entire entry becomes the
ASCENDING KEY or DESCENDING KEY and is the only key that can be
specified for this table element.
If data-name-2 does not name the subject entry, then data-name-2:
v Must be subordinate to the subject of the table entry itself
v Must not be subordinate to, or follow, any other entry that contains an
OCCURS clause
v Must not contain an OCCURS clause
data-name-2 must not have subordinate items that contain OCCURS
DEPENDING ON clauses.
The keys for EMPLOYEE-TABLE are subordinate to that entry, and the key for
WEEK-RECORD is subordinate to that subordinate entry.
INDEXED BY phrase
The INDEXED BY phrase specifies the indexes that can be used with a table. A
table without an INDEXED BY phrase can be referred to through indexing by
using an index-name associated with another table.
For more information about using indexing, see Subscripting using index-names
(indexing) on page 75.
Indexes normally are allocated in static memory associated with the program that
contains the table. Thus indexes are in the last-used state when a program is
reentered. However, in the following cases, indexes are allocated on a
per-invocation basis. Thus you must set the value of the index on every entry for
indexes on tables in the following sections:
v The LOCAL-STORAGE SECTION
v The WORKING-STORAGE SECTION of a class definition (object instance
variables)
v The LINKAGE SECTION of:
Methods
Programs compiled with the RECURSIVE clause
Programs compiled with the THREAD option
Indexes specified in an external data record do not possess the external attribute.
index-name-1
Each index-name specifies an index to be created by the compiler for use
by the program. These index-names are not data-names and are not
Variable-length tables
You can specify variable-length tables by using the OCCURS DEPENDING ON
clause.
data-name-1
ASCENDING data-name-2
DESCENDING KEY IS
INDEXED index-name-1
BY
integer-1
The minimum number of occurrences.
The value of integer-1 must be greater than or equal to zero, and it must
also be less than the value of integer-2.
If integer-1 is omitted, a value of 1 is assumed and the keyword TO must
also be omitted.
integer-2
The maximum number of occurrences.
integer-2 must be greater than integer-1.
The length of the subject item is fixed. Only the number of repetitions of the subject
item is variable.
All data-names used in the OCCURS clause can be qualified; they cannot be
subscripted or indexed.
At the time that the group item, or any data item that contains a subordinate
OCCURS DEPENDING ON item or that follows but is not subordinate to the
OCCURS DEPENDING ON item, is referenced, the value of the object of the
OCCURS DEPENDING ON clause must fall within the range integer-1 through
integer-2, if integer-2 is specified (that is, if the table is not UNBOUNDED).
The behavior is undefined if the value of the object is outside of the range integer-1
through integer-2.
Note:
The maximum length rule does not apply to unbounded groups. For unbounded
groups, based on the current run time value of the OCCURS DEPENDING ON
objects, the actual length of the group is used for all references to the group.
Consequently, before any COBOL statement that references an unbounded group
runs, you must set the OCCURS DEPENDING ON objects for that group.
The INDEXED BY phrase can be specified for a table that has a subordinate item
that contains an OCCURS DEPENDING ON clause.
For more information about complex OCCURS DEPENDING ON, see Complex
OCCURS DEPENDING ON in the Enterprise COBOL Programming Guide.
The ASCENDING KEY phrase, the DESCENDING KEY phrase, and the INDEXED
BY clause are described under Fixed-length tables on page 194.
PICTURE clause
The PICTURE clause specifies the general characteristics and editing requirements
of an elementary item.
PICTURE character-string
PIC IS
PICTURE or PIC
The PICTURE clause must be specified for every elementary item except
the following ones:
v Index data items
v The subject of the RENAMES clause
v Items described with USAGE POINTER, USAGE FUNCTION-POINTER,
USAGE PROCEDURE-POINTER, or USAGE OBJECT REFERENCE
v Internal floating-point data items
In these cases, use of the PICTURE clause is prohibited.
The PICTURE clause can be specified only at the elementary level.
PIC is an abbreviation for PICTURE and has the same meaning.
character-string
character-string is made up of certain COBOL characters used as picture
symbols. The allowable combinations determine the category of the
elementary data item.
character-string can contain a maximum of 50 characters.
The lowercase letters that correspond to the uppercase letters that represent the
following PICTURE symbols are equivalent to their uppercase representations in a
PICTURE character-string:
A, B, E, G, N, P, S, V, X, Z, CR, DB
All other lowercase letters are not equivalent to their corresponding uppercase
representations.
Table 12 on page 202 defines the meaning of each PICTURE clause symbol. The
heading Size indicates how the item is counted in determining the number of
character positions in the item. The type of the character positions depends on the
USAGE clause specified for the item, as follows:
* A check protect symbol: a leading numeric Each asterisk is counted as one character position
character position into which an asterisk is placed in the size of the item.
when that position contains a zero.
cs cs can be any valid currency symbol. A currency The first occurrence of a currency symbol adds the
symbol represents a character position into which number of characters in the currency sign value to
a currency sign value is placed. The default the size of the data item. Each subsequent
currency symbol is the character assigned the occurrence adds one character position to the size
value X'5B' in the code page in effect at compile of the data item.
time. In this document, the default currency
symbol is represented by the dollar sign ($) and cs
stands for any valid currency symbol. For details,
see Currency symbol on page 205.
The following figure shows the sequences in which picture symbols can be
specified to form picture character-strings. More detailed explanations of PICTURE
clause symbols follow the figure.
The symbol P specifies a scaling position and implies an assumed decimal point
(to the left of the Ps if the Ps are leftmost PICTURE characters; to the right of the
Ps if the Ps are rightmost PICTURE characters).
In all other operations, the digit positions specified with the symbol P are ignored
and are not counted in the size of the operand.
Currency symbol
Unlike all other picture symbols, currency symbols are case sensitive. For example,
'D' and 'd' specify different currency symbols.
A currency symbol can be used only to define a numeric-edited item with USAGE
DISPLAY.
Character-string representation
The topic lists symbols that can appear once or more than once in the PICTURE
character-string.
Symbols that can appear more than once
The following symbols can appear more than once in one PICTURE
character-string:
A B G N P X Z 9 0 / , + * cs
Except for the PICTURE symbol V, each occurrence of any of the above
symbols in a given PICTURE character-string represents an occurrence of
that character or set of allowable characters in the data item.
Note: Category internal floating point is defined by a USAGE clause that specifies
the COMP-1 or COMP-2 phrase.
Alphabetic items
The content of the item must consist only of letters of the Latin alphabet and the
space character.
Other clauses
USAGE DISPLAY must be specified or implied.
Any associated VALUE clause must specify an alphanumeric literal
containing only alphabetic characters, SPACE, or a symbolic-character as
the value of a figurative constant.
Do not include a single byte character in a DBCS data item.
When padding is required for a DBCS data item, the following rules apply:
Numeric items
The type of a numeric item is defined by the usage clause as shown in the table
below.
Table 13. Numeric types
Type USAGE clause
Binary BINARY, COMP, COMP-4, or COMP-5
Internal decimal PACKED-DECIMAL, COMP-3
Zoned decimal (external decimal) DISPLAY
National decimal (external decimal) NATIONAL
For all numeric fields, the PICTURE character-string can contain only the symbols
9, P, S, and V.
The symbol S can be written only as the leftmost character in the PICTURE
character-string.
For binary items, the number of digit positions must range from 1 through 18
inclusive. For packed decimal and zoned decimal items the number of digit
positions must range from 1 through 18, inclusive, when the ARITH(COMPAT)
compiler option is in effect, or from 1 through 31, inclusive, when the
ARITH(EXTEND) compiler option is in effect.
If unsigned, the contents of the item in standard data format must contain a
combination of the Arabic numerals 0-9. If signed, it can also contain a +, -, or
other representation of the operational sign.
Examples of valid ranges
PICTURE Valid range of values
9999 0 through 9999
S99 -99 through +99
S999V9 -999.9 through +999.9
PPP999 0 through .000999
S999PPP -1000 through -999000 and
+1000 through +999000 or zero
Other clauses
Numeric-edited items
The combinations of symbols allowed are determined from the PICTURE clause
symbol order allowed (see the figure in Symbols used in the PICTURE clause on
page 201), and the editing rules (see PICTURE clause editing on page 212).
Alphanumeric items
The contents of the item in standard data format can be any allowable characters
from the character set of the computer.
Other clauses
USAGE DISPLAY must be specified or implied.
Any associated VALUE clause must specify an alphanumeric literal or one
of the following figurative constants:
v ZERO
v SPACE
v QUOTE
v HIGH-VALUE
v LOW-VALUE
v symbolic-character
v ALL alphanumeric-literal
Alphanumeric-edited items
The string must contain at least one A or X, and at least one B or 0 (zero) or /.
The contents of the item in standard data format must be two or more characters
from the character set of the computer.
Other clauses
USAGE DISPLAY must be specified or implied.
Any associated VALUE clause must specify an alphanumeric literal or or
one of the following figurative constants:
v ZERO
v SPACE
v QUOTE
v HIGH-VALUE
v LOW-VALUE
v symbolic-character
v ALL alphanumeric-literal
The literal is treated exactly as specified; no editing is done.
DBCS items
Any associated VALUE clause must contain a DBCS literal, the figurative constant
SPACE, or the figurative constant ALL DBCS-literal.
Other clauses
National items
The PICTURE character-string can contain one or more occurrences of the picture
symbol N.
National-edited items
The PICTURE character-string must contain at least one symbol N, and at least one
instance of one of these symbols: B 0 (zero) or / (slash).
Format
+ mantissa E + exponent
- -
+ or - A sign character must immediately precede both the mantissa and the
exponent.
For items defined with usage DISPLAY, each picture symbol except V defines one
alphanumeric character position in the item.
For items defined with usage NATIONAL, each picture symbol except V defines
one national character position in the item.
Other clauses
The DISPLAY phrase or the NATIONAL phrase of the USAGE clause must
be specified or implied.
The OCCURS, REDEFINES, and RENAMES clauses can be associated with
external floating-point items.
The SIGN clause is accepted as documentation and has no effect on the
representation of the sign.
The SYNCHRONIZED clause is treated as documentation.
The following clauses are invalid with external floating-point items:
v BLANK WHEN ZERO
v JUSTIFIED
v VALUE
The type of editing allowed for an item depends on its data category. The type of
editing that is valid for each category is shown in the following table. cs indicates
any valid currency symbol.
Table 14. Data categories
Data category Type of editing Insertion symbol
Alphabetic None None
Numeric None None
Numeric-edited Simple insertion B0/,
Special insertion .
Fixed insertion cs + - CR DB
Floating insertion cs + -
Zero suppression Z*
Replacement Z * + - cs
Alphanumeric None None
Alphanumeric-edited Simple insertion B0/
DBCS Simple insertion B
External floating-point Special insertion .
National None None
National-edited Simple insertion B0/
Each insertion symbol is counted in the size of the item, and represents the
position within the item where the equivalent character is to be inserted. For
edited DBCS items, each insertion symbol (B) is counted in the size of the item and
represents the position within the item where the DBCS space is to be inserted.
Chapter 18. DATA DIVISION--data description entry 213
For example:
Notes:
1. The symbol b represents a space.
The period (.) is the special insertion symbol; it also represents the actual decimal
point for alignment purposes.
The period insertion symbol is counted in the size of the item, and represents the
position within the item where the actual decimal point is inserted.
Either the actual decimal point or the symbol V as the assumed decimal point, but
not both, must be specified in one PICTURE character-string.
For example:
In fixed insertion editing, only one currency symbol and one editing-sign control
symbol can be specified in a PICTURE character-string.
When either + or - is used as a symbol, it must be the first or last character in the
character-string.
Editing sign control symbols produce results that depend on the value of the data
item, as shown below:
For example:
The second leftmost floating insertion symbol in the character-string represents the
leftmost limit at which numeric data can appear within the data item. Nonzero
numeric data can replace all characters at or to the right of this limit.
To avoid truncation, the minimum size of the PICTURE character-string must be:
v The number of character positions in the sending item, plus
v The number of nonfloating insertion symbols in the receiving item, plus
v One character position for the floating insertion symbol
For example:
++,+++,+++.+++ 0000.00
In zero suppression editing, the symbols Z and * are used. These symbols are
mutually exclusive in one PICTURE character-string.
Z * + - cs
For example:
ZZZZ.ZZ 0000.00
Do not specify both the asterisk (*) as a suppression symbol and the BLANK
WHEN ZERO clause for the same entry.
Format
(level-number, data-name-1, and FILLER are not part of the REDEFINES clause, and
are included in the format only for clarity.)
When specified, the REDEFINES clause must be the first entry following
data-name-1 or FILLER. If data-name-1 or FILLER is not specified, the REDEFINES
clause must be the first entry following the level-number.
data-name-1, FILLER
Identifies an alternate description for the data area identified by
data-name-2; data-name-1 is the redefining item or the REDEFINES subject.
Neither data-name-1 nor any of its subordinate entries can contain a VALUE
clause.
data-name-2
Identifies the redefined item or the REDEFINES object.
The data description entry for data-name-2 can contain a REDEFINES
clause.
The data description entry for data-name-2 cannot contain an OCCURS
clause. However, data-name-2 can be subordinate to an item whose data
description entry contains an OCCURS clause; in this case, the reference to
data-name-2 in the REDEFINES clause must not be subscripted.
data-name-1 and data-name-2 must have the same level in the hierarchy; however,
the level numbers need not be the same. Neither data-name-1 nor data-name-2 can
be defined with level number 66 or 88.
If the GLOBAL clause is used in the data description entry that contains the
REDEFINES clause, only data-name-1 (the redefining item) possesses the global
attribute. For example, in the following description, only item B possesses the
GLOBAL attribute:
05 A PICTURE X(6).
05 B REDEFINES A GLOBAL PICTURE X(4).
The EXTERNAL clause must not be specified in the same data description entry as
a REDEFINES clause.
The following example shows that the redefining item, B, can occupy more storage
than the redefined item, A. The size of storage for the REDEFINED clause is
determined in number of bytes. Item A occupies 6 bytes of storage and item B, a
data item of category national, occupies 8 bytes of storage.
05 A PICTURE X(6).
05 B REDEFINES A GLOBAL PICTURE N(4).
One or more redefinitions of the same storage area are permitted. The entries that
give the new descriptions of the storage area must immediately follow the
description of the redefined area without intervening entries that define new
character positions. Multiple redefinitions can, but need not, all use the data-name
of the original entry that defined this storage area. For example:
05 A PICTURE 9999.
05 B REDEFINES A PICTURE 9V999.
05 C REDEFINES A PICTURE 99V99.
Also, multiple redefinitions can use the name of the preceding definition as shown
in the following example:
05 A PICTURE 9999.
05 B REDEFINES A PICTURE 9V999.
05 C REDEFINES B PICTURE 99V99.
When the data item implicitly redefines multiple 01-level records in a file
description (FD) entry, items subordinate to the redefining or redefined item can
contain an OCCURS DEPENDING ON clause.
When an area is redefined, all descriptions of the area are always in effect; that is,
redefinition does not supersede a previous description. Thus, if B REDEFINES C has
been specified, either of the two procedural statements MOVE X TO B or MOVE Y TO C
The usage of a redefining data item need not be the same as that of a redefined
item. This does not, however, cause any change in the format or content of existing
data. For example:
05 B PICTURE 99 USAGE DISPLAY VALUE 8.
05 C REDEFINES B PICTURE S99 USAGE COMPUTATIONAL-4.
05 A PICTURE S99 USAGE COMPUTATIONAL-4.
Redefining B does not change the bit configuration of the data in the storage area.
Therefore, the following two statements produce different results:
ADD B TO A
ADD C TO A
In the first case, the value 8 is added to A (because B has USAGE DISPLAY). In the
second statement, the value -3848 is added to A (because C has USAGE
COMPUTATIONAL-4), and the bit configuration of the storage area has the binary
value -3848. This example demonstrates how the improper use of redefinition can
give unexpected or incorrect results.
Data items within an area can be redefined without changing their lengths. For
example:
Data item lengths and types can also be respecified within an area. For example:
05 NAME-2.
10 SALARY PICTURE XXX.
10 SO-SEC-NO PICTURE X(9).
10 MONTH PICTURE XX.
05 NAME-1 REDEFINES NAME-2.
10 WAGE PICTURE 999V999.
10 EMP-NO PICTURE X(6).
10 YEAR PICTURE XX.
Data items can also be respecified with a length that is greater than the length of
the redefined item. For example:
05 NAME-2.
10 SALARY PICTURE XXX.
10 SO-SEC-NO PICTURE X(9).
10 MONTH PICTURE XX.
05 NAME-1 REDEFINES NAME-2.
10 WAGE PICTURE 999V999.
10 EMP-NO PICTURE X(6).
10 YEAR PICTURE X(4).
This does not change the length of the redefined item NAME-2.
Undefined results
Undefined results can occur in the conditions as listed in the topic.
v A redefining item is moved to a redefined item (that is, if B REDEFINES C and the
statement MOVE B TO C is executed).
v A redefined item is moved to a redefining item (that is, if B REDEFINES C and the
statement MOVE C TO B is executed).
RENAMES clause
The RENAMES clause specifies alternative and possibly overlapping groupings of
elementary data items.
Format
The special level-number 66 must be specified for data description entries that
contain the RENAMES clause. (Level-number 66 and data-name-1 are not part of
the RENAMES clause, and are included in the format only for clarity.)
Usage note: The group defined with the THROUGH phrase can include data items
of usage NATIONAL.
The leftmost character position in data-name-3 must not precede the leftmost
character position in data-name-2, and the rightmost character position in
data-name-3 must not precede the rightmost character position in data-name-2. This
means that data-name-3 cannot be totally subordinate to data-name-2.
The following figure illustrates valid and invalid RENAMES clause specifications.
Example 1 (Valid)
RECORD-I
01 RECORD-I.
05 DN-1... . DN-1 DN-2 DN-3 DN-4
05 DN-2... .
05 DN-3... .
05 DN-4... .
66 DN-6 RENAMES DN-1 THROUGH DN-3. DN-6
Example 3 (Invalid)
RECORD-III
01 RECORD-III.
DN-2
05 DN-2.
10 DN-3... . DN-3 DN-4 DN-5
10 DN-4... .
05 DN-5... .
66 DN-6 RENAMES DN-2 THROUGH DN-3. DN-6 is indeterminate
SIGN clause
The SIGN clause specifies the position and mode of representation of the
operational sign for the signed numeric item to which it applies.
The SIGN clause is required only when an explicit description of the properties or
position of the operational sign is necessary.
LEADING
SIGN TRAILING SEPARATE
IS CHARACTER
The SIGN clause can be specified only for the following items:
v An elementary numeric data item of usage DISPLAY or NATIONAL that is
described with an S in its picture character string, or
v A group item that contains at least one such elementary entry as a subordinate
item
When the SIGN clause is specified at the group level, that SIGN clause applies
only to subordinate signed numeric elementary data items of usage DISPLAY or
NATIONAL. Such a group can also contain items that are not affected by the SIGN
clause. If the SIGN clause is specified for a group or elementary entry that is
subordinate to a group item that has a SIGN clause, the SIGN clause for the
subordinate entry takes precedence for that subordinate entry.
When the SIGN clause is specified without the SEPARATE phrase, USAGE
DISPLAY must be specified explicitly or implicitly. When SIGN IS SEPARATE is
specified, either USAGE DISPLAY or USAGE NATIONAL can be specified.
If you specify the CODE-SET clause in an FD entry, any signed numeric data
description entries associated with that file description entry must be described
with the SIGN IS SEPARATE clause.
Format
SYNCHRONIZED
SYNC LEFT
RIGHT
The SYNCHRONIZED clause can be specified for elementary items and for
level-01 group items, in which case every elementary item within the group item is
synchronized.
LEFT Specifies that the elementary item is to be positioned so that it will begin
at the left character position of the natural boundary in which the
elementary item is placed.
RIGHT
Specifies that the elementary item is to be positioned such that it will
terminate on the right character position of the natural boundary in which
it has been placed.
When specified, the LEFT and the RIGHT phrases are syntax checked but have no
effect on the execution of the program.
The following table lists the effect of the SYNCHRONIZE clause on other language
elements.
Table 15. SYNCHRONIZE clause effect on other language elements
Language element Comments
OCCURS clause When specified for an item within the scope of an OCCURS clause,
each occurrence of the item is synchronized.
USAGE DISPLAY or Each item is syntax checked, but the SYNCHRONIZED clause has
PACKED-DECIMAL no effect on execution.
USAGE NATIONAL Each item is syntax checked, but the SYNCHRONIZED clause has
no effect on execution.
In the FILE SECTION, the compiler assumes that all level-01 records that contain
SYNCHRONIZED items are aligned on doubleword boundaries in the buffer. You
must provide the necessary slack bytes between records to ensure alignment when
there are multiple records in a block.
Slack bytes
There are two types of slack bytes.
v Slack bytes within records: unused character positions that precede each
synchronized item in the record
v Slack bytes between records: unused character positions added between blocked
logical records
Because it is important that you know the length of the records in a file, you need
to determine whether slack bytes are required and, if so, how many bytes the
compiler will add. The algorithm that the compiler uses is as follows:
v The total number of bytes occupied by all elementary data items that precede
the binary item are added together, including any slack bytes that are previously
added.
v This sum is divided by m, where:
m = 2 for binary items of four-digit length or less
m = 4 for binary items of five-digit length or more and for
COMPUTATIONAL-1 data items
m = 4 for data items described with USAGE INDEX, USAGE POINTER,
USAGE PROCEDURE-POINTER, USAGE OBJECT REFERENCE, or USAGE
FUNCTION-POINTER
m = 8 for COMPUTATIONAL-2 data items
v If the remainder (r) of this division is equal to zero, no slack bytes are required.
If the remainder is not equal to zero, the number of slack bytes that must be
added is equal to m - r.
These slack bytes are added to each record immediately following the elementary
data item that precedes the binary item. They are defined as if they constitute an
item with a level-number equal to that of the elementary item that immediately
precedes the SYNCHRONIZED binary item, and are included in the size of the
group that contains them.
For example:
01 FIELD-A.
05 FIELD-B PICTURE X(5).
05 FIELD-C.
10 FIELD-D PICTURE XX.
[10 SLACK-BYTES PICTURE X. INSERTED BY COMPILER]
10 FIELD-E COMPUTATIONAL PICTURE S9(6) SYNC.
01 FIELD-L.
05 FIELD-M PICTURE X(5).
05 FIELD-N PICTURE XX.
[05 SLACK-BYTES PICTURE X. INSERTED BY COMPILER]
05 FIELD-O.
10 FIELD-P COMPUTATIONAL PICTURE S9(6) SYNC.
The slack bytes are inserted at the end of each occurrence of the group item that
contains the OCCURS clause. For example, a record defined as follows appears in
storage, as shown, in the figure after the record:
01 WORK-RECORD.
05 WORK-CODE PICTURE X.
05 COMP-TABLE OCCURS 10 TIMES.
10 COMP-TYPE PICTURE X.
[10 SLACK-BYTES PIC XX. INSERTED BY COMPILER]
10 COMP-PAY PICTURE S9(4)V99 COMP SYNC.
10 COMP-HOURS PICTURE S9(3) COMP SYNC.
10 COMP-NAME PICTURE X(5).
Each succeeding occurrence within the table will now begin at the same relative
position as the first.
The lengths of all the elementary data items in the record, including all slack bytes,
are added. (For variable-length records, it is necessary to add an additional 4 bytes
for the count field.) The total is then divided by the highest value of m for any one
of the elementary items in the record.
If r (the remainder) is equal to zero, no slack bytes are required. If r is not equal to
zero, m - r slack bytes are required. These slack bytes can be specified by writing a
level-02 FILLER at the end of the record.
The number of bytes in A-1, A-2, and A-3 totals 11. B-1 is a four-digit
COMPUTATIONAL item and 1 slack byte must therefore be added before B-1.
With this byte added, the number of bytes that precede B-2 totals 14. Because B-2
is a COMPUTATIONAL item of five digits in length, 2 slack bytes must be added
before it. No slack bytes are needed before B-3.
There is a total of 22 bytes in COMP-RECORD, but from the rules above, it appears
that m = 4 and r = 2. Therefore, to attain proper alignment for blocked records, you
must add 2 slack bytes at the end of the record.
USAGE clause
The USAGE clause specifies the format in which data is represented in storage.
BINARY
USAGE NATIVE
IS COMP
NATIVE
COMP-1
NATIVE
COMP-2
NATIVE
COMP-3
(1)
NATIVE
COMP-4
NATIVE
COMP-5
(1)
NATIVE
COMPUTATIONAL
NATIVE
COMPUTATIONAL-1
NATIVE
COMPUTATIONAL-2
NATIVE
COMPUTATIONAL-3
(1)
NATIVE
COMPUTATIONAL-4
NATIVE
COMPUTATIONAL-5
(1)
NATIVE
DISPLAY
NATIVE
DISPLAY-1
NATIVE
INDEX
NATIONAL
NATIVE
objref phrase
PACKED-DECIMAL
(1)
NATIVE
POINTER
PROCEDURE-POINTER
FUNCTION-POINTER
objref phrase:
OBJECT REFERENCE
class-name-1
Notes:
1 NATIVE is treated as a comment in all phrases for which NATIVE is
shown in the USAGE clause.
The USAGE clause can be specified for a data description entry with any
level-number other than 66 or 88.
A USAGE clause must not be specified in a group level entry for which a
GROUP-USAGE NATIONAL clause is specified.
When the USAGE clause is not specified at either the group or elementary level, a
usage clause is implied with:
v Usage DISPLAY when the PICTURE clause contains only symbols other than G
or N
v Usage NATIONAL when the PICTURE clause contains only one or more of the
symbol N and the NSYMBOL(NATIONAL) compiler option is in effect
v Usage DISPLAY-1 when the PICTURE clause contains one or more of the symbol
N and the NSYMBOL(DBCS) compiler option is in effect
Computational items
A computational item is a value used in arithmetic operations. It must be numeric.
If a group item is described with a computational usage, the elementary items
within the group have that usage.
The picture for a COMP-5 data item can specify a scaling factor (that is,
decimal positions or implied integer positions). In this case, the maximal
capacities listed in the table above must be scaled appropriately. For
example, a data item described with PICTURE S99V99 COMP-5 is
represented in storage as a binary halfword, and supports a range of
values from -327.68 to +327.67.
USAGE NOTE: When the ON SIZE ERROR phrase is used on an
arithmetic statement and a receiver is defined with USAGE COMP-5, the
maximum value that the receiver can contain is the value implied by the
item's decimal PICTURE character-string. Any attempt to store a value
larger than this maximum will result in a size error condition.
DISPLAY phrase
The data item is stored in character form, one character for each 8-bit byte. This
corresponds to the format used for printed output. DISPLAY can be explicit or
implicit.
External decimal items with USAGE DISPLAY are sometimes referred to as zoned
decimal items. Each digit of a number is represented by a single byte. The 4
high-order bits of each byte are zone bits; the 4 high-order bits of the low-order
byte represent the sign of the item. The 4 low-order bits of each byte contain the
value of the digit.
DISPLAY-1 phrase
The DISPLAY-1 phrase defines an item as DBCS. The data item is stored in
character form, with each character occupying 2 bytes of storage.
FUNCTION-POINTER phrase
The FUNCTION-POINTER phrase defines an item as a function-pointer data item. A
function-pointer data item can contain the address of a procedure entry point.
A VALUE clause for a function-pointer data item can contain only NULL or
NULLS.
INDEX phrase
A data item defined with the INDEX phrase is an index data item.
An index data item is a 4-byte elementary item that can be used to save index-name
values for future reference. An index data item is not necessarily connected with any
specific table. Through a SET statement, an index data item can be assigned an
index-name value. Such a value corresponds to the occurrence number in a table.
Direct references to an index data item can be made only in a SEARCH statement,
a SET statement, a relation condition, the USING phrase of the PROCEDURE
DIVISION header, or the USING phrase of the CALL or ENTRY statement.
An index data item can be part of an alphanumeric group item that is referenced
in a MOVE statement or an input/output statement.
An index data item saves values that represent table occurrences, yet is not
necessarily defined as part of any table. There is no conversion of values when an
index data item is referenced in the following circumstances:
v directly in a SEARCH or SET statement
v indirectly in a MOVE statement
v indirectly in an input or output statement
SYNCHRONIZED can be used with USAGE IS INDEX to obtain efficient use of the
index data item.
NATIONAL phrase
The NATIONAL phrase defines an item whose content is represented in storage in
UTF-16 (CCSID 1200). The class and category of the data item depend on the
picture symbols that are specified in the associated PICTURE clause.
A VALUE clause for an object-reference data item can contain only NULL or
NULLS.
You can use the SYNCHRONIZED clause with the USAGE OBJECT REFERENCE
clause to obtain efficient alignment of the object-reference data item.
The JUSTIFIED, PICTURE, and BLANK WHEN ZERO clauses cannot be used to
describe group or elementary items defined with the USAGE OBJECT REFERENCE
clause.
POINTER phrase
A data item defined with USAGE IS POINTER is a pointer data item. A pointer data
item is a 4-byte elementary item.
You can use pointer data items to accomplish limited base addressing. Pointer data
items can be compared for equality or moved to other pointer items.
A VALUE clause for a pointer data item can contain only NULL or NULLS.
The JUSTIFIED, PICTURE, and BLANK WHEN ZERO clauses cannot be used to
describe group or elementary items defined with the USAGE IS POINTER clause.
A pointer data item can be written to a data set, but upon subsequent reading of
the record that contains the pointer, the address contained might no longer
represent a valid pointer.
The GLOBAL, EXTERNAL, and OCCURS clause can be used with USAGE IS
PROCEDURE-POINTER.
A VALUE clause for a procedure-pointer data item can contain only NULL or
NULLS.
The JUSTIFIED, PICTURE, and BLANK WHEN ZERO clauses cannot be used to
describe group or elementary items defined with the USAGE IS
PROCEDURE-POINTER clause.
NATIVE phrase
The NATIVE phrase is syntax checked, but has no effect on the execution of the
program.
A VALUE clause that is used in the FILE SECTION or the LINKAGE SECTION in
an entry other than a condition-name entry is syntax checked, but has no effect on
the execution of the program.
Format 1
Format 1 specifies the initial value of a data item. Initialization is independent of
any BLANK WHEN ZERO or JUSTIFIED clause that is specified.
VALUE literal
IS
The VALUE clause must not be specified for a data description entry that contains
or is subordinate to an entry that contains either an EXTERNAL or a REDEFINES
clause. This rule does not apply to condition-name entries.
A format-1 VALUE clause can be specified for an elementary data item or for a
group item. When the VALUE clause is specified at the group level, the group area
is initialized without consideration for the subordinate entries within the group. In
addition, a VALUE clause must not be specified for subordinate entries within the
group.
For group items, the VALUE clause must not be specified if any subordinate
entries contain a JUSTIFIED or SYNCHRONIZED clause.
If the VALUE clause is specified for an alphanumeric group, all subordinate items
must be explicitly or implicitly described with USAGE DISPLAY.
The VALUE clause must not conflict with other clauses in the data description
entry or in the data description of that entry's hierarchy.
A data item cannot contain a VALUE clause if the prior data item contains an
OCCURS clause with the DEPENDING ON phrase.
Format 2
This format associates a value, values, or ranges of values with a condition-name.
Each such condition-name requires a separate level-88 entry. Level-number 88 and
the condition-name are not part of the format-2 VALUE clause itself. They are
included in the format only for clarity.
88 condition-name-1 VALUE
IS
VALUES
ARE
literal-1 .
THROUGH literal-2
THRU
condition-name-1
A user-specified name that associates a value with a conditional variable. If
the associated conditional variable requires subscripts or indexes, each
procedural reference to the condition-name must be subscripted or indexed
as required for the conditional variable.
Format 3
This format assigns an invalid address as the initial value of an item defined as
USAGE POINTER, USAGE PROCEDURE POINTER, or USAGE
FUNCTION-POINTER. It also assigns an invalid object reference as the initial
value of an item defined as USAGE OBJECT REFERENCE.
VALUE NULL
IS NULLS
VALUE IS NULL can be specified only for elementary items described implicitly or
explicitly as USAGE POINTER, USAGE PROCEDURE-POINTER, USAGE
FUNCTION-POINTER, or USAGE OBJECT REFERENCE.
| VOLATILE clause
| The VOLATILE clause indicates that a data item's value can be modified or
| referenced in ways that the compiler cannot detect, such as by a Language
| Environment (LE) condition handler routine or by some other asynchronous
| process or thread. Thus, optimization is restricted for the data item.
| Format
| VOLATILE
|
||
| Note: The STGOPT option is ignored for data items that have the VOLATILE
| clause.
| The VOLATILE clause can be specified on data items that are defined in the FILE
| SECTION, WORKING-STORAGE SECTION, LOCAL-STORAGE SECTION, and
| LINKAGE SECTION. This clause can be specified together with any other clauses.
| For example, VOLATILE can be specified on tables, group data items, elementary
| data items, record descriptions and variably located data items.
| It is not possible to indicate that all memory associated with a class instance is
| volatile. However, individual members of a class can be defined with the
| VOLATILE clause.
| In this example:
| v DATA-ITEMS-A and DATA-B2 are considered volatile because they are defined
| with the VOLATILE clause.
| v DATA-A1 and DATA-A2 are treated as volatile because they are both
| subordinate to a group item (DATA-ITEMS-A) that has the VOLATILE clause.
| v DATA-COLLECTION and DATA-ITEMS-B are treated as volatile because they
| are group items that have subordinates that are defined with the VOLATILE
| clause. For example:
| MOVE DATA-ITEMS-B TO DATA-ITEMS-C.
| In this case, by treating DATA-ITEMS-B as volatile, the compiler ensures that the
| latest value of its subordinate member DATA-B2 is used in the memory copy
| operation.
procedure-division-header
factory-or-object-procedure-division-header
method-procedure-division-header
(1)
DECLARATIVES. sect . use-statement END DECLARATIVES.
para
(2)
section-name SECTION .
(3) para
priority-number
sect:
section-name SECTION
(3)
priority-number
para:
paragraph-name.
sentence
Notes:
1 The USE statement is described under USE statement on page 562.
2 Section-name can be omitted. If you omit section-name, paragraph-name can be omitted.
3 Priority-numbers are not valid for methods, recursive programs, or programs compiled with the
THREAD option.
The following syntax diagram shows the format for a PROCEDURE DIVISION
header in a program.
PROCEDURE DIVISION
USING data-name-1
REFERENCE
BY
VALUE
BY
.
RETURNING data-name-2
The following syntax diagram shows the format for a PROCEDURE DIVISION
header in a factory paragraph or object paragraph.
PROCEDURE DIVISION.
The following syntax diagram shows the format for a PROCEDURE DIVISION
header in a method.
PROCEDURE DIVISION
RETURNING data-name-2
However, a data item specified in the USING phrase of the CALL statement can be
a data item of any level in the DATA DIVISION of the calling COBOL program or
method. A data item specified in the USING phrase of an INVOKE statement can
be a data item of any level in the DATA DIVISION of the invoking COBOL
program or method.
A data item in the USING phrase of the header can have a REDEFINES clause in
its data description entry.
The identifiers specified in a CALL USING or INVOKE USING statement name the
data items available to the calling program or invoking method or program that
can be referred to in the called program or invoked method. These items can be
defined in any DATA DIVISION section.
A given identifier can appear more than once in a USING phrase. The last value
passed to it by a CALL or INVOKE statement is used.
RETURNING phrase
The RETURNING phrase specifies a data item that is to receive the program or
method result.
data-name-2
data-name-2 is the RETURNING data item. data-name-2 must be a level-01
or level-77 item in the LINKAGE SECTION.
Declaratives
Declaratives provide one or more special-purpose sections that are executed when
an exceptional condition occurs.
When declarative sections are specified, they must be grouped at the beginning of
the procedure division and the entire PROCEDURE DIVISION must be divided
into sections.
Each declarative section starts with a USE statement that identifies the section's
function. The series of procedures that follow specify the actions that are to be
taken when the exceptional condition occurs. Each declarative section ends with
another section-name followed by a USE statement, or with the keywords END
DECLARATIVES.
In the declaratives part of the PROCEDURE DIVISION, each section header must
be followed by a separator period, and must be followed by a USE statement
followed by a separator period. No other text can appear on the same line.
The USE statement itself is never executed; instead, the USE statement defines the
conditions that execute the succeeding procedural paragraphs, which specify the
actions to be taken. After the procedure is executed, control is returned to the
routine that activated it.
You can include a statement that executes a previously called USE procedure that
is still in control. However, to avoid an infinite loop, you must be sure there is an
eventual exit at the bottom.
The declarative procedure is exited when the last statement in the procedure is
executed.
The end of the PROCEDURE DIVISION is indicated by one of the following items:
v An IDENTIFICATION DIVISION header that indicates the start of a nested
source program
v An END PROGRAM, END METHOD, END FACTORY, or END OBJECT marker
v The physical end of a program; that is, the physical position in a source program
after which no further source program lines occur
Arithmetic expressions
Arithmetic expressions are used as operands of certain conditional and arithmetic
statements.
Identifiers and literals that appear in arithmetic expressions must represent either
numeric elementary items or numeric literals on which arithmetic can be
performed.
Arithmetic operators
Five binary arithmetic operators and two unary arithmetic operators can be used in
arithmetic expressions. These operators are represented by specific characters that
must be preceded and followed by a space.
These binary and unary arithmetic operators are shown in Table 17.
Table 17. Binary and unary operators
Binary operator Meaning Unary operator Meaning
+ Addition + Multiplication by +1
- Subtraction - Multiplication by -1
* Multiplication
/ Division
** Exponentiation
Expressions within parentheses are evaluated first. When expressions are contained
within nested parentheses, evaluation proceeds from the least inclusive to the most
inclusive set.
An arithmetic expression can begin only with a left parenthesis, a unary operator,
or an operand (that is, an identifier or a literal). It can end only with a right
parenthesis or an operand. An arithmetic expression must contain at least one
reference to an identifier or a literal.
Simple conditions
There are five simple conditions.
Class condition
The class condition determines whether the content of a data item is alphabetic,
alphabetic-lower, alphabetic-upper, numeric, DBCS, KANJI, or contains only the
characters in the set of characters specified by the CLASS clause as defined in the
SPECIAL-NAMES paragraph of the ENVIRONMENT DIVISION.
Format
identifier-1 NUMERIC
IS NOT ALPHABETIC
ALPHABETIC-LOWER
ALPHABETIC-UPPER
class-name
DBCS
KANJI
identifier-1
Must reference a data item described with one of the following usages:
v DISPLAY, NATIONAL, COMPUTATIONAL-3, or PACKED-DECIMAL
when NUMERIC is specified
v DISPLAY-1 when DBCS or KANJI is specified
v DISPLAY or NATIONAL when ALPHABETIC, ALPHABETIC-UPPER, or
ALPHABETIC-LOWER is specified
v DISPLAY when class-name is specified
Must not be of class alphabetic when NUMERIC is specified.
Condition-name condition
A condition-name condition tests a conditional variable to determine whether its
value is equal to any values that are associated with the condition-name.
Format
condition-name-1
If condition-name-1 has been associated with a range of values (or with several
ranges of values), the conditional variable is tested to determine whether its value
The following IF statements can be added to the above example to determine the
age group of a specific record:
IF INFANT... (Tests for value 0)
IF BABY... (Tests for values 1, 2)
IF CHILD... (Tests for values 3 through 12)
IF TEENAGER... (Tests for values 13 through 19)
Relation conditions
A relation condition specifies the comparison of two operands. The relational
operator that joins the two operands specifies the type of comparison. The relation
condition is true if the specified relation exists between the two operands; the
relation condition is false if the specified relation does not exist.
operand-1
The subject of the relation condition. Can be an identifier, literal,
function-identifier, arithmetic expression, or index-name.
operand-2
The object of the relation condition. Can be an identifier, literal,
function-identifier, arithmetic expression, or index-name.
In a general relation condition, data items, literals, and figurative constants of class
alphabetic, alphanumeric, DBCS, national, and numeric are compared using the
following comparison types:
Table 21 on page 266 and Table 22 on page 267 show the permissible pairs for
comparisons with different types of operands. The comparison type is indicated at
the row and column intersection for permitted comparisons, using the following
key:
Alph Comparison of alphanumeric characters (further described in
Alphanumeric comparisons on page 267)
DBCS Comparison of DBCS characters (further described in DBCS comparisons
on page 269)
Nat Comparison of national characters (further described in National
comparisons on page 269)
Num Comparison of algebraic value (further described in Numeric
comparisons on page 270)
Group Comparison of alphanumeric characters involving an alphanumeric group
(further described in Group comparisons on page 270)
(Int) Integer items only (combined with comparison type Alph, Nat, Num, or
Group)
For rules and restrictions for comparisons involving index-names and index data
items, see Comparison of index-names and index data items on page 271.
Alphanumeric comparisons
An alphanumeric comparison is a comparison of the single-byte character values of
two operands.
Alphanumeric comparisons are made with respect to the collating sequence of the
character set in use as follows:
v For the EBCDIC character set, the EBCDIC collating sequence is used.
v For the ASCII character set, the ASCII collating sequence is used. (See
Appendix C, EBCDIC and ASCII collating sequences, on page 587.)
v When the PROGRAM COLLATING SEQUENCE clause is specified in the
object-computer paragraph, the collating sequence used is the one associated in
the special-names paragraph with the specified alphabet-name.
The size of each operand is the total number of character positions in that operand;
the size affects the result of the comparison. There are two cases to consider:
Operands of equal size
Characters in corresponding positions of the two operands are compared,
beginning with the leftmost character and continuing through the
rightmost character.
If all pairs of characters through the last pair evaluate as equal, the
operands are equal.
If a pair of unequal characters is encountered, the characters are tested to
determine their relative positions in the collating sequence. The operand
that contains the character higher in the sequence is considered the greater
operand.
Operands of unequal size
If the operands are of unequal size, the comparison is made as though the
shorter operand were extended to the right with enough spaces to make
the operands equal in size.
DBCS comparisons
A DBCS comparison is a comparison of two DBCS operands.
National comparisons
A national comparison is a comparison of the national character value of two
operands of class national.
When the relation condition specifies an operand that is not class national, that
operand is converted to a data item of category national before the comparison.
The following list describes the conversion of operands to category national.
DBCS
A DBCS operand is treated as though it were moved to a temporary data
item of category national of the same length as the DBCS operand. DBCS
characters are converted to the corresponding national characters. The
source code page used for the conversion is the one in effect for the
CODEPAGE compiler option when the source code was compiled.
Alphabetic, alphanumeric, alphanumeric-edited, and numeric-edited with usage
DISPLAY
The operand is treated as though it were moved to a temporary data item
of category national of the length needed to represent the number of
character positions in that operand. Alphanumeric characters are converted
to the corresponding national characters. The source code page used for
the conversion is the one in effect for the CODEPAGE compiler option
when the source code was compiled.
Numeric integer
A numeric integer operand is treated as though it were moved to a
temporary data item of category alphanumeric of a length the same as the
number of digits in the integer. The unsigned value is used. The resulting
temporary data item is then converted as an alphanumeric operand.
The implicit moves for the conversions are carried out in accordance with the rules
of the MOVE statement.
The resulting category national data item is used in the comparison of two national
operands.
If the operands are of unequal length, the comparison proceeds as though the
shorter operand were padded on the right with the default national space character
(NX'0020') to make the operands of equal length. The comparison then proceeds
according to the rules for the comparison of operands of equal length.
Numeric comparisons
A numeric comparison is a comparison of the algebraic value of two operands of
class numeric.
Group comparisons
A group comparison is a comparison of the alphanumeric character values of two
operands.
Usage note: There is no conversion of data for group comparisons. The comparison
operates on bytes of data without regard to data representation. The result of
comparing an elementary item or literal operand to an alphanumeric group item is
predictable when that operand and the content of the group item have the same
data representation.
Valid comparisons for index-names and index data items are shown in the
following table.
Table 23. Comparisons for index-names and index data items
Data-name Literal
Operands Index data (numeric (numeric Arithmetic
compared Index-name item integer only) integer only) Expression
Index-name Compare Compare Compare Compare Compare
occurrence without occurrence occurrence occurrence
number conversion number with number with number with
content of literal arithmetic
referenced expression
data item
Index data Compare Compare Invalid Invalid Invalid
item without without
conversion conversion
Pointer data items are items defined explicitly as USAGE POINTER, or are
ADDRESS OF special registers, which are implicitly defined as USAGE POINTER.
ADDRESS OF identifier-3
identifier-4
NULL
NULLS
identifier-1 , identifier-3
Can specify any level item defined in the LINKAGE SECTION, except 66
and 88.
identifier-2 , identifier-4
Must be described as USAGE POINTER.
NULL, NULLS
Can be used only if the other operand is defined as USAGE POINTER.
That is, NULL=NULL is not allowed.
The operands are equal if the two addresses used in the comparison would both
result in the same storage location.
EQUAL
identifier-1 IS NOT TO identifier-2
NULL = NULL
NULLS NULLS
identifier-1 , identifier-2
Must be described as USAGE PROCEDURE-POINTER or USAGE
FUNCTION-POINTER. identifier-1 and identifier-2 need not be described the
same.
NULL, NULLS
Can be used only if the other operand is defined as USAGE
FUNCTION-POINTER or USAGE PROCEDURE-POINTER. That is,
NULL=NULL is not allowed.
object-reference-identifier-1 EQUAL
SELF IS NOT TO
NULL =
NULLS
object-reference-identifier-2
SELF
NULL
NULLS
Sign condition
The sign condition determines whether the algebraic value of a numeric operand is
greater than, less than, or equal to zero.
operand-1 POSITIVE
IS NOT NEGATIVE
ZERO
operand-1
Must be defined as a numeric identifier, or as an arithmetic expression that
contains at least one reference to a variable. operand-1 can be defined as a
floating-point identifier.
The operand is:
v POSITIVE if its value is greater than zero
v NEGATIVE if its value is less than zero
v ZERO if its value is equal to zero
An unsigned operand is either POSITIVE or ZERO.
NOT One algebraic test is executed for the truth value of the sign condition. For
example, NOT ZERO is regarded as true when the operand tested is
positive or negative in value.
The results of the sign condition test depend on the setting of the NUMPROC
compiler option. For details, see NUMPROC in the Enterprise COBOL Programming
Guide.
Switch-status condition
The switch-status condition determines the on or off status of a UPSI switch.
Format
condition-name
condition-name
Must be defined in the special-names paragraph as associated with the on
or off value of an UPSI switch. (See SPECIAL-NAMES paragraph on
page 114.)
The switch-status condition tests the value associated with condition-name. (The
value is considered to be alphanumeric.) The result of the test is true if the UPSI
switch is set to the value (0 or 1) corresponding to condition-name.
Each logical operator must be preceded and followed by a space. The following
table shows the logical operators and their meanings.
Table 25. Logical operators and their meanings
Logical
operator Name Meaning
AND Logical The truth value is true when both conditions are true.
conjunction
OR Logical The truth value is true when either or both conditions are
inclusive OR true.
NOT Logical Reversal of truth value (the truth value is true if the
negation condition is false).
Unless modified by parentheses, the following list is the order of precedence (from
highest to lowest):
1. Arithmetic operations
2. Simple conditions
3. NOT
4. AND
5. OR
The truth value of a complex condition (whether parenthesized or not) is the truth
value that results from the interaction of all the stated logical operators on either of
the following options:
v The individual truth values of simple conditions
v The intermediate truth values of conditions logically combined or logically
negated
Format
NOT condition-1
The negated simple condition gives the opposite truth value of the simple
condition. That is, if the truth value of the simple condition is true, then the truth
value of that same negated simple condition is false, and vice versa.
Combined conditions
Two or more conditions can be logically connected to form a combined condition.
Format
The following table illustrates the relationships between logical operators and
conditions C1 and C2.
Table 27. Logical operators and evaluation results of combined conditions
NOT NOT NOT
C1 (C1 C1 (C1
Value Value AND C1 OR AND AND OR NOT C1
for C1 for C2 C2 C2 C2) C2 C2) OR C2
True True True True False False False True
False True False True True True False True
True False False True True False False False
False False False False True False True True
Parentheses, both explicit and implicit, define the level of inclusiveness within a
complex condition. Two or more conditions connected by only the logical operators
AND or OR at the same level of inclusiveness establish a hierarchical level within
a complex condition. Therefore an entire complex condition is a nested structure of
hierarchical levels, with the entire complex condition being the most inclusive
hierarchical level.
Within this context, the evaluation of the conditions within an entire complex
condition begins at the left of the condition. The constituent connected conditions
within a hierarchical level are evaluated in order from left to right, and evaluation
of that hierarchical level terminates as soon as a truth value for it is determined,
regardless of whether all the constituent connected conditions within that
hierarchical level have been evaluated.
Values are established for arithmetic expressions and functions if and when the
conditions that contain them are evaluated. Similarly, negated conditions are
evaluated if and when it is necessary to evaluate the complex condition that they
represent. For example:
NOT A IS GREATER THAN B OR A + B IS EQUAL TO C AND D IS POSITIVE
Order of evaluation:
1. (NOT (A IS GREATER THAN B)) is evaluated, giving some intermediate truth
value, t1. If t1 is true, the combined condition is true, and no further evaluation
takes place. If t1 is false, evaluation continues as follows.
2. (A + B) is evaluated, giving some intermediate result, x.
Format
relation-condition
AND object
OR NOT relational-operator
The resulting combined condition must comply with the rules for element
sequences in combined conditions, as shown in Combined conditions on page
276.
If NOT is immediately followed by GREATER THAN, >, LESS THAN, <, EQUAL
TO, or =, then the NOT participates as part of the relational operator. NOT in any
other position is considered a logical operator (and thus results in a negated
relation condition).
Using parentheses
The following table summarizes the rules for forming an abbreviated combined
relation condition.
Table 28. Abbreviated combined conditions: permissible element sequences
Combined
condition When not leftmost, can be When not rightmost, can be
element Left- most immediately preceded by: Right- most immediately followed by:
Subject Yes NOT No Relational operator
(
Statement categories
There are four categories of COBOL statements: imperative statements, conditional
statements, delimited scope statements and compiler-directing statements. See the
links below for more details.
Imperative statements
An imperative statement either specifies an unconditional action to be taken by the
program, or is a conditional statement terminated by its explicit scope terminator.
For more information about explicit scope terminator, see Delimited scope
statements on page 284).
Arithmetic
v ADD1
v COMPUTE1
v DIVIDE1
v MULTIPLY1
v SUBTRACT1
Data movement
v ACCEPT (DATE, DAY, DAY-OF-WEEK, TIME)
v INITIALIZE
v INSPECT
v MOVE
v SET
v STRING2
v UNSTRING2
v XML GENERATE8
v XML PARSE8
Ending
v STOP RUN
v EXIT PROGRAM
v EXIT METHOD
v GOBACK
Input-output
v ACCEPT identifier
v CLOSE
v DELETE3
v DISPLAY
v OPEN
v READ4
v REWRITE3
v START3
v STOP literal
4. Without the AT END or NOT AT END, and INVALID KEY or NOT INVALID
KEY phrases.
5. Without the INVALID KEY or NOT INVALID KEY, and END-OF-PAGE or NOT
END-OF-PAGE phrases.
Ordering
v MERGE
v RELEASE
v RETURN6
v SORT
Procedure-branching
v ALTER
v EXIT
v GO TO
v PERFORM
Table-handling
v SET
Conditional statements
A conditional statement specifies that the truth value of a condition is to be
determined and that the subsequent action of the object program is dependent on
this truth value.
The following lists contain COBOL statements that become conditional when a
condition (for example, ON SIZE ERROR or ON OVERFLOW) is included and
when the statement is not terminated by its explicit scope terminator.
Arithmetic
v ADD ... ON SIZE ERROR
v ADD ... NOT ON SIZE ERROR
v COMPUTE ... ON SIZE ERROR
Data movement
v STRING ... ON OVERFLOW
v STRING ... NOT ON OVERFLOW
v UNSTRING ... ON OVERFLOW
v UNSTRING ... NOT ON OVERFLOW
v XML GENERATE ... ON EXCEPTION
v XML GENERATE ... NOT ON EXCEPTION
v XML PARSE ... ON EXCEPTION
v XML PARSE ... NOT ON EXCEPTION
Decision
v IF
v EVALUATE
Input-output
v DELETE ... INVALID KEY
v DELETE ... NOT INVALID KEY
v READ ... AT END
v READ ... NOT AT END
v READ ... INVALID KEY
v READ ... NOT INVALID KEY
v REWRITE ... INVALID KEY
v REWRITE ... NOT INVALID KEY
v START ... INVALID KEY
v START ... NOT INVALID KEY
v WRITE ... AT END-OF-PAGE
v WRITE ... NOT AT END-OF-PAGE
v WRITE ... INVALID KEY
v WRITE ... NOT INVALID KEY
Ordering
v RETURN ... AT END
v RETURN ... NOT AT END
Table-handling
v SEARCH
The resulting imperative statement can then be nested. Explicit scope terminators
can also be used to terminate the scope of an imperative statement. Explicit scope
terminators are provided for all COBOL statements that can have conditional
phrases.
Compiler-directing statements
A compiler-directing statement is a statement that causes the compiler to take a
specific action during compilation.
For more information about statements that direct the compiler to take a specified
action, see Chapter 22, Compiler-directing statements, on page 539.
Statement operations
The topic shows types of operations performed by COBOL statements.
There are several phrases common to arithmetic and data manipulation statements,
such as:
v CORRESPONDING phrase
v GIVING phrase
v ROUNDED phrase
v SIZE ERROR phrases
CORRESPONDING phrase
The CORRESPONDING (CORR) phrase causes ADD, SUBTRACT, and MOVE
operations to be performed on elementary data items of the same name if the
alphanumeric group item or national group item to which they belong is specified.
Both identifiers that follow the keyword CORRESPONDING must name group
items. In this discussion, these identifiers are referred to as identifier-1 and
identifier-2. identifier-1 references the sending group item. identifier-2 references the
receiving group item.
Two subordinate data items, one from identifier-1 and one from identifier-2,
correspond if the following conditions are true:
v In an ADD or SUBTRACT statement, both of the data items are elementary
numeric data items. Other data items are ignored.
If ADD CORR ITEM-2 TO ITEM-1(x) is specified, ITEM-A and ITEM-A(x), ITEM-B and
ITEM-B(x), and ITEM-E and ITEM-E(x) are considered to be corresponding and are
added together. ITEM-C and ITEM-C(x) are not included because they are not
numeric. ITEM-D and ITEM-D(x) are not included because ITEM-D(x) includes a
REDEFINES clause in its data description. ITEM-F and ITEM-F(x) are not included
because they are index data items. Note that ITEM-1 is valid as either identifier-1 or
identifier-2.
GIVING phrase
The value of the identifier that follows the word GIVING is set equal to the
calculated result of the arithmetic operation. Because this identifier is not involved
in the computation, it can be a numeric-edited item.
When the size of the fractional result exceeds the number of places provided for its
storage, truncation occurs unless ROUNDED is specified. When ROUNDED is
specified, the least significant digit of the resultant identifier is increased by 1
whenever the most significant digit of the excess is greater than or equal to 5.
These are the four ways a size error condition can occur:
v When the absolute value of the result of an arithmetic evaluation, after decimal
point alignment, exceeds the largest value that can be contained in the result
field.
v When division by zero occurs.
v In an exponential expression, as indicated in the following table:
Table 30. Exponentiation size error conditions
Action taken when a SIZE
Action taken when a SIZE ERROR clause is not
Size error ERROR clause is present present
Zero raised to zero power The SIZE ERROR imperative The value returned is 1, and
is executed. a message is issued.
Zero raised to a negative The SIZE ERROR imperative The program is terminated
number is executed. abnormally.
A negative number raised to The SIZE ERROR imperative The absolute value of the
a fractional power is executed. base is used, and a message
is issued.
If the ROUNDED phrase is specified, rounding takes place before size error
checking.
When a size error occurs, the subsequent action of the program depends on
whether the ON SIZE ERROR phrase is specified.
If the ON SIZE ERROR phrase is not specified and a size error condition occurs,
truncation rules apply and the value of the affected resultant identifier is
computed.
If the ON SIZE ERROR phrase is specified and a size error condition occurs, the
value of the resultant identifier affected by the size error is not altered; that is, the
error results are not placed in the receiving identifier. After completion of the
execution of the arithmetic operation, the imperative statement in the ON SIZE
ERROR phrase is executed, control is transferred to the end of the arithmetic
statement, and the NOT ON SIZE ERROR phrase, if specified, is ignored.
If the NOT ON SIZE ERROR phrase has been specified and, after execution of an
arithmetic operation, a size error condition does not exist, the NOT ON SIZE
ERROR phrase is executed.
When both the ON SIZE ERROR and NOT ON SIZE ERROR phrases are specified,
and the statement in the phrase that is executed does not contain any explicit
transfer of control, then if necessary an implicit transfer of control is made after
execution of the phrase to the end of the arithmetic statement.
Arithmetic statements
The arithmetic statements are used for computations. Individual operations are
specified by the ADD, SUBTRACT, MULTIPLY, and DIVIDE statements. These
individual operations can be combined symbolically in a formula that uses the
COMPUTE statement.
The composite of operands is a hypothetical data item resulting from aligning the
operands at the decimal point and then superimposing them on one another.
The following table shows how the composite of operands is determined for
arithmetic statements:
Table 31. How the composite of operands is determined
Statement Determination of the composite of operands
SUBTRACT Superimposing all operands in a given statement except those following the
ADD word GIVING
MULTIPLY Superimposing all receiving data items
DIVIDE Superimposing all receiving data items except the REMAINDER data item
COMPUTE Restriction does not apply
For example, assume that each item is defined as follows in the DATA DIVISION:
A PICTURE 9(7)V9(5).
B PICTURE 9(11)V99.
C PICTURE 9(12)V9(3).
In all arithmetic statements, it is important to define data with enough digits and
decimal places to ensure the required accuracy in the final result. For more
information, see Appendix A. Intermediate results and arithmetic precision in the
Enterprise COBOL Programming Guide.
Overlapping operands
When operands in an arithmetic statement share part of their storage (that is, when
the operands overlap), the result of the execution of such a statement is
unpredictable.
Overlapping operands
When the sending and receiving fields of a data manipulation statement share a
part of their storage (that is, when the operands overlap), the result of the
execution of such a statement is unpredictable.
Input-output statements
COBOL input-output statements transfer data to and from files stored on external
media, and also control low-volume data that is obtained from or sent to an
input/output device.
In COBOL, the unit of file data made available to the program is a record. You
need only be concerned with such records. Provision is automatically made for
such operations as the movement of data into buffers, internal storage, validity
checking, error correction (where feasible), blocking and deblocking, and
volume-switching procedures.
The description of the file in the ENVIRONMENT DIVISION and the DATA
DIVISION governs which input-output statements are allowed in the PROCEDURE
DIVISION. Permissible statements for sequential files are shown in Table 44 on
page 389, and permissible statements for indexed files and relative files are shown
in Table 45 on page 390. Permissible statements for line sequential files are shown
in Table 46 on page 390.
Discussions in the following sections use the terms volume and reel. The term
volume refers to all non-unit-record input-output devices. The term reel applies only
to tape devices. Treatment of direct-access devices in the sequential access mode is
logically equivalent to the treatment of tape devices.
If the FILE STATUS clause is specified in the file-control entry, a value is placed in
the specified file status key (the two-character data item named in the FILE
STATUS clause) during execution of any request on that file; the value indicates
the status of that request.
The value is placed in the file status key before execution of any
EXCEPTION/ERROR declarative, INVALID KEY phrase, or AT END phrase
associated with the request.
There are two file status key data-names. One is described by data-name-1 in the
FILE STATUS clause of the file-control entry. This is a two-character data item with
the first character known as file status key 1 and the second character known as
file status key 2. The combinations of possible values and their meanings are
shown in Table 32 on page 292.
The other file status key is described by data-name-8 in the FILE STATUS clause of
the file-control entry. data-name-8 does not apply to QSAM files. For more
information about data-name-8, see FILE STATUS clause on page 145.
For relative and indexed files in the sequential access mode, the last
input-output statement executed for the file prior to the execution
of a DELETE or REWRITE statement was not a successfully
executed READ statement.
4 A boundary violation exists because an attempt was made to
rewrite a record to a file and the record was not the same size as
the record being replaced. Or an attempt was made to write or
rewrite a record that was larger than the largest or smaller than the
smallest record allowed by the RECORD IS VARYING clause of the
associated file-name.
6 A sequential READ statement was attempted on a file open in the
input or I-O mode and no valid next record had been established
because:
v The preceding READ statement was unsuccessful but did not
cause an at-end condition.
v The preceding READ statement caused an at-end condition.
7 The execution of a READ statement was attempted on a file not
open in the input or I-O mode.
8 The execution of a WRITE statement was attempted on a file not
open in the I-O, output, or extend mode.
9 The execution of a DELETE or REWRITE statement was attempted
on a file not open in the I-O mode.
For QSAM file: An OPEN statement with the OUTPUT phrase was
attempted, or an OPEN statement with the I-O or EXTEND phrase
was attempted for an optional file but no DD statement was
specified for the file and the CBLQDA(OFF) runtime option was
specified.
7 For VSAM only: OPEN statement execution successful: File integrity
verified
8 Open failed due to the invalid contents of an environment variable
specified in a SELECT ... ASSIGN clause or due to dynamic
allocation failure. For more information about the contents of
environment variables, see ASSIGN clause on page 132.
The invalid key condition can occur during execution of a START, READ, WRITE,
REWRITE, or DELETE statement. When an invalid key condition occurs, the
input-output statement that caused the condition is unsuccessful.
When the invalid key condition is recognized, actions are taken in the following
order:
1. If the FILE STATUS clause is specified in the file-control entry, a value is
placed into the file status key to indicate an invalid key condition, as shown in
Table 32 on page 292.
2. If the INVALID KEY phrase is specified in the statement that caused the
condition, control is transferred to the INVALID KEY imperative statement.
Any EXCEPTION/ERROR declarative procedure specified for this file is not
executed. Execution then continues according to the rules for each statement
specified in the imperative statement.
3. If the INVALID KEY phrase is not specified in the input-output statement for a
file and an applicable EXCEPTION/ERROR procedure exists, that procedure is
executed. The NOT INVALID KEY phrase, if specified, is ignored.
If the invalid key condition does not exist after execution of the input-output
operation, the INVALID KEY phrase is ignored, if specified, and the following
actions are taken:
v If an exception condition that is not an invalid key condition exists, control is
transferred according to the rules of the USE statement following the execution
of any USE AFTER EXCEPTION procedure.
v If no exception condition exists, control is transferred to the end of the
input-output statement or the imperative statement specified in the NOT
INVALID KEY phrase, if it is specified.
The INTO and FROM phrases are valid for READ, RETURN, RELEASE, REWRITE,
and WRITE statements.
READ file-name-1
RETURN RECORD INTO identifier-1
RELEASE record-name-1
REWRITE FROM identifier-1
WRITE
v record-name-1 and identifier-1 must not refer to the same storage area.
v If record-name-1 or identifier-1 refers to a national group item, the item is
processed as an elementary data item of category national.
v The INTO phrase can be specified in a READ or RETURN statement.
The result of the execution of a READ or RETURN statement with the INTO
phrase is equivalent to the application of the following rules in the order
specified:
The execution of the same READ or RETURN statement without the INTO
phrase.
The current record is moved from the record area to the area specified by
identifier-1 according to the rules for the MOVE statement without the
CORRESPONDING phrase. The size of the current record is determined by
rules specified in the RECORD clause. If the file description entry contains a
RECORD IS VARYING clause, the implied move is a group move. The
implied MOVE statement does not occur if the execution of the READ or
RETURN statement was unsuccessful. Any subscripting or
reference-modification associated with identifier-1 is evaluated after the record
has been read or returned and immediately before it is moved to the data
item. The record is available in both the record area and the data item
referenced by identifier-1.
The file position indicator is a conceptual entity used in this document to facilitate
exact specification of the next record to be accessed within a given file during
certain sequences of input-output operations.
The setting of the file position indicator is affected only by the OPEN, CLOSE,
READ and START statements. The concept of a file position indicator has no
meaning for a file opened in the output or extend mode.
Data transfer
Format 1 transfers data from an input source into the data item referenced by
identifier-1 (the receiving area). When the FROM phrase is omitted, the system
input device is assumed.
ACCEPT identifier-1
FROM mnemonic-name-1
environment-name
If the device is the same as that used for READ statements for a LINE
SEQUENTIAL file, results are unpredictable.
identifier-2
The receiving area. Can be:
v An alphanumeric group item
v A national group item
v An elementary data item of one of the following categories:
alphanumeric
alphanumeric-edited
numeric-edited (with usage DISPLAY or NATIONAL)
national
national-edited
numeric
internal floating-point
external floating-point (with usage DISPLAY or NATIONAL)
A national group item is processed an an elementary data item of category
national.
Format 2 accesses the current date in two formats: the day of the week or the time
of day as carried by the system (which can be useful in identifying when a
particular run of an object program was executed). You can also use format 2 to
supply the date in headings and footings.
The current date and time can also be accessed with the intrinsic function
CURRENT-DATE, which also supports four-digit year values and provides
additional information (see CURRENT-DATE on page 502).
The content of the conceptual data items is moved to the receiving area using the
rules of the MOVE statement. If the receiving area is of usage NATIONAL, the
data is converted to national character representation.
SIZE ERROR imperative-statement-1
ON
NOT SIZE ERROR imperative-statement-2 END-ADD
ON
All identifiers or literals that precede the keyword TO are added together, and this
sum is added to and stored in identifier-2. This process is repeated for each
successive occurrence of identifier-2 in the left-to-right order in which identifier-2 is
specified.
GIVING identifier-3
ROUNDED
SIZE ERROR imperative-statement-1
ON
NOT SIZE ERROR imperative-statement-2 END-ADD
ON
The values of the operands that precede the word GIVING are added together, and
the sum is stored as the new value of each data item referenced by identifier-3.
SIZE ERROR imperative-statement-1
ON
NOT SIZE ERROR imperative-statement-2 END-ADD
ON
Elementary data items within identifier-1 are added to and stored in the
corresponding elementary items within identifier-2.
ROUNDED phrase
END-ADD phrase
This explicit scope terminator serves to delimit the scope of the ADD statement.
END-ADD permits a conditional ADD statement to be nested in another
conditional statement. END-ADD can also be used with an imperative ADD
statement.
Format
Before the ALTER statement is executed, when control reaches the paragraph
specified in procedure-name-1, the GO TO statement transfers control to the
paragraph specified in the GO TO statement. After execution of the ALTER
statement however, the next time control reaches the paragraph specified in
procedure-name-1, the GO TO statement transfers control to the paragraph specified
in procedure-name-2.
The ALTER statement acts as a program switch, allowing, for example, one
sequence of execution during initialization and another sequence during the bulk
of file processing.
Do not use the ALTER statement in programs that have the RECURSIVE attribute,
in methods, or in programs compiled with the THREAD option.
Segmentation considerations
A GO TO statement that is coded in an independent segment must not be
referenced by an ALTER statement in a segment with a different priority-number.
All other uses of the ALTER statement are valid and are performed even if the GO
TO referenced by the ALTER statement is in a fixed segment.
The program containing the CALL statement is the calling program; the program
identified in the CALL statement is the called subprogram. Called programs can
contain CALL statements; however, only programs defined with the RECURSIVE
clause can execute a CALL statement that directly or indirectly calls itself.
CALL identifier-1
literal-1
procedure-pointer-1
function-pointer-1
USING identifier-2
REFERENCE ADDRESS OF
BY file-name-1
OMITTED
CONTENT identifier-3
BY ADDRESS OF
LENGTH OF
literal-2
OMITTED
VALUE identifier-4
BY ADDRESS OF
LENGTH OF
literal-3
RETURNING identifier-5 exception-phrases END-CALL
exception-phrases:
not-exception-phrase:
identifier-1, literal-1
literal-1 must be an alphanumeric literal. identifier-1 must be an
alphanumeric, alphabetic, or numeric data item described with USAGE
DISPLAY such that its value can be a program-name.
The rules of formation for program-names are dependent on the
PGMNAME compiler option. For details, see the discussion of
For information about how the compiler resolves calls to program-names found in
multiple programs, see Conventions for program-names on page 88.
USING phrase
The USING phrase specifies arguments that are passed to the target program.
Include the USING phrase in the CALL statement only if there is a USING phrase
in the PROCEDURE DIVISION header or the ENTRY statement through which the
called program is run. The number of operands in each USING phrase must be
identical.
For more information about the USING phrase, see The PROCEDURE DIVISION
header on page 251.
The sequence of the operands in the USING phrase of the CALL statement and in
the corresponding USING phrase in the called subprogram's PROCEDURE
DIVISION header or ENTRY statement determines the correspondence between the
operands used by the calling and called programs. This correspondence is
positional.
The values of the parameters referenced in the USING phrase of the CALL
statement are made available to the called subprogram at the time the CALL
statement is executed. The description of the data items in the called program must
describe the same number of character positions as the description of the
corresponding data items in the calling program.
BY REFERENCE phrase
BY CONTENT phrase
For alphanumeric literals, the called subprogram should describe the parameter as
PIC X(n) USAGE DISPLAY, where n is the number of characters in the literal.
For DBCS literals, the called subprogram should describe the parameter as PIC
G(n) USAGE DISPLAY-1, or PIC N(n) with implicit or explicit USAGE DISPLAY-1,
where n is the length of the literal.
For national literals, the called subprogram should describe the parameter as PIC
N(n) with implicit or explicit USAGE NATIONAL, where n is the length of the
literal.
BY VALUE phrase
The BY VALUE phrase applies to all arguments that follow until overridden by
another BY REFERENCE or BY CONTENT phrase.
If the BY VALUE phrase is specified or implied for an argument, the value of the
argument is passed, not a reference to the sending data item. The called program
can modify the formal parameter that corresponds to the BY VALUE argument, but
any such changes do not affect the argument because the called program has
access to a temporary copy of the sending data item.
RETURNING phrase
identifier-5
The RETURNING data item, which can be any data item defined in the
DATA DIVISION. The return value of the called program is implicitly
stored into identifier-5.
You can specify the RETURNING phrase for calls to functions written in COBOL,
C, or in other programming languages that use C linkage conventions. If you
specify the RETURNING phrase on a CALL to a COBOL subprogram:
v The called subprogram must specify the RETURNING phrase on its
PROCEDURE DIVISION header.
v identifier-5 and the corresponding PROCEDURE DIVISION RETURNING
identifier in the target program must have the same PICTURE, USAGE, SIGN,
SYNCHRONIZE, JUSTIFIED, and BLANK WHEN ZERO clauses (except that
PICTURE clause currency symbols can differ, and periods and commas can be
interchanged due to the DECIMAL POINT IS COMMA clause).
The CALL ... RETURNING data item is an output-only parameter. On entry to the
called program, the initial state of the PROCEDURE DIVISION RETURNING data
item has an undefined and unpredictable value. You must initialize the
PROCEDURE DIVISION RETURNING data item in the called program before you
reference its value. The value that is passed back to the calling program is the final
value of the PROCEDURE DIVISION RETURNING data item when the called
program returns.
ON EXCEPTION phrase
If an exception condition does not occur (that is, the called subprogram can be
made available), control is transferred to the called program. After control is
returned from the called program, control is transferred to:
v imperative-statement-2, if the NOT ON EXCEPTION phrase is specified.
v The end of the CALL statement in any other case. (If the ON EXCEPTION
phrase is specified, it is ignored.)
ON OVERFLOW phrase
The ON OVERFLOW phrase has the same effect as the ON EXCEPTION phrase.
END-CALL phrase
This explicit scope terminator serves to delimit the scope of the CALL statement.
END-CALL permits a conditional CALL statement to be nested in another
conditional statement. END-CALL can also be used with an imperative CALL
statement.
Format
CANCEL identifier-1
literal-1
identifier-1, literal-1
literal-1 must be an alphanumeric literal. identifier-1 must be an
alphanumeric, alphabetic, or zoned decimal data item such that its value
can be a program-name. The rules of formation for program-names are
dependent on the PGMNAME compiler option. For details, see the
discussion of program-names in PROGRAM-ID paragraph on page 102
and the description of PGMNAME in the Enterprise COBOL Programming
Guide.
literal-1 or the contents of identifier-1 must be the same as a literal or the
contents of an identifier specified in an associated CALL statement.
After a CANCEL statement for a called subprogram has been executed, that
subprogram no longer has a logical connection to the program. The contents of
data items in external data records described by the subprogram are not changed
when that subprogram is canceled. If a CALL statement is executed later by any
program in the run unit naming the same subprogram, that subprogram is entered
in its initial state.
A CANCEL statement closes all open files that are associated with an internal file
connector in the program named in an explicit CANCEL statement. USE
procedures associated with those files are not executed.
A program named in a CANCEL statement must be a program that has been called
and has executed an EXIT PROGRAM statement or a GOBACK statement.
A program can cancel a program that it did not call, provided that, in the calling
hierarchy, the program that executes the CANCEL statement is higher than or
equal to the program it is canceling. For example:
A calls B and B calls C (When A receives control, it can cancel C.)
A calls B and A calls C (When C receives control, it can cancel B.)
CLOSE file-name-1
(1)
REEL
(1) REMOVAL
UNIT FOR
WITH NO REWIND
(1)
NO REWIND
WITH LOCK
Notes:
1 The REEL, UNIT, and NO REWIND phrases are not valid for VSAM files.
CLOSE file-name-1
LOCK
WITH
CLOSE file-name-1
REEL
UNIT REMOVAL
FOR
WITH NO REWIND
NO REWIND
WITH LOCK
file-name-1
Designates the file upon which the CLOSE statement is to operate. If more
A CLOSE statement can be executed only for a file in an open mode. After
successful execution of a CLOSE statement (without the REEL/UNIT phrase if
using format 1):
v The record area associated with the file-name is no longer available.
Unsuccessful execution of a CLOSE statement leaves availability of the record
data undefined.
v An OPEN statement for the file must be executed before any other input/output
statement can be executed for the file and before data is moved to a record
description entry associated with the file.
If the FILE STATUS clause is specified in the file-control entry, the associated file
status key is updated when the CLOSE statement is executed.
Table 34. Indexed and relative file types and CLOSE statement phrases
CLOSE statement phrases Action
CLOSE C
CLOSE WITH LOCK C,E
Input and input-output files: If the current reel/unit is the last or only reel/unit
for the file or if the reel is on a non-reel/unit medium, no volume switching is
performed. If another reel/unit exists for the file, the following operations are
performed: a volume switch, and the first record on the new volume is made
available for reading. If no data records exist for the current volume, another
volume switch occurs.
With the COMPUTE statement, arithmetic operations can be combined without the
restrictions on receiving data items imposed by the rules for the ADD, SUBTRACT,
MULTIPLY, and DIVIDE statements.
When arithmetic operations are combined, the COMPUTE statement can be more
efficient than the separate arithmetic statements written in a series.
Format
COMPUTE identifier-1 =
ROUNDED EQUAL
arithmetic-expression
SIZE ERROR imperative-statement-1
ON
NOT SIZE ERROR imperative-statement-2 END-COMPUTE
ON
identifier-1
Must name an elementary numeric item or an elementary numeric-edited
item.
Can name an elementary floating-point data item.
arithmetic-expression
Can be any arithmetic expression, as defined in Arithmetic expressions
on page 257.
When the COMPUTE statement is executed, the value of arithmetic
expression is calculated and stored as the new value of each data item
referenced by identifier-1.
An arithmetic expression consisting of a single identifier, numeric function,
or literal allows the user to set the value of the data items that are
referenced by identifier-1 equal to the value of that identifier, function, or
literal.
ROUNDED phrase
For a discussion of the ROUNDED phrase, see ROUNDED phrase on page 287.
For a discussion of the SIZE ERROR phrases, see SIZE ERROR phrases on page
287.
END-COMPUTE phrase
This explicit scope terminator serves to delimit the scope of the COMPUTE
statement. END-COMPUTE permits a conditional COMPUTE statement to be
nested in another conditional statement. END-COMPUTE can also be used with an
imperative COMPUTE statement.
Format
CONTINUE
When the DELETE statement is executed, the associated file must be open in I-O
mode.
Format
DELETE file-name-1
RECORD
INVALID imperative-statement-1
KEY
NOT INVALID imperative-statement-2 END-DELETE
KEY
file-name-1
Must be defined in an FD entry in the DATA DIVISION and must be the
name of an indexed or relative file.
After successful execution of a DELETE statement, the record is removed from the
file and can no longer be accessed.
Execution of the DELETE statement does not affect the contents of the record area
associated with file-name-1 or the content of the data item referenced by the
data-name specified in the DEPENDING ON phrase of the RECORD clause
associated with file-name-1.
If the FILE STATUS clause is specified in the file-control entry, the associated file
status key is updated when the DELETE statement is executed.
The file position indicator is not affected by execution of the DELETE statement.
For a file in sequential access mode, the previous input/output statement must be
a successfully executed READ statement. When the DELETE statement is executed,
the system removes the record that was retrieved by that READ statement.
For a file in sequential access mode, the INVALID KEY and NOT INVALID KEY
phrases must not be specified. An EXCEPTION/ERROR procedure can be
specified.
When the DELETE statement is executed, the system removes the record identified
by the contents of the prime RECORD KEY data item for indexed files, or the
RELATIVE KEY data item for relative files. If the file does not contain such a
record, an INVALID KEY condition exists. (See Invalid key condition on page
295.)
Transfer of control after the successful execution of a DELETE statement, with the
NOT INVALID KEY phrase specified, is to the imperative statement associated
with the phrase.
END-DELETE phrase
This explicit scope terminator serves to delimit the scope of the DELETE statement.
END-DELETE permits a conditional DELETE statement to be nested in another
conditional statement. END-DELETE can also be used with an imperative DELETE
statement.
Format
DISPLAY identifier-1
literal-1 UPON mnemonic-name-1
environment-name-1
NO ADVANCING
WITH
identifier-1
Identifier-1 references the data that is to be displayed. Identifier-1 can
reference any data item except an item of usage PROCEDURE-POINTER,
FUNCTION-POINTER, OBJECT REFERENCE, or INDEX. Identifier-1
cannot be an index-name.
If identifier-1 is a binary, internal decimal, or internal floating-point data
item, identifier-1 is converted automatically to external format as follows:
v Binary and internal decimal items are converted to zoned decimal.
Negative signed values cause a low-order sign overpunch.
v Internal floating-point numbers are converted to external floating-point
numbers for display such that:
A COMP-1 item will display as if it had an external floating-point
PICTURE clause of -.9(8)E-99.
A COMP-2 item will display as if it had an external floating-point
PICTURE clause of -.9(17)E-99.
Data items defined with USAGE POINTER are converted to a zoned
decimal number that has an implicit PICTURE clause of PIC 9(10).
If the output is directed to CONSOLE, data items described with usage
NATIONAL are converted from national character representation to
EBCDIC. The conversion uses the EBCDIC code page that was specified in
the CODEPAGE compiler option when the source code was compiled.
National characters without EBCDIC counterparts are converted to default
substitution characters; no exception condition is indicated or raised.
If the output is not directed to CONSOLE, data items described with usage
NATIONAL are written without conversion and without data validation.
No other categories of data require conversion.
If a DBCS operand must be split across multiple records, it will be split only on a
double-byte boundary.
Shift code insertion is required for splitting DBCS items. That is, when a DBCS
operand is split across multiple records, the shift-in character is inserted at the end
of the current record, and the shift-out character is inserted at the beginning of the
next record. A space is padded after the shift-in character, if necessary. These
inserted shift codes and spaces are included in the total byte count of the sending
data items.
After the last operand has been transferred to the output device, the device is reset
to the leftmost position of the next line of the device.
If a DBCS data item or literal is specified in a DISPLAY statement, the size of the
sending field is the total byte count of all operands listed, with each DBCS
character counted as two bytes, plus the necessary shift codes and spaces for
DBCS.
SIZE ERROR imperative-statement-1
ON
NOT SIZE ERROR imperative-statement-2 END-DIVIDE
ON
GIVING identifier-3
ROUNDED
SIZE ERROR imperative-statement-1
ON
NOT SIZE ERROR imperative-statement-2 END-DIVIDE
ON
GIVING identifier-3
ROUNDED
SIZE ERROR imperative-statement-1
ON
NOT SIZE ERROR imperative-statement-2 END-DIVIDE
ON
SIZE ERROR imperative-statement-1
ON
NOT SIZE ERROR imperative-statement-2 END-DIVIDE
ON
SIZE ERROR imperative-statement-1
ON
NOT SIZE ERROR imperative-statement-2 END-DIVIDE
ON
In formats 1, 2, and 3, floating-point data items and literals can be used anywhere
that a numeric data item or literal can be specified.
ROUNDED phrase
REMAINDER phrase
The result of subtracting the product of the quotient and the divisor from the
dividend is stored in identifier-4. If identifier-3, the quotient, is a numeric-edited
item, the quotient used to calculate the remainder is an intermediate field that
contains the unedited quotient.
Any subscripts for identifier-4 in the REMAINDER phrase are evaluated after the
result of the divide operation is stored in identifier-3 of the GIVING phrase.
For formats 4 and 5, if a size error occurs in the quotient, no remainder calculation
is meaningful. Therefore, the contents of the quotient field (identifier-3) and the
remainder field (identifier-4) are unchanged.
If size error occurs in the remainder, the contents of the remainder field
(identifier-4) are unchanged.
In either of these cases, you must analyze the results to determine which situation
has actually occurred.
For information about the NOT ON SIZE ERROR phrase, see SIZE ERROR
phrases on page 287.
END-DIVIDE phrase
This explicit scope terminator serves to delimit the scope of the DIVIDE statement.
END-DIVIDE turns a conditional DIVIDE statement into an imperative statement
that can be nested in another conditional statement. END-DIVIDE can also be used
with an imperative DIVIDE statement.
When a CALL statement that specifies the alternate entry point is executed in a
calling program, control is transferred to the next executable statement following
the ENTRY statement.
Format
ENTRY literal-1
.
USING identifier-1
REFERENCE
BY
VALUE
BY
literal-1
Must be an alphanumeric literal that conform to the rules for the formation
of a program-name in an outermost program (see PROGRAM-ID
paragraph on page 102).
Must not match the program-ID or any other ENTRY literal in this
program.
Must not be a figurative constant.
Execution of the called program begins at the first executable statement following
the ENTRY statement whose literal corresponds to the literal or identifier specified
in the CALL statement.
The entry point name on the ENTRY statement can be affected by the PGMNAME
compiler option. For details, see PGMNAME in the Enterprise COBOL Programming
Guide.
USING phrase
For a discussion of the USING phrase, see The PROCEDURE DIVISION header
on page 251.
Format
EVALUATE identifier-1
literal-1
expression-1
TRUE ALSO identifier-2
FALSE literal-2
expression-2
TRUE
FALSE
ALSO phrase 2
WHEN OTHER imperative-statement-2 END-EVALUATE
phrase 1:
ANY
condition-1
TRUE
FALSE
identifier-3
NOT literal-3 THROUGH identifier-4
arithmetic-expression-1 THRU literal-4
arithmetic-expression-2
phrase 2:
ANY
condition-2
TRUE
FALSE
identifier-5
NOT literal-5 THROUGH identifier-6
arithmetic-expression-3 THRU literal-6
arithmetic-expression-4
Two operands connected by a THRU phrase must be of the same class. The two
operands thus connected constitute a single selection object.
The number of selection objects within each set of selection objects must be equal
to the number of selection subjects.
Each selection object within a set of selection objects must correspond to the
selection subject having the same ordinal position within the set of selection
subjects, according to the following rules:
v Identifiers, literals, or arithmetic expressions appearing within a selection object
must be valid operands for comparison to the corresponding operand in the set
of selection subjects.
v condition-1, condition-2, or the word TRUE or FALSE appearing as a selection
object must correspond to a conditional expression or the word TRUE or FALSE
in the set of selection subjects.
v The word ANY can correspond to a selection subject of any type.
END-EVALUATE phrase
This explicit scope terminator serves to delimit the scope of the EVALUATE
statement. END-EVALUATE permits a conditional EVALUATE statement to be
nested in another conditional statement.
Determining values
The execution of the EVALUATE statement operates as if each selection subject and
selection object were evaluated and assigned a numeric, alphanumeric, DBCS, or
national character value; a range of numeric, alphanumeric, DBCS, or national
character values; or a truth value.
| Note: Enterprise COBOL does not yet support the format 4 EXIT statement, EXIT
| FUNCTION.
| Format 1 (simple)
| The format 1 EXIT statement provides a common end point for a series of
| procedures.
| Format 1
| paragraph-name . EXIT
|
||
Format 2
EXIT PROGRAM
Format 3
EXIT METHOD
You can specify EXIT METHOD only in the PROCEDURE DIVISION of a method.
EXIT METHOD causes the executing method to terminate, and control returns to
the invoking statement. If the containing method specifies the PROCEDURE
DIVISION RETURNING phrase, the value in the data item referred to by the
RETURNING phrase becomes the result of the method invocation.
The contents of data items and the contents of data files shared between the
invoking program or method and the invoked method could have changed. The
state of the invoked method is not altered except that the end of the ranges of all
PERFORM statements executed by the method are considered to have been
reached.
The EXIT METHOD statement does not have to be the last statement in a sequence
of imperative statements, but the statements following the EXIT METHOD will not
be executed.
| Format 5 (inline-perform)
| The EXIT PERFORM statement controls the exit from an inline PERFORM without
| using a GO TO statement or a PERFORM ... THROUGH statement.
| Format 5
| EXIT PERFORM
CYCLE
|
||
| When an EXIT PERFORM statement with the CYCLE phrase is executed, control is
| passed to an implicit CONTINUE statement. This implicit CONTINUE statement
| immediately precedes the END-PERFORM phrase that matches the most closely
| preceding and unterminated inline PERFORM statement.
| Format 6 (procedure)
| The EXIT PARAGRAPH statement controls the exit from the middle of a
| paragraph without executing any following statements within the paragraph. The
| EXIT SECTION statement controls the exit from a section without executing any
| following statements within the section.
| Format 6
| EXIT PARAGRAPH
SECTION
|
||
| EXIT PARAGRAPH
| EXIT SECTION
The GOBACK statement specifies the logical end of a called program or invoked
method.
Format
GOBACK
The table below shows the action taken for the GOBACK statement in both a main
program and a subprogram.
Termination
statement Main program Subprogram
GOBACK Returns to the calling program. Returns to the calling program.
(Can be the system, which causes
the application to end.)
Unconditional GO TO
The unconditional GO TO statement transfers control to the first statement in the
paragraph or section identified by procedure-name, unless the GO TO statement
has been modified by an ALTER statement.
GO procedure-name-1
TO
procedure-name-1
Must name a procedure or a section in the same PROCEDURE DIVISION
as the GO TO statement.
Conditional GO TO
The conditional GO TO statement transfers control to one of a series of procedures,
depending on the value of the data item referenced by identifier-1.
Altered GO TO
The altered GO TO statement transfers control to the first statement of the
paragraph named in the ALTER statement.
paragraph-name . GO .
TO
When an ALTER statement refers to a paragraph, the paragraph can consist only of
the paragraph-name followed by an unconditional or altered GO TO statement.
Format
IF condition-1 statement-1
THEN NEXT SENTENCE
(1)
END-IF
ELSE statement-2
NEXT SENTENCE
Notes:
1 END-IF can be specified with statement-2 or NEXT SENTENCE.
condition-1
Can be any simple or complex condition, as described in Conditional
expressions on page 260.
statement-1, statement-2
Can be any one of the following options:
v An imperative statement
v A conditional statement
v An imperative statement followed by a conditional statement
NEXT SENTENCE
The NEXT SENTENCE phrase transfers control to an implicit CONTINUE
statement immediately following the next separator period.
When NEXT SENTENCE is specified with END-IF, control does not pass to
the statement following the END-IF. Instead, control passes to the
statement after the closest following period.
END-IF phrase
This explicit scope terminator serves to delimit the scope of the IF statement.
END-IF permits a conditional IF statement to be nested in another conditional
statement. For more information about explicit scope terminators, see Delimited
scope statements on page 284.
If the condition tested is true, one of the following actions takes place:
v If statement-1 is specified, statement-1 is executed. If statement-1 contains a
procedure branching or conditional statement, control is transferred according to
the rules for that statement. If statement-1 does not contain a
procedure-branching statement, the ELSE phrase, if specified, is ignored, and
control passes to the next executable statement after the corresponding END-IF
or separator period.
v If NEXT SENTENCE is specified, control passes to an implicit CONTINUE
statement immediately preceding the next separator period.
If the condition tested is false, one of the following actions takes place:
v If ELSE statement-2 is specified, statement-2 is executed. If statement-2 contains a
procedure-branching or conditional statement, control is transferred, according
to the rules for that statement. If statement-2 does not contain a
procedure-branching or conditional statement, control is passed to the next
executable statement after the corresponding END-IF or separator period.
v If ELSE NEXT SENTENCE is specified, control passes to an implicit CONTINUE
STATEMENT immediately preceding the next separator period.
v If neither ELSE statement-2 nor ELSE NEXT SENTENCE is specified, control
passes to the next executable statement after the corresponding END-IF or
separator period.
When the ELSE phrase is omitted, all statements following the condition and
preceding the corresponding END-IF or the separator period for the sentence are
considered to be part of statement-1.
Nested IF statements
When an IF statement appears as statement-1 or statement-2, or as part of statement-1
or statement-2, that IF statement is nested.
Format
INITIALIZE identifier-1
identifier-1
Receiving areas.
identifier-1 must reference one of the following items:
v An alphanumeric group item
v A national group item
v An elementary data item of one of the following categories:
Alphabetic
Alphanumeric
Alphanumeric-edited
DBCS
External floating-point
Internal floating-point
National
National-edited
Numeric
Numeric-edited
v A special register that is valid as a receiving operand in a MOVE
statement with identifer-2 or literal-1 as the sending operand.
When identifier-1 references a national group item, identifier-1 is processed
as a group item.
identifier-2, literal-1
Sending areas.
Usage note: The data description entry for identifier-1 can contain the DEPENDING
phrase of the OCCURS clause. However, you cannot use the INITIALIZE statement
to initialize a variably-located item or a variable-length item.
The data description entry for identifier-1 must not contain a RENAMES clause.
Special registers can be specified for identifier-1 and identifier-2 only if they are
valid receiving fields or sending fields, respectively, for the implied MOVE
statements.
REPLACING phrase
With the exception of EGCS, the keyword after the word REPLACING corresponds
to a category of data shown in Classes and categories of data on page 164.
ALL identifier-3
LEADING literal-1 phrase 1
phrase 1:
BEFORE identifier-4
AFTER INITIAL literal-2
CHARACTERS BY identifier-5
literal-3 phrase 1
phrase 1:
BEFORE identifier-4
AFTER INITIAL literal-2
ALL identifier-3
LEADING literal-1 phrase 1
REPLACING
CHARACTERS BY identifier-5
literal-3 phrase 1
phrase 1:
BEFORE identifier-4
AFTER INITIAL literal-2
BEFORE identifier-4
AFTER INITIAL literal-2
identifier-1
Is the inspected item and can be any of the following items:
v An alphanumeric group item or a national group item
v An elementary data item described explicitly or implicitly with usage
DISPLAY, DISPLAY-1, or NATIONAL. The item can have any category
that is valid for the selected usage.
identifier-3 , identifier-4 , identifier-5 , identifier-6 , identifier-7
Must reference an elementary data item described explicitly or implicitly
with usage DISPLAY, DISPLAY-1, or NATIONAL.
literal-1 , literal-2 , literal-3 , literal-4
Must be of category alphanumeric, DBCS, or national.
When identifier-1 is of usage NATIONAL, literals must be of category
national.
When identifier-1 is of usage DISPLAY-1, literals must be of category DBCS.
When identifier-1 is of usage DISPLAY, literals must be of category
alphanumeric.
When identifier-1 is of usage DISPLAY-1 (DBCS) literals may be the
figurative constant SPACE.
When identifier-1 is of usage DISPLAY or NATIONAL, literals can be any
figurative constant that does not begin with the word ALL, as specified in
Figurative constants on page 13. The figurative constant is treated as a
one-character alphanumeric literal when identifier-1 is of usage DISPLAY,
and as a one-character national literal when identifier-1 is of usage
NATIONAL.
All identifiers (except identifier-2) must have the same usage as identifier-1. All
literals must have category alphanumeric, DBCS, or national when identifier-1 has
usage DISPLAY, DISPLAY-1, or NATIONAL, respectively.
When identifier-1 is a DBCS data item, DBCS characters are counted; when
identifier-1 is a data item of usage national, national characters (encoding units) are
counted; otherwise, alphanumeric characters (bytes) are counted.
This phrase fills all or portions of a data item with specified characters, such as
spaces or zeros.
identifier-3 or literal-1
Is the subject field, which identifies the characters to be replaced.
identifier-5 or literal-3
Is the substitution field (the item that replaces the subject field).
The subject field and the substitution field must be the same length.
CHARACTERS BY
When the CHARACTERS BY phrase is used, the substitution field must be
one character position in length.
When both the TALLYING and REPLACING phrases are specified (format 3), the
INSPECT statement is executed as if an INSPECT TALLYING statement (format 1)
were specified, immediately followed by an INSPECT REPLACING statement
(format 2).
No more than one BEFORE phrase and one AFTER phrase can be specified for any
one ALL, LEADING, CHARACTERS, FIRST or CONVERTING phrase.
identifier-4 or literal-2
Is the delimiter.
Delimiters are not counted or replaced.
INITIAL
The first occurrence of a specified item.
The BEFORE and AFTER phrases change how counting and replacing are done:
The following table describes the treatment of data items that can be used as an
operand in the INSPECT statement:
Table 37. Treatment of the content of data items
When referenced by any identifier except
identifier-2, the content of each item of
category ... Is treated ...
Alphanumeric or alphabetic As an alphanumeric character string
DBCS As a DBCS character string
National As a national character string
Alphanumeric-edited, numeric-edited with As if redefined as category alphanumeric,
usage DISPLAY, or numeric with usage with the INSPECT statement referring to an
DISPLAY (unsigned, external decimal) alphanumeric character string
National-edited, numeric-edited with usage As if redefined as category national, with
NATIONAL or numeric with usage the INSPECT statement referring to a
NATIONAL (unsigned, external decimal) national character string
Data flow
Except when the BEFORE or AFTER phrase is specified, inspection begins at the
leftmost character position of the inspected item (identifier-1) and proceeds
character-by-character to the rightmost position.
The comparands of the following phrases are compared in the left-to-right order in
which they are specified in the INSPECT statement:
v TALLYING (literal-1 or identifier-3, ... )
v REPLACING (literal-3 or identifier-5, ... )
Comparison cycle
The comparison cycle consists of the actions as described in this topic.
1. The first comparand is compared with an equal number of leftmost contiguous
character positions in the inspected item. The comparand matches the inspected
characters only if both are equal, character-for-character.
If the CHARACTERS phrase is specified, an implied one-character comparand
is used. The implied character is always considered to match the inspected
character in the inspected item.
2. If no match occurs for the first comparand and there are more comparands, the
comparison is repeated for each successive comparand until either a match is
found or all comparands have been acted upon.
3. Depending on whether a match is found, these actions are taken:
v If a match is found, tallying or replacing takes place as described in the
TALLYING and REPLACING phrase descriptions.
If there are more character positions in the inspected item, the first character
position following the rightmost matching character is now considered to be
in the leftmost character position. The process described in actions 1 and 2 is
then repeated.
v If no match is found and there are more character positions in the inspected
item, the first character position following the leftmost inspected character is
now considered to be in the leftmost character position. The process
described in actions 1 and 2 is then repeated.
4. Actions 1 through 3 are repeated until the rightmost character position in the
inspected item either has been matched or has been considered as being in the
leftmost character position.
When the BEFORE or AFTER phrase is specified, the comparison cycle is modified,
as described in BEFORE and AFTER phrases (all formats) on page 358.
Format
RETURNING identifier-4
EXCEPTION imperative-statement-1
ON
NOT EXCEPTION imperative-statement-2 END-INVOKE
ON
identifier-1
Must be defined as USAGE OBJECT REFERENCE. The contents of
identifier-1 specify the object on which a method is invoked.
When identifier-1 is specified, either literal-1 or identifier-2 must be specified,
identifying the name of the method to be invoked.
The results of the INVOKE statement are undefined if either:
v identifier-1 does not contain a valid reference to an object.
v identifier-1 contains NULL.
class-name-1
When class-name-1 is specified together with literal-1 or identifier-2, the
INVOKE statement invokes a static or factory method of the class
referenced by class-name-1. literal-1 or identifier-2 specifies the name of the
method that is to be invoked. The method must be a static method if
class-name-1 is a Java class; the method must be a factory method if
class-name-1 is a COBOL class.
When class-name-1 is specified together with NEW, the INVOKE statement
creates a new object that is an instance of class class-name-1.
You must specify class-name-1 in the REPOSITORY paragraph of the
configuration section of the class or program that contains the INVOKE
statement.
Chapter 20. PROCEDURE DIVISION statements 363
SELF An implicit reference to the object used to invoke the currently executing
method. When SELF is specified, the INVOKE statement must appear
within the PROCEDURE DIVISION of a method.
SUPER
An implicit reference to the object that was used to invoke the currently
executing method. The resolution of the method to be invoked will ignore
any methods declared in the class definition of the currently executing
method and methods defined in any class derived from that class; thus the
method invoked will be one that is inherited from an ancestor class.
literal-1
The value of literal-1 is the name of the method to be invoked. The
referenced object must support the method identified by literal-1.
literal-1 must be an alphanumeric literal or a national literal.
literal-1 is interpreted in a case-sensitive manner. The method name, the
number of arguments, and the data types of the arguments in the USING
phrase of the INVOKE statement are used to select the method with
matching signature that is supported by the object. The method can be
overloaded.
identifier-2
A data item of category alphabetic, alphanumeric, or national that at run
time contains the name of the method to be invoked. The referenced object
must support the method identified by identifier-2.
If identifier-2 is specified, identifier-1 must be defined as USAGE OBJECT
REFERENCE without any optional phrases; that is, identifier-1 must be a
universal object reference.
The content of identifier-2 is interpreted in a case-sensitive manner. The
method name, the number of arguments, and the data types of the
arguments in the USING phrase of the INVOKE statement are used to
select the method with matching signature that is supported by the object.
The method can be overloaded.
NEW The NEW operand specifies that the INVOKE statement is to create a new
object instance of the class class-name-1. class-name-1 must be specified.
When class-name-1 is implemented in Java, the USING phrase of the
INVOKE statement can be specified. The number of arguments and the
data types of the arguments in the USING phrase of the INVOKE
statement are used to select the Java constructor with matching signature
that is supported by the class. An object instance of class class-name-1 is
allocated, the selected constructor (or the default constructor) is executed,
and a reference to the created object is returned.
When class-name-1 is implemented in COBOL, the USING phrase of the
INVOKE statement must not be specified. An object instance of class
class-name-1 is allocated, instance data items are initialized to the values
specified in associated VALUE clauses, and a reference to the created object
is returned.
When NEW is specified, you must also specify a RETURNING phrase as
described in RETURNING phrase on page 366.
The USING phrase specifies arguments that are passed to the target method. The
argument data types and argument linkage conventions are restricted to those
supported by Java. See BY VALUE phrase for details.
BY VALUE phrase
The BY VALUE phrase specifies that the value of the argument is passed, not a
reference to the sending data item. The invoked method can modify the formal
parameter that corresponds to an argument passed by value, but changes do not
affect the argument because the invoked method has access only to a temporary
copy of the sending data item.
identifier-3
Must be an elementary data item in the DATA DIVISION. The data type of
identifier-3 must be one of the types supported for Java interoperation, as
listed in Interoperable data types for COBOL and Java on page 368.
Miscellaneous cases that are also supported as identifier-3 are listed in
Miscellaneous argument types for COBOL and Java on page 369, with
their corresponding Java type.
See Conformance requirements for arguments for additional requirements
that apply to identifier-3.
literal-2
Must be of a type suitable for Java interoperation and must exactly match
the type of the corresponding parameter in the target method. Supported
literal forms are listed in Miscellaneous argument types for COBOL and
Java on page 369, with their corresponding Java type.
literal-2 must not be a DBCS literal.
LENGTH OF identifier-3
Specifies that the length of identifier-3 is passed as an argument in the
LENGTH OF special register. A LENGTH OF special register passed BY
VALUE is treated as a PIC 9(9) binary value. For information about the
LENGTH OF special register, see LENGTH OF on page 19.
RETURNING phrase
The RETURNING phrase specifies a data item that will contain the value returned
from the invoked method. You can specify the RETURNING phrase on the
INVOKE statement when invoking methods that are written in COBOL or Java.
identifier-4
The RETURNING data item. identifier-4:
v Must be defined in the DATA DIVISION
v Must not be reference-modified
v Is not changed if an EXCEPTION occurs
The data type of identifier-4 must be one of the types supported for Java
interoperation, as listed in Interoperable data types for COBOL and Java
on page 368.
See Conformance requirements for the RETURNING item for additional
requirements that apply to identifier-4.
If identifier-4 is specified and the target method is written in COBOL, the
target method must have a RETURNING phrase in its PROCEDURE
DIVISION header. When the target method returns, its return value is
assigned to identifier-4 using the rules for the SET statement if identifier-4 is
described with USAGE OBJECT REFERENCE; otherwise, the rules for the
MOVE statement are used.
See Managing local and global references in the Enterprise COBOL Programming Guide
for discussion of local and global object references as defined in Java. These
attributes affect the life-time of object references.
For INVOKE statements that specify class-name-1 NEW, the RETURNING phrase is
required.
For INVOKE statements without the NEW phrase, the RETURNING item specified
in the method invocation and in the corresponding target method must satisfy the
following requirements:
v The presence or absence of a return value must be the same on the INVOKE
statement and in the target method.
v If the RETURNING item is not an object reference, the following rules apply:
If the target method is implemented in COBOL, the returning item in the
INVOKE statement and the RETURNING item in the target method must
have an identical data description entry.
If the target method is implemented in Java, the returning item in the
INVOKE statement must correspond to the Java type of the method result, as
described in Interoperable data types for COBOL and Java on page 368.
v If the RETURNING item is an object reference, the RETURNING item specified
in the INVOKE statement must be an object reference typed exactly to the class
of the returning item specified in the target method. That is, the class of
identifier-4 must not be a subclass or a superclass of the class of the returning
item in the target method.
ON EXCEPTION phrase
An exception condition occurs when the identified object or class does not support
a method with a signature that matches the signature of the method specified in
the INVOKE statement. When an exception condition occurs, one of the following
actions occurs:
v If the ON EXCEPTION phrase is specified, control is transferred to
imperative-statement-1.
v If the ON EXCEPTION phrase is not specified, a severity-3 Language
Environment condition is raised at run time.
If an exception condition does not occur (that is, the identified method is
supported by the specified object), control is transferred to the invoked method.
After control is returned from the invoked method, control is then transferred:
1. To imperative-statement-2, if the NOT ON EXCEPTION phrase is specified.
2. To the end of the INVOKE statement if the NOT ON EXCEPTION phrase is not
specified.
END-INVOKE phrase
This explicit scope terminator serves to delimit the scope of the INVOKE
statement. An INVOKE statement that is terminated by END-INVOKE, along with
its contained statements, becomes a unit that is treated as though it were an
imperative statement. It can be specified as an imperative statement in a
conditional statement; for example, in the exception phrase of another statement.
You can specify the interoperable data types as arguments in COBOL INVOKE
statements and as the RETURNING item in COBOL INVOKE statements. Similarly,
you can pass these types as arguments from a Java method invocation expression
and receive them as parameters in the USING phrase or as the RETURNING item
in the PROCEDURE DIVISION header of a COBOL method.
The following table lists the primitive Java types and the COBOL data types that
are supported for interoperation and the correspondence between them.
Table 38. Interoperable Java and COBOL data types
Java data type COBOL data type
1
boolean Conditional variable and two condition-names of the form:
level-number data-name PIC X.
88 data-name-false VALUE X00.
88 data-name-true VALUE X01 THROUGH XFF.
byte Single-byte alphanumeric, PIC X or PIC A
short USAGE BINARY, COMP, COMP-4, or COMP-5, with a PICTURE
clause of the form S9(n), where 1 <= n <= 4
int USAGE BINARY, COMP, COMP-4, or COMP-5, with a PICTURE
clause of the form S9(n), where 5 <= n <= 9
long USAGE BINARY, COMP, COMP-4, or COMP-5, with a PICTURE
clause of the form S9(n), where 10 <= n <= 18
float2 USAGE COMP-1
2
double USAGE COMP-2
char Single-character national: PIC N USAGE NATIONAL
(an elementary data item of category national)
class types USAGE OBJECT REFERENCE class-name
(object references)
1. Enterprise COBOL interprets a PIC X argument or parameter as the Java boolean type
only when the PIC X data item is followed by exactly two condition-names of the form
shown. In all other cases, a PIC X argument or parameter is interpreted as the Java byte
type.
2. Java floating-point data is represented in IEEE binary floating-point, while Enterprise
COBOL uses the IBM hexadecimal floating-point representation. The representations are
automatically converted as necessary when Java methods are invoked from COBOL and
when COBOL methods are invoked from Java.
In addition to the primitive types, Java Strings and arrays of Java primitive types
can interoperate with COBOL. This requires specialized mechanisms provided by
the COBOL runtime system and the Java Native Interface (JNI).
In a Java program, to pass array data to COBOL or to receive array data from
COBOL, you declare the array types using the usual Java syntax. In the COBOL
program, you declare the array as an object reference that contains an instance of
one of the special classes provided for array support. Conversion between the Java
and COBOL types is automatic at the time of method invocation.
You must code an entry in the repository paragraph for each special class that you
want to use, just as you do for other classes. For example, to use jstring, code the
following entry:
Configuration Section.
Repository.
Class jstring is "jstring".
Alternatively, for the String type, the COBOL repository entry can specify an
external class name of java.lang.String:
Repository.
Class jstring is "java.lang.String".
Callable services are provided by the Java Native Interface (JNI) for manipulating
the COBOL objects of these types in COBOL. For example, callable services can be
used to set COBOL alphanumeric or national data into a jstring object or to extract
data from a jstring object. For details on use of JNI callable services for these and
other purposes, see Accessing JNI services in the Enterprise COBOL Programming
Guide.
The following table lists COBOL literal types that can be used as arguments in an
INVOKE statement, with the corresponding Java type.
Table 41. COBOL literal argument types and corresponding Java types
Corresponding Java
COBOL literal argument data type
Fixed-point numeric literal with no decimal positions and with int
nine digits or less
Floating-point numeric literal double
Figurative constant ZERO int
One-character alphanumeric literal byte
One-character national literal char
Symbolic character byte
Figurative constants SPACE, QUOTE, HIGH-VALUE, or byte
LOW-VALUE
The MERGE statement is not supported for programs compiled with the THREAD
compiler option.
Format
GIVING file-name-4
file-name-1
The name given in the SD entry that describes the records to be merged.
No file-name can be repeated in the MERGE statement.
No pair of file-names in a MERGE statement can be specified in the same
SAME AREA, SAME SORT AREA, or SAME SORT-MERGE AREA clause.
However, any file-names in the MERGE statement can be specified in the
same SAME RECORD AREA clause.
If the KEY data item is described with usage NATIONAL, the sequence of the KEY
values is based on the binary values of the national characters.
The COLLATING SEQUENCE phrase has no effect for keys that are not alphabetic
or alphanumeric.
alphabet-name-1
Must be specified in the ALPHABET clause of the SPECIAL-NAMES
paragraph. Any one of the alphabet-name clause phrases can be specified,
with the following results:
STANDARD-1
The ASCII collating sequence is used for all alphanumeric
comparisons. (The ASCII collating sequence is shown in US
English ASCII code page on page 590.)
STANDARD-2
The 7-bit code defined in the International Reference Version of
ISO/IEC 646, 7-bit coded character set for information interchange is
used for all alphanumeric comparisons.
NATIVE
The EBCDIC collating sequence is used for all alphanumeric
comparisons. (The EBCDIC collating sequence is shown in
EBCDIC collating sequence on page 587.)
EBCDIC
The EBCDIC collating sequence is used for all alphanumeric
comparisons. (The EBCDIC collating sequence is shown in
EBCDIC collating sequence on page 587.)
literal
The collating sequence established by the specification of literals in
the ALPHABET-NAME clause is used for all alphanumeric
comparisons.
USING phrase
file-name-2 , file-name-3 , ...
Specifies the input files.
All input files must specify sequential or dynamic access mode and be described in
FD entries in the DATA DIVISION.
GIVING phrase
file-name-4 , ...
Specifies the output files.
When the GIVING phrase is specified, all the merged records in file-name-1 are
automatically transferred to the output files (file-name-4, ...).
All output files must specify sequential or dynamic access mode and be described
in FD entries in the DATA DIVISION.
If the output files (file-name-4, ...) contain variable-length records, the size of the
records contained in file-name-1 must be neither less than the smallest record nor
greater than the largest record described for the output files. If the output files
contain fixed-length records, the size of the records contained in file-name-1 must
not be greater than the largest record described for the output files. For more
information, see Sorting and merging files in the Enterprise COBOL Programming
Guide.
At the time the MERGE statement is executed, the output files (file-name-4, ...) must
not be open. The output files are automatically opened, read, and closed. If
DECLARATIVE procedures are specified for these files for output operations, the
declaratives will be driven for errors if errors occur.
This phrase specifies the name of a procedure that is to select or modify output
records from the merge operation.
procedure-name-1
Specifies the first (or only) section or paragraph in the OUTPUT
PROCEDURE.
procedure-name-2
Identifies the last section or paragraph of the OUTPUT PROCEDURE.
The OUTPUT PROCEDURE can consist of any procedure needed to select, modify,
or copy the records that are made available one at time by the RETURN statement
in merged order from the file referenced by file-name-1. The range includes all
statements that are executed as the result of a transfer of control by CALL, EXIT,
Segmentation considerations
If a MERGE statement is coded in a fixed segment, any output procedure
referenced by that MERGE statement must be either totally within a fixed segment
or wholly contained in a single independent segment.
The evaluation of the length of the sending or receiving area can be affected by the
DEPENDING ON phrase of the OCCURS clause (see OCCURS clause on page
193).
is equivalent to:
MOVE A(B) TO TEMP.
MOVE TEMP TO B.
MOVE TEMP TO C(B).
where TEMP is defined as an intermediate result item. The subscript B has changed
in value between the time that the first move took place and the time that the final
move to C(B) is executed.
After execution of a MOVE statement, the sending fields contain the same data as
before execution.
Elementary moves
An elementary move is one in which the receiving item is an elementary data item
and the sending item is an elementary data item or a literal.
The following rules outline the execution of valid elementary moves. When the
receiving field is:
Alphabetic:
v Alignment and any necessary space filling or truncation occur as described
under Alignment rules on page 168.
v If the size of the sending item is greater than the size of the receiving item,
excess characters on the right are truncated after the receiving item is filled.
Alphanumeric or alphanumeric-edited:
v If the sending item is a national decimal integer item, the sending data is
converted to usage DISPLAY and treated as though it were moved to a
DBCS:
v If the sending and receiving items are not the same size, the sending data is
either truncated on the right or padded with DBCS spaces on the right.
External floating-point:
v For a floating-point sending item, the floating-point value is converted to the
usage of the receiving external floating-point item (if different from the sending
item's representation).
v For other sending items, the numeric value is treated as though that value were
converted to internal floating-point and then converted to the usage of the
receiving external floating-point item.
Internal floating-point:
v When the category of the sending operand is not internal floating-point, the
numeric value of the sending item is converted to internal floating-point format.
National or national-edited:
v If the representation of the sending item is not national characters, the sending
data is converted to national characters and treated as though it were moved to
a temporary data item of category national of a length not to cause truncation or
padding. The resulting category national data item is treated as the sending data
item.
v If the representation of the sending item is national characters, the sending data
is used without conversion.
v Alignment and any necessary space filling or truncation take place as described
under Alignment rules on page 168. The programmer is responsible for
ensuring that multiple encoding units that together form a graphic character are
not split by truncation.
v If the sending item has an operational sign, the unsigned value is used. If the
operational sign occupies a separate character, that character is not moved, and
the size of the sending item is considered to be one less character than the actual
size.
Numeric or numeric-edited:
v Except when zeros are replaced because of editing requirements, alignment by
decimal point and any necessary zero filling take place, as described under
Alignment rules on page 168.
v If the receiving item is signed, the sign of the sending item is placed in the
receiving item, with any necessary sign conversion. If the sending item is
unsigned, a positive operational sign is generated for the receiving item.
Usage notes:
1. If the receiving item is of category alphanumeric, alphanumeric-edited,
numeric-edited, national, or national-edited and the sending field is numeric,
any digit positions described with picture symbol P in the sending item are
considered to have the value zero. Each P is counted in the size of the sending
item.
2. If the receiving item is numeric and the sending field is an alphanumeric literal,
a national literal, or an ALL literal, all characters of the literal must be numeric
characters.
In the table:
v YES = Move is valid.
v NO = Move is invalid.
v Column headings indicate receiving item categories; row headings indicate
sending item categories.
Table 42. Valid and invalid elementary moves
Valid and
invalid Alpha- External Internal National,
elementary Alpha- Alpha- numeric Numeric- floating- floating- national-
moves betic numeric edited Numeric edited point point DBCS1 edited
Alphabetic and Yes Yes Yes No No No No No Yes
SPACE sending
item
Alphanumeric Yes Yes Yes Yes3 Yes3 Yes8 Yes8 No Yes
sending item2
Alphanumeric- Yes Yes Yes No No No No No Yes
edited sending
item
Numeric integer No Yes Yes Yes Yes Yes Yes No Yes
and ZERO
sending item4
Numeric No No No Yes Yes Yes Yes No No
noninteger
sending item5
Group moves
A group move is any move in which an alphanumeric group item is a sending
item or a receiving item, or both.
SIZE ERROR imperative-statement-1
ON
NOT SIZE ERROR imperative-statement-2 END-MULTIPLY
ON
GIVING identifier-3
ROUNDED
SIZE ERROR imperative-statement-1
ON
NOT SIZE ERROR imperative-statement-2 END-MULTIPLY
ON
For format-2:
identifier-3
Must name an elementary numeric or numeric-edited item.
Floating-point data items and literals can be used anywhere a numeric data item or
literal can be specified.
ROUNDED phrase
END-MULTIPLY phrase
This explicit scope terminator serves to delimit the scope of the MULTIPLY
statement. END-MULTIPLY permits a conditional MULTIPLY statement to be
nested in another conditional statement. END-MULTIPLY can also be used with an
imperative MULTIPLY statement.
OUTPUT file-name-2
NO REWIND
WITH
I-O file-name-3
EXTEND file-name-4
Notes:
1 The REVERSED and WITH NO REWIND phrases are not valid for VSAM
files.
OUTPUT file-name-2
I-O file-name-3
EXTEND file-name-4
OUTPUT file-name-2
EXTEND file-name-4
The phrases INPUT, OUTPUT, I-O, and EXTEND specify the mode to be used for
opening the file. At least one of the phrases INPUT, OUTPUT, I-O, or EXTEND
must be specified with the OPEN keyword. The INPUT, OUTPUT, I-O, and
EXTEND phrases can appear in any order.
INPUT
Permits input operations.
OUTPUT
Permits output operations. This phrase can be specified when the file is
being created.
Do not specify OUTPUT for files that:
v Contain records. The file will be replaced by new data.
If the OUTPUT phrase is specified for a file that already contains
records, the data set must be defined as reusable and cannot have an
alternate index. The records in the file will be replaced by the new data
and any ALTERNATE RECORD KEY clause in the SELECT statement
will be ignored.
v Are defined with a DD dummy card. Unpredictable results can occur.
I-O Permits both input and output operations. The I-O phrase can be specified
only for files assigned to direct access devices.
The I-O phrase is not valid for line-sequential files.
EXTEND
Permits output operations that append to or create a file.
The EXTEND phrase is allowed for sequential access files only if the new
data is written in ascending sequence. The EXTEND phrase is allowed for
files that specify the LINAGE clause.
For QSAM files, do not specify the EXTEND phrase for a multiple file reel.
If you want to append to a file, but are unsure if the file exists, use the
SELECT OPTIONAL clause before opening the file in EXTEND mode. The
file will be created or appended to, depending on whether the file exists.
file-name-1, file-name-2, file-name-3, file-name-4
Designate a file upon which the OPEN statement is to operate. If more
than one file is specified, the files need not have the same organization or
access mode. Each file-name must be defined in an FD entry in the DATA
DIVISION and must not name a sort or merge file. The FD entry must be
equivalent to the information supplied when the file was defined.
For information on file sizes, see Appendix B, Compiler limits, on page 583.
General rules
The topic shows general rules of the OPEN statement.
v If a file opened with the INPUT phrase is an optional file that is not available,
the OPEN statement sets the file position indicator to indicate that an optional
input file is not available.
v Execution of an OPEN INPUT or OPEN I-O statement sets the file position
indicator:
For indexed files, to the characters with the lowest ordinal position in the
collating sequence associated with the file.
For sequential and relative files, to 1.
v When the EXTEND phrase is specified, the OPEN statement positions the file
immediately after the last record written in the file. (The record with the highest
prime record key value for indexed files or relative key value for relative files is
considered the last record.) Subsequent WRITE statements add records as if the
file were opened OUTPUT. The EXTEND phrase can be specified when a file is
being created; it can also be specified for a file that contains records, or that has
contained records that have been deleted. For more information, see note 1 in
the OPEN statement notes on page 389 and SELECT OPTIONAL in the
SELECT clause on page 132.
v For VSAM files, if no records exist in the file, the file position indicator is set so
that the first format 1 READ statement executed results in an AT END condition.
v When NO REWIND is specified, the OPEN statement execution does not
reposition the file; prior to OPEN statement execution, the file must be
positioned at its beginning. When the NO REWIND phrase is specified (or when
both the NO REWIND and REVERSE phrases are omitted), file positioning is
specified with the LABEL parameter of the DD statement.
v When REVERSED is specified, OPEN statement execution positions the QSAM
file at its end. Subsequent READ statements make the data records available in
reversed order, starting with the last record.
When OPEN REVERSED is specified, the record format must be fixed.
v When the REVERSED, NO REWIND, or EXTEND phrases are not specified,
OPEN statement execution positions the file at its beginning.
If the PASSWORD clause is specified in the file-control entry, the password data
item must contain a valid password before the OPEN statement is executed. If a
valid password is not present, OPEN statement execution is unsuccessful.
2. The successful execution of the OPEN statement places the file in open status
and makes the associated record area available to the program.
3. The OPEN statement does not obtain or release the first data record.
4. You can move data to or from the record area only when the file is in open
status.
5. An OPEN statement must be successfully executed prior to the execution of
any of the permissible input-output statements, except a SORT or MERGE
statement with the USING or GIVING phrase. In the following table, an 'X'
indicates that the specified statement can be used with the open mode given at
the top of the column.
Table 44. Permissible statements for sequential files
Input open Output open Extend open
Statement mode mode I-O open mode mode
READ X X
WRITE X X
REWRITE X
In the following table, an 'X' indicates that the specified statement, used in the
access mode given for that row, can be used with the open mode given at the top
of the column.
In the following table, an 'X' indicates that the specified statement can be used
with the open mode given at the top of the column.
Table 46. Permissible statements for line-sequential files
Input open Output open Extend open
Statement mode mode I-O open mode mode
READ X
WRITE X X
REWRITE
1. A file can be opened for INPUT, OUTPUT, I-O, or EXTEND (sequential and
line-sequential files only) in the same program. After the first OPEN statement
execution for a given file, each subsequent OPEN statement execution must be
preceded by a successful CLOSE file statement execution without the REEL or
UNIT phrase (for QSAM files only), or the LOCK phrase.
2. If the FILE STATUS clause is specified in the file-control entry, the associated
file status key is updated when the OPEN statement is executed.
3. If an OPEN statement is executed for a file that is already open, the
EXCEPTION/ERROR procedure (if specified) for this file is run.
PERFORM procedure-name-1
THROUGH procedure-name-2
THRU
END-PERFORM
imperative-statement-1
procedure-name-1 , procedure-name-2
Must name a section or paragraph in the procedure division.
When both procedure-name-1 and procedure-name-2 are specified, if either is a
procedure-name in a declarative procedure, both must be procedure-names
in the same declarative procedure.
If procedure-name-1 is specified, imperative-statement-1 and the
END-PERFORM phrase must not be specified.
If procedure-name-1 is omitted, imperative-statement-1 and the
END-PERFORM phrase must be specified.
imperative-statement-1
The statements to be executed for an in-line PERFORM
| You can use the EXIT PERFORM statement to exit from an inline PERFORM
| without using a GO TO statement or a PERFORM ... THROUGH statement. For
| details, see Format 5 (inline-perform) on page 343.
END-PERFORM
The procedures referenced in the basic PERFORM statement are executed once,
and control then passes to the next executable statement following the PERFORM
statement.
PERFORM
PERFORM
phrase 1:
UNTIL condition-1
TEST BEFORE
WITH AFTER
If the TEST BEFORE phrase is specified or assumed, the condition is tested before
any statements are executed (corresponds to DO WHILE).
In either case, if the condition is true, control is transferred to the next executable
statement following the end of the PERFORM statement. If neither the TEST
BEFORE nor the TEST AFTER phrase is specified, the TEST BEFORE phrase is
assumed.
The format-4 VARYING phrase PERFORM statement can serially search an entire
seven-dimensional table.
phrase 1:
phrase 2:
phrase 3:
When TEST BEFORE is indicated, all specified conditions are tested before the first
execution, and the statements to be performed are executed, if at all, only when all
specified tests fail. When TEST AFTER is indicated, the statements to be performed
are executed at least once, before any condition is tested.
If neither the TEST BEFORE nor the TEST AFTER phrase is specified, the TEST
BEFORE phrase is assumed.
Varying identifiers
The way in which operands are increased or decreased depends on the number of
variables specified. In the discussion, every reference to identifier-n refers equally to
index-name-n (except when identifier-n is the object of the BY phrase).
If identifier-2 or identifier-5 is subscripted, the subscripts are evaluated each time the
content of the data item referenced by the identifier is set or augmented. If
identifier-3, identifier-4, identifier-6, or identifier-7 is subscripted, the subscripts are
evaluated each time the content of the data item referenced by the identifier is
used in a setting or an augmenting operation.
The following figure illustrates the logic of the PERFORM statement when an
identifier is varied with TEST BEFORE.
The following figure illustrates the logic of the PERFORM statement when an
identifier is varied with TEST AFTER.
The following figure illustrates the logic of the PERFORM statement when two
identifiers are varied with TEST BEFORE.
The actions are the same as those for two identifiers, except that identifier-8 goes
through the complete cycle each time that identifier-5 is augmented by identifier-7,
which, in turn, goes through a complete cycle each time that identifier-2 is varied.
You can produce analogous PERFORM statement actions to the previous example
with the addition of up to four AFTER phrases.
There are certain rules that apply to this phrase, no matter how many variables are
specified.
When the READ statement is executed, the associated file must be open in INPUT
or I-O mode.
READ file-name-1
NEXT RECORD INTO identifier-1
END imperative-statement-1
AT
NOT END imperative-statement-2 END-READ
AT
READ file-name-1
RECORD INTO identifier-1
KEY data-name-1
IS
INVALID imperative-statement-3
KEY
NOT INVALID imperative-statement-4 END-READ
KEY
file-name-1
Must be defined in a DATA DIVISION FD entry.
NEXT RECORD
Reads the next record in the logical sequence of records. NEXT is optional
when the access mode is sequential, and has no effect on READ statement
execution.
You must specify the NEXT RECORD phrase to retrieve records
sequentially from files in dynamic access mode.
KEY IS phrase
The KEY IS phrase can be specified only for indexed files. data-name-1 must
identify a record key associated with file-name-1. data-name-1 can be qualified; it
cannot be subscripted.
AT END phrases
For information about INVALID KEY phrase processing, see Invalid key
condition on page 295.
END-READ phrase
This explicit scope terminator serves to delimit the scope of the READ statement.
END-READ permits a conditional READ statement to be nested in another
conditional statement. END-READ can also be used with an imperative READ
statement. For more information, see Delimited scope statements on page 284.
| If the length of the current record that is read is less than the minimum size
| specified by the record description entries for file-name-1, the portion of the record
| area which is to the right of the last valid character read is undefined. If the length
| of the current record exceeds the record description entries for file-name-1, the
| record is truncated on the right to the maximum record definition size.
| In either of the previous cases, the READ statement is successful, and the I-O
| status is set to either 00 (hiding the record length conflict condition) or 04
| (indicating that a record length conflict has occurred), depending on the VLR
| compiler option setting. If compiler option VLR(COMPAT) is in effect, the I-O
| status would be set to 00.
| For more information about the VLR compiler option, see VLR in the Enterprise
| COBOL Programming Guide.
The following example shows two record areas of different sizes in an FD. When a
shorter record is read, the content of the remaining record area is undefined.
FD INPUT-FILE LABEL RECORD OMITTED.
01 RECORD-1 PICTURE X(30).
01 RECORD-2 PICTURE X(20).
Execution of a format-1 READ statement retrieves the next logical record from the
file. The next record accessed is determined by the file organization.
Sequential files
The NEXT RECORD is the next record in a logical sequence of records. The NEXT
phrase need not be specified; it has no effect on READ statement execution.
If SELECT OPTIONAL is specified in the file-control entry for this file, and the file
is unavailable during this execution of the object program, execution of the first
READ statement causes an at-end condition; however, since no file is available, the
system-defined end-of-file processing is not performed.
AT END condition
If the file position indicator indicates that no next logical record exists, or
that an optional input file is not available, at-end condition processing
occurs in a specific order.
The order is:
1. A value derived from the setting of the file position indicator is placed
into the I-O status associated with file-name-1 to indicate the at-end
condition.
2. If the AT END phrase is specified in the statement causing the
condition, control is transferred to imperative-statement-1 in the AT END
phrase. Any USE AFTER STANDARD EXCEPTION procedure
associated with file-name-1 is not executed.
3. If the AT END phrase is not specified and an applicable USE AFTER
STANDARD EXCEPTION procedure exists, the procedure is executed.
Return from that procedure is to the next executable statement
following the end of the READ statement.
Both the AT END phrase and an applicable EXCEPTION/ERROR
procedure can be omitted.
When the at-end condition occurs, execution of the READ statement is
unsuccessful. The contents of the associated record area are undefined
and the file position indicator is set to indicate that no valid next record
has been established.
For QSAM files, attempts to access or move data into the record area
after an unsuccessful read can result in a protection exception.
If an at-end condition does not occur during the execution of a READ
statement, the AT END phrase is ignored, if specified, and the following
actions occur:
1. The file position indicator is set and the I-O status associated with
file-name-1 is updated.
2. If an exception condition that is not an at-end condition exists, control
is transferred to the end of the READ statement after the execution of
any USE AFTER STANDARD EXCEPTION procedure applicable to
file-name-1.
If no USE AFTER STANDARD EXCEPTION procedure is specified,
control is transferred to the end of the READ statement or to
imperative-statement-2, if specified.
The NEXT RECORD is the next logical record in the key sequence.
For indexed files, the key sequence is the sequence of ascending values of the
current key of reference. For relative files, the key sequence is the sequence of
ascending values of relative record numbers for records that exist in the file.
Before the READ statement is executed, the file position indicator must have been
set by a successful OPEN, START, or READ statement. When the READ statement
is executed, the record indicated by the file position indicator is made available if it
is still accessible through the path indicated by the file position indicator.
If the record is no longer accessible (because it has been deleted, for example), the
file position indicator is updated to point to the next existing record in the file, and
that record is made available.
For files in sequential access mode, the NEXT phrase need not be specified.
For files in dynamic access mode, the NEXT phrase must be specified for
sequential record retrieval.
AT END condition
This condition exists when the file position indicator indicates that no next
logical record exists or that an optional input file is not available. The same
procedure occurs as for sequential files (see AT END condition).
If neither an at-end nor an invalid key condition occurs during the
execution of a READ statement, the AT END or the INVALID KEY phrase
is ignored, if specified. The same actions occur as when the at-end
condition does not occur with sequential files (see AT END condition).
Sequentially accessed indexed files
When an ALTERNATE RECORD KEY with DUPLICATES is the key of
reference, file records with duplicate key values are made available in the
order in which they were placed in the file.
Sequentially accessed relative files
Indexed files
Execution of a format-2 READ statement causes the value of the key of reference to
be compared with the value of the corresponding key data item in the file records,
until the first record having an equal value is found. The file position indicator is
positioned to this record, which is then made available. If no record can be so
identified, an INVALID KEY condition exists, and READ statement execution is
unsuccessful. (See Invalid key condition on page 295 for details of the invalid
key condition.)
If the KEY phrase is not specified, the prime RECORD KEY becomes the key of
reference for this request. When dynamic access is specified, the prime RECORD
KEY is also used as the key of reference for subsequent executions of sequential
READ statements, until a different key of reference is established.
When the KEY phrase is specified, data-name-1 becomes the key of reference for
this request. When dynamic access is specified, this key of reference is used for
subsequent executions of sequential READ statements, until a different key of
reference is established.
Relative files
Execution of a format-2 READ statement sets the file position indicator pointer to
the record whose relative record number is contained in the RELATIVE KEY data
item, and makes that record available.
If the file does not contain such a record, the INVALID KEY condition exists, and
READ statement execution is unsuccessful. (See Invalid key condition on page
295 for details of the invalid key condition).
Format 1 with the NEXT phrase must be specified for sequential retrieval. All other
rules for sequential access apply.
The RELEASE statement can be used only within the range of an INPUT
PROCEDURE associated with a SORT statement.
Format: RELEASE
RELEASE record-name-1
FROM identifier-1
When the RELEASE statement is executed, the current contents of record-name-1 are
placed in the sort file. This makes the record available to the initial phase of the
sorting operation.
record-name-1
Must specify the name of a logical record in a sort-merge file description
entry (SD). record-name-1 can be qualified.
FROM phrase
The result of the execution of the RELEASE statement with the FROM
identifier-1 phrase is equivalent to the execution of the following statements
in the order specified.
MOVE identifier-1 to record-name-1.
RELEASE record-name-1.
The MOVE is performed according to the rules for the MOVE statement
without the CORRESPONDING phrase.
identifier-1
identifier-1 must reference one of the following items:
v An entry in the WORKING-STORAGE SECTION, the LOCAL-STORAGE
SECTION, or the LINKAGE SECTION
v A record description for another previously opened file
v An alphanumeric or national function.
identifier-1 must be a valid sending item with record-name-1 as the receiving
item in accordance with the rules of the MOVE statement.
identifier-1 and record-name-1 must not refer to the same storage area.
After the RELEASE statement is executed, the information is still available
in identifier-1. (See INTO and FROM phrases on page 296 under
"Common processing facilities".)
When control passes from the INPUT PROCEDURE, the sort file consists of all
those records placed in it by execution of RELEASE statements.
The RETURN statement can be used only within the range of an OUTPUT
PROCEDURE associated with a SORT or MERGE statement.
RETURN file-name-1
RECORD INTO identifier-1
END imperative-statement-1
AT
NOT END imperative-statement-2 END-RETURN
AT
When the RETURN statement is executed, the next record from file-name-1 is made
available for processing by the OUTPUT PROCEDURE.
file-name-1
Must be described in a DATA DIVISION SD entry.
If more than one record description is associated with file-name-1, those
records automatically share the same storage; that is, the area is implicitly
redefined. After RETURN statement execution, only the contents of the
current record are available. If any data items lie beyond the length of the
current record, their contents are undefined.
INTO phrase
When there is only one record description associated with file-name-1 or all
the records and the data item referenced by identifier-1 describe an
elementary alphanumeric item or an alphanumeric group item, the result
of the execution of a RETURN statement with the INTO phrase is
equivalent to the application of the following rules in the order specified:
v The execution of the same RETURN statement without the INTO phrase.
v The current record is moved from the record area to the area specified
by identifier-1 according to the rules for the MOVE statement without the
CORRESPONDING phrase. The size of the current record is determined
by rules specified for the RECORD clause. If the file description entry
contains a RECORD IS VARYING clause, the implied move is a group
move. The implied MOVE statement does not occur if the execution of
the RETURN statement was unsuccessful. Any subscripting or reference
modification associated with identifier-1 is evaluated after the record has
identifier-1 must be a valid receiving field for the selected sending record
description entry in accordance with the rules of the MOVE statement.
The record areas associated with file-name-1 and identifier-1 must not be the same
storage area.
AT END phrases
END-RETURN phrase
This explicit scope terminator serves to delimit the scope of the RETURN
statement. END-RETURN permits a conditional RETURN statement to be nested in
another conditional statement. END-RETURN can also be used with an imperative
RETURN statement.
REWRITE record-name-1
FROM identifier-1
INVALID imperative-statement-1
KEY
NOT INVALID imperative-statement-2 END-REWRITE
KEY
record-name-1
Must be the name of a logical record in a DATA DIVISION FD entry. The
record-name can be qualified.
FROM phrase
The result of the execution of the REWRITE statement with the FROM
identifier-1 phrase is equivalent to the execution of the following statements
in the order specified.
MOVE identifier-1 TO record-name-1.
REWRITE record-name-1
The MOVE is performed according to the rules for the MOVE statement
without the CORRESPONDING phrase.
identifier-1
identifier-1 can reference one of the following items:
v A record description for another previously opened file
v An alphanumeric or national function
v A data item defined in the WORKING-STORAGE SECTION, the
LOCAL-STORAGE SECTION, or the LINKAGE SECTION
identifier-1 must be a valid sending item with record-name-1 as the receiving
item in accordance with the rules of the MOVE statement.
identifier-1 and record-name-1 must not refer to the same storage area.
After the REWRITE statement is executed, the information is still available
in identifier-1 (INTO and FROM phrases on page 296 under "Common
processing facilities").
END-REWRITE phrase
This explicit scope terminator serves to delimit the scope of the REWRITE
statement. END-REWRITE permits a conditional REWRITE statement to be nested
in another conditional statement. END-REWRITE can also be used with an
imperative REWRITE statement.
The file position indicator is not affected by execution of the REWRITE statement.
If the FILE STATUS clause is specified in the file-control entry, the associated file
status key is updated when the REWRITE statement is executed.
Sequential files
For files in the sequential access mode, the last prior input/output statement
executed for this file must be a successfully executed READ statement. When the
REWRITE statement is executed, the record retrieved by that READ statement is
logically replaced.
The INVALID KEY phrase must not be specified for a file with sequential
organization. An EXCEPTION/ERROR procedure can be specified.
Indexed files
The number of character positions in record-name-1 can be different from the
number of character positions in the record being replaced.
When the access mode is sequential, the record to be replaced is specified by the
value contained in the prime RECORD KEY. When the REWRITE statement is
executed, this value must equal the value of the prime record key data item in the
last record read from this file.
Values of ALTERNATE RECORD KEY data items in the rewritten record can differ
from those in the record being replaced. The system ensures that later access to the
record can be based upon any of the record keys.
Relative files
The number of character positions in record-name-1 can be different from the
number of character positions in the record being replaced.
For relative files in sequential access mode, the INVALID KEY phrase must not be
specified. An EXCEPTION/ERROR procedure can be specified.
For relative files in random or dynamic access mode, the INVALID KEY phrase or
an applicable EXCEPTION/ERROR procedure can be specified. Both can be
omitted.
When the access mode is random or dynamic, the record to be replaced is specified
in the RELATIVE KEY data item. If the file does not contain the record specified,
an invalid key condition exists, and, if specified, the INVALID KEY
imperative-statement is executed. (See Invalid key condition under "Common
processing facilities".) The updating operation does not take place, and the data in
record-name is unaffected.
SEARCH identifier-1
VARYING identifier-2 END imperative-statement-1
index-name-1 AT
AND data-name-2 EQUAL identifier-4
IS TO literal-2
= arithmetic-expression-2
condition-name-2
imperative-statement-2
NEXT SENTENCE END-SEARCH
Use format 1 (serial search) when the table that you want to search has not been
sorted. Use format 1 to search a sorted table when you want to search serially
through the table or you want to control subscripts or indexes.
The function of the AT END phrase is the same for a serial search and a binary
search.
NEXT SENTENCE
NEXT SENTENCE transfers control to the first statement following the closest
separator period.
When NEXT SENTENCE is specified with END-SEARCH, control does not pass to
the statement following the END-SEARCH. Instead, control passes to the statement
after the closest following period.
For the format-2 SEARCH ALL statement, neither imperative-statement-2 nor NEXT
SENTENCE is required. Without them, the SEARCH statement sets the index to
the value in the table that matched the condition.
The function of the NEXT SENTENCE phrase is the same for a serial search and a
binary search.
END-SEARCH phrase
This explicit scope terminator delimits the scope of the SEARCH statement.
END-SEARCH permits a conditional SEARCH statement to be nested in another
conditional statement.
The function of END-SEARCH is the same for a serial search and a binary search.
Serial search
The topic provides information of using the SEARCH statement for serial search.
identifier-1 (serial search)
identifier-1 identifies the table that is to be searched. identifier-1 references
all occurrences within that table.
The data description entry for identifier-1 must contain an OCCURS clause.
The data description entry for identifier-1 should contain an OCCURS
clause with the INDEXED BY phrase, but a table can be searched using an
index defined for an appropriately described different table.
identifier-1 can reference a data item that is subordinate to a data item that
is described with an OCCURS clause (that is, identifier-1 can be a
subordinate table within a multidimensional table). In this case, the data
description entries must specify an INDEXED BY phrase for each
dimension of the table.
Before executing a serial search, you must set the value of the first (or only) index
associated with identifier-1 (the search index) to indicate the starting occurrence for
the search.
Before using a serial search on a multidimensional table, you must also set the
value of the index for each superordinate dimension.
The SEARCH statement modifies only the value in the search index, and, if the
VARYING phrase is specified, the value in index-name-1 or identifier-2. Therefore, to
search an entire two-dimensional to seven-dimensional table, you must execute a
SEARCH statement for each dimension. In the WHEN phrases, you must specify
the indexes for all dimensions. Before the execution of each SEARCH statement,
you must initialize the associated indexes with SET statements.
The SEARCH statement executes a serial search beginning at the current setting of
the search index.
When the search begins, if the value of the index associated with identifier-1 is not
greater than the highest possible occurrence number, the following actions take
place:
v The conditions in the WHEN phrase are evaluated in the order in which they
are written.
v If none of the conditions is satisfied, the index for identifier-1 is increased to
correspond to the next table element, and step 1 is repeated.
v If upon evaluation one of the WHEN conditions is satisfied, the search is
terminated immediately, and the imperative-statement-2 associated with that
condition is executed. The index points to the table element that satisfied the
condition. If NEXT SENTENCE is specified, control passes to the statement
following the closest period.
v If the end of the table is reached (that is, the value of the incremented index is
greater than the highest possible occurrence number) without the WHEN
condition being satisfied, the search is terminated.
If, when the search begins, the value of the index-name associated with identifier-1
is greater than the highest possible occurrence number, the search terminates
immediately.
The following code fragment shows a search of the inner dimension (table C) in the
third occurrence within the superordinate table (table R):
. . .
Working-storage section.
1 G.
2 R occurs 10 indexed by Rindex.
3 C occurs 10 ascending key X indexed by Cindex.
VARYING phrase
index-name-1
One of the following actions applies:
v If index-name-1 is an index for identifier-1, this index is used for the
search. Otherwise, the first (or only) index-name is used.
v If index-name-1 is an index for another table element, then the first (or
only) index-name for identifier-1 is used for the search; the occurrence
number represented by index-name-1 is increased by the same amount as
the search index-name and at the same time.
When the VARYING index-name-1 phrase is omitted, the first (or only)
index-name for identifier-1 is used for the search.
If indexing is used to search a table without an INDEXED BY phrase,
correct results are ensured only if both the table defined with the index
and the table defined without the index have table elements of the same
length and with the same number of occurrences.
When the object of the VARYING phrase is an index-name for another
table element, one serial SEARCH statement steps through two table
elements at once.
identifier-2
Must be either an index data item or an elementary integer item. identifier-2
cannot be subscripted by the first (or only) index-name specified for
identifier-1. During the search, one of the following actions applies:
v If identifier-2 is an index data item, then, whenever the search index is
increased, the specified index data item is simultaneously increased by
the same amount.
v If identifier-2 is an integer data item, then, whenever the search index is
increased, the specified data item is simultaneously increased by 1.
Index
setting: >AT END imperative-
highest statement-1
permissible
occurrence
number
True imperative-
Condition-1 statement-2
False
False
Increment
index-name
for identifier-1
Increment
index-name-1
or identifier-2
These operations are included only when called for in the statement.
Control transfers to the next sentence, unless the imperative statement
ends with a GO TO statement.
Binary search
The topic provides information of using the SEARCH statement for binary search.
identifier-1 (binary search)
identifier-1 identifies the table that is to be searched. identifier-1 references
all occurrences within that table.
The data description entry for identifier-1 must contain an OCCURS clause
with the INDEXED BY and KEY IS phrases.
identifier-1 can reference a data item that is subordinate to a data item that
contains an OCCURS clause (that is, identifier-1 can be a subordinate table
within a multidimensional table). In this case, the data description entry
must specify an INDEXED BY phrase for each dimension of the table.
identifier-1 must not be subscripted or reference-modified.
AT END
The condition that exists when the search operation terminates without
satisfying the conditions specified in the WHEN phrase.
The SEARCH ALL statement executes a binary search. The index associated with
identifier-1 (the search index) need not be initialized by SET statements. The search
index is varied during the search operation so that its value is at no time less than
Before using a binary search on a multidimensional table, you must execute SET
statements to set the value of the index for each superordinate dimension.
The SEARCH statement modifies only the value in the search index. Therefore, to
search an entire two-dimensional to seven-dimensional table, you must execute a
SEARCH statement for each dimension. In the WHEN phrases, you must specify
the indexes for all dimensions.
If the search ends without the WHEN condition being satisfied and the AT END
phrase is specified, imperative-statement-1 is executed. If the AT END phrase is
omitted, control passes to the next statement after the SEARCH statement.
If the WHEN phrase cannot be satisfied for any setting of the index within this
range, the search is unsuccessful. Control is passed to imperative-statement-1 of the
AT END phrase, when specified, or to the next statement after the SEARCH
statement. In either case, the final setting of the index is not predictable.
Index data items cannot be used as subscripts, because of the restrictions on direct
reference to them.
Index-names are related to a given table through the INDEXED BY phrase of the
OCCURS clause; they are not further defined in the program.
When the sending and receiving fields in a SET statement share part of their
storage (that is, the operands overlap), the result of the execution of that SET
statement is undefined.
index-name-1
Receiving field.
Must name an index that is specified in the INDEXED BY phrase of an
OCCURS clause.
identifier-1
Receiving field.
Must name either an index data item or an elementary numeric integer
item.
index-name-2
Sending field.
Must name an index that is specified in the INDEXED BY phrase of an
OCCURS clause. The value of the index before the SET statement is
executed must correspond to an occurrence number of its associated table.
The following table shows valid combinations of sending and receiving fields in a
format-1 SET statement.
Table 47. Sending and receiving fields for format-1 SET statement
Integer data
Index-name Index data item item receiving
Sending field receiving field receiving field field
Index-name* Valid Valid** Valid
** **
Index data item* Valid Valid Invalid
Integer data item Valid Invalid Invalid
Integer literal Valid Invalid Invalid
*An index-name refers to an index named in the INDEXED BY phrase of an OCCURS
clause. An index data item is defined with the USAGE IS INDEX clause.
**
No conversion takes place.
Receiving fields are acted upon in the left-to-right order in which they are
specified. Any subscripting or indexing associated with identifier-1 is evaluated
immediately before that receiving field is acted upon.
The value used for the sending field is the value at the beginning of SET statement
execution.
If index-name-2 is for a table that has a subordinate item that contains an OCCURS
DEPENDING ON clause, then undefined values can be received into identifier-1.
For more information about complex OCCURS DEPENDING ON, see Complex
OCCURS DEPENDING ON in the Enterprise COBOL Programming Guide.
The receiving field is an index specified by index-name-3. The index value both
before and after the SET statement execution must correspond to an occurrence
number in an associated table.
When the format-2 SET statement is executed, the contents of the receiving field
are increased (UP BY) or decreased (DOWN BY) by a value that corresponds to the
number of occurrences represented by the value of identifier-3 or integer-2.
Receiving fields are acted upon in the left-to-right order in which they are
specified. The value of the incrementing or decrementing field at the beginning of
SET statement execution is used for all receiving fields.
If index-name-3 is for a table that has a subordinate item that contains an OCCURS
DEPENDING ON clause, and if the ODO object is changed before executing a
format-2 SET Statement, then index-name-3 cannot contain a value that corresponds
to an occurrence number of its associated table.
For more information about complex OCCURS DEPENDING ON, see Complex
OCCURS DEPENDING ON in the Enterprise COBOL Programming Guide.
SET mnemonic-name-1 TO ON
OFF
mnemonic-name-1
Must be associated with an external switch, the status of which can be
altered.
condition-name-1
Must be associated with a conditional variable.
If more than one literal is specified in the VALUE clause of condition-name-1, its
associated conditional variable is set equal to the first literal.
If multiple condition-names are specified, the results are the same as if a separate
SET statement had been written for each condition-name in the same order in
which they are specified in the SET statement.
identifier-4
Receiving fields.
Must be described as USAGE IS POINTER.
ADDRESS OF identifier-5
Receiving fields.
identifier-5 must be level-01 or level-77 items defined in the LINKAGE
SECTION. The addresses of these items are set to the value of the operand
specified in the TO phrase.
identifier-5 must not be reference-modified.
identifier-6
Sending field.
Must be described as USAGE IS POINTER.
ADDRESS OF identifier-7
Sending field. identifier-7 must name an item of any level except 66 or 88 in
the LINKAGE SECTION, the WORKING-STORAGE SECTION, or the
The following table shows valid combinations of sending and receiving fields in a
format-5 SET statement.
Table 48. Sending and receiving fields for format-5 SET statement
USAGE IS
POINTER receiving ADDRESS OF NULL/NULLS
Sending field field receiving field receiving field
USAGE IS POINTER Valid Valid Invalid
ADDRESS OF Valid Valid Invalid
NULL/NULLS Valid Valid Invalid
SET procedure-pointer-data-item-1
function-pointer-data-item-1
TO procedure-pointer-data-item-2
function-pointer-data-item-2
ENTRY identifier-8
literal-1
NULL
NULLS
pointer-data-item-3
If SELF is specified, the SET statement must appear in the PROCEDURE DIVISION
of a method. object-reference-id-1 is set to reference the object upon which the
currently executing method was invoked.
For sorting files, the SORT statement accepts records from one or more files, sorts
them according to the specified keys, and makes the sorted records available either
through an output procedure or in an output file.
For sorting tables, the SORT statement sorts table elements according to specified
table keys.
|
|
|
| DUPLICATES
WITH IN ORDER
|
| SEQUENCE alphabet-name-1
COLLATING IS
|
|
USING file-name-2
INPUT PROCEDURE procedure-name-1
IS THROUGH procedure-name-2
THRU
|
|
GIVING file-name-3
OUTPUT PROCEDURE procedure-name-3
IS THROUGH procedure-name-4
THRU
| SORT data-name-2
|
ASCENDING
ON DESCENDING KEY data-name-1
|
| DUPLICATES
WITH IN ORDER
|
| SEQUENCE alphabet-name-1
COLLATING IS
|
||
| The KEY phrase can be omitted only if the description of the table that is
| referenced by data-name-2 contains a KEY phrase.
| The words ASCENDING and DESCENDING are transitive across all occurrences of
| data-name-1 until another word ASCENDING or DESCENDING is encountered.
| The data items that are referenced by data-name-1 are key data items, and these
| data items determine the order in which the sorted table elements are stored. The
| order of significance of the keys is the order in which data items are specified in
| the SORT statement, without regard to the association with ASCENDING or
| DESCENDING phrases.
| The SORT statement sorts the table that is referenced by data-name-2 and presents
| the sorted table in data-name-2. The sorting order is determined by either the
| ASCENDING and DESCENDING phrases (if specified), or by the KEY phrase that
| is associated with data-name-2.
| To determine the relative order in which table elements are stored, the contents of
| corresponding key data items are compared according to the rules for comparison
| of operands in a relation condition. The sorting starts with the most significant key
| data item with the following rules:
| v If the contents of the corresponding key data items are not equal and the key is
| associated with the ASCENDING phrase, the table element that contains the key
| data item with the lower value has the lower occurrence number.
| v If the contents of the corresponding key data items are not equal and the key is
| associated with the DESCENDING phrase, the table element that contains the
| key data item with the higher value has the lower occurrence number.
| v If the contents of the corresponding key data items are equal, the determination
| is based on the contents of the next most significant key data item.
| If the KEY phrase is not specified, the sequence is determined by the KEY phrase
| in the data description entry of the table that is referenced by data-name-2.
| If the KEY phrase is specified, it overrides any KEY phrase specified in the data
| description entry of the table that is referenced by data-name-2.
| If data-name-1 is omitted, the data item that is referenced by data-name-2 is the key
| data item.
If the DUPLICATES phrase is specified, and the contents of all the key elements
associated with one record are equal to the corresponding key elements in one or
more other records, the order of return of these records is as follows:
v The order of the associated input files as specified in the SORT statement.
Within a given file the order is that in which the records are accessed from that
file.
v The order in which these records are released by an input procedure, when an
input procedure is specified.
| When both of the following conditions are met, the contents of table elements are
| in the relative order that is the same as the order before sorting operation:
| v The DUPLICATES phrase is specified.
| v The contents of all the key data items that are associated with one table element
| are equal to the contents of corresponding key data items that are associated
| with one or more other table elements.
| If the DUPLICATES phrase is not specified and the second condition exists, the
| relative order of the contents of these table elements is undefined.
The COLLATING SEQUENCE phrase has no effect for keys that are not alphabetic
or alphanumeric.
alphabet-name-1
Must be specified in the ALPHABET clause of the SPECIAL-NAMES
paragraph. alphabet-name-1 can be associated with any one of the
ALPHABET clause phrases, with the following results:
STANDARD-1
The ASCII collating sequence is used for all alphanumeric
comparisons. (The ASCII collating sequence is shown in
Appendix C, EBCDIC and ASCII collating sequences, on page
587.)
STANDARD-2
The International Reference Version of ISO/IEC 646, 7-bit coded
character set for information processing interchange is used for all
alphanumeric comparisons.
NATIVE
The EBCDIC collating sequence is used for all alphanumeric
comparisons. (The EBCDIC collating sequence is shown in
Appendix C, EBCDIC and ASCII collating sequences, on page
587.)
EBCDIC
The EBCDIC collating sequence is used for all alphanumeric
comparisons. (The EBCDIC collating sequence is shown in
Appendix C, EBCDIC and ASCII collating sequences, on page
587.)
literal
The collating sequence established by the specification of literals in
the alphabet-name clause is used for all alphanumeric
comparisons.
USING phrase
file-name-2 , ...
The input files.
When the USING phrase is specified, all the records in file-name-2, ..., (that
is, the input files) are transferred automatically to file-name-1. At the time
the SORT statement is executed, these files must not be open. The compiler
opens, reads, makes records available, and closes these files automatically.
If EXCEPTION/ERROR procedures are specified for these files, the
compiler makes the necessary linkage to these procedures.
All input files must be described in FD entries in the DATA DIVISION.
If the USING phrase is specified and if file-name-1 contains variable-length
records, the size of the records contained in the input files (file-name-2, ...)
must be neither less than the smallest record nor greater than the largest
record described for file-name-1. If file-name-1 contains fixed-length records,
the size of the records contained in the input files must not be greater than
the largest record described for file-name-1. For more information, see
Describing the input to sorting or merging in the Enterprise COBOL
Programming Guide.
This phrase specifies the name of a procedure that is to select or modify input
records before the sorting operation begins.
procedure-name-1
Specifies the first (or only) section or paragraph in the input procedure.
procedure-name-2
Identifies the last section or paragraph of the input procedure.
The input procedure can consist of any procedure needed to select, modify,
or copy the records that are made available one at a time by the RELEASE
statement to the file referenced by file-name-1. The range includes all
statements that are executed as the result of a transfer of control by CALL,
EXIT, GO TO, PERFORM, and XML PARSE statements in the range of the
input procedure, as well as all statements in declarative procedures that are
executed as a result of the execution of statements in the range of the input
procedure. The range of the input procedure must not cause the execution
of any MERGE, RETURN, or SORT statement.
If an input procedure is specified, control is passed to the input procedure
before the file referenced by file-name-1 is sequenced by the SORT
statement. The compiler inserts a return mechanism at the end of the last
statement in the input procedure. When control passes the last statement in
the input procedure, the records that have been released to the file
referenced by file-name-1 are sorted.
GIVING phrase
file-name-3 , ...
The output files.
When the GIVING phrase is specified, all the sorted records in file-name-1
are automatically transferred to the output files (file-name-3, ...).
This phrase specifies the name of a procedure that is to select or modify output
records from the sorting operation.
procedure-name-3
Specifies the first (or only) section or paragraph in the output procedure.
procedure-name-4
Identifies the last section or paragraph of the output procedure.
The output procedure can consist of any procedure needed to select,
modify, or copy the records that are made available one at a time by the
RETURN statement in sorted order from the file referenced by file-name-1.
The range includes all statements that are executed as the result of a
transfer of control by CALL, EXIT, GO TO, PERFORM, and XML PARSE
statements in the range of the output procedure. The range also includes
all statements in declarative procedures that are executed as a result of the
execution of statements in the range of the output procedure. The range of
the output procedure must not cause the execution of any MERGE,
RELEASE, or SORT statement.
| Usage notes:
| v The SORT special registers are not applicable to sorting a table by using the
| format 2 SORT statement.
| v If you use a sort control file to specify control statements, the values specified in
| the sort control file take precedence over those in the special register.
SORT-MESSAGE special register
See SORT-MESSAGE on page 23.
SORT-CORE-SIZE special register
See SORT-CORE-SIZE on page 22.
SORT-FILE-SIZE special register
See SORT-FILE-SIZE on page 23.
SORT-MODE-SIZE special register
See SORT-MODE-SIZE on page 23.
SORT-CONTROL special register
See SORT-CONTROL on page 22.
SORT-RETURN special register
See SORT-RETURN on page 24.
Segmentation considerations
The topic lists considerations of using the SORT statement.
When the START statement is executed, the associated indexed or relative file must
be open in either INPUT or I-O mode.
Format
START file-name-1
KEY EQUAL data-name-1
IS TO
=
GREATER
THAN
>
NOT LESS
THAN
NOT <
GREATER OR EQUAL
THAN TO
>=
INVALID imperative-statement-1
KEY
NOT INVALID imperative-statement-2 END-START
KEY
file-name-1
Must name a file with sequential or dynamic access. file-name-1 must be
defined in an FD entry in the DATA DIVISION and must not name a sort
file.
KEY phrase
When the KEY phrase is specified, the file position indicator is positioned at the
logical record in the file whose key field satisfies the comparison.
When the KEY phrase is not specified, KEY IS EQUAL (to the prime record key) is
implied.
data-name-1
Can be qualified; it cannot be subscripted.
When the START statement is executed, a comparison is made between the current
value in the key data-name and the corresponding key field in the file's index.
If the FILE STATUS clause is specified in the file-control entry, the associated file
status key is updated when the START statement is executed (See File status key
on page 291).
If the comparison is not satisfied by any record in the file, an invalid key condition
exists; the position of the file position indicator is undefined, and (if specified) the
INVALID KEY imperative-statement is executed. (See INTO and FROM phrases
on page 296 under "Common processing facilities".)
END-START phrase
This explicit scope terminator serves to delimit the scope of the START statement.
END-START permits a conditional START statement to be nested in another
conditional statement. END-START can also be used with an imperative START
statement.
Indexed files
When the KEY phrase is specified, the key data item used for the comparison is
data-name-1.
When the KEY phrase is not specified, the key data item used for the EQUAL TO
comparison is the prime record key.
Note: If your key is numeric, you must specify the EQUAL TO condition,
otherwise, unexpected results can happen.
The file position indicator points to the first record in the file whose key field
satisfies the comparison. If the operands in the comparison are of unequal lengths,
the comparison proceeds as if the longer field were truncated on the right to the
length of the shorter field. All other numeric and alphanumeric comparison rules
apply, except that the PROGRAM COLLATING SEQUENCE clause, if specified,
has no effect.
When START statement execution is successful, the RECORD KEY with which
data-name-1 is associated becomes the key of reference for subsequent READ
statements.
Relative files
When the KEY phrase is specified, data-name-1 must specify the RELATIVE KEY.
Whether or not the KEY phrase is specified, the key data item used in the
comparison is the RELATIVE KEY data item. Numeric comparison rules apply.
The file position indicator points to the logical record in the file whose key satisfies
the specified comparison.
Format
STOP RUN
literal
literal
Can be a fixed-point numeric literal (signed or unsigned) or an
alphanumeric literal. It can be any figurative constant except ALL literal.
When STOP literal is specified, the literal is communicated to the operator, and
object program execution is suspended. Program execution is resumed only after
operator intervention, and continues at the next executable statement in sequence.
The STOP literal statement is useful for special situations when operator
intervention is needed during program execution; for example, when a special tape
or disk must be mounted or a specific daily code must be entered. However, the
ACCEPT and DISPLAY statements are preferred when operator intervention is
needed.
Do not use the STOP literal statement in programs compiled with the THREAD
compiler option.
The STOP RUN statement closes all files defined in any of the programs in the run
unit.
For use of the STOP RUN statement in calling and called programs, see the
following table.
Termination
statement Main program Subprogram
STOP RUN Returns to the calling program. (Can be Returns directly to the program that
the system, which causes the called the main program. (Can be
application to end.) the system, which causes the
application to end.)
Format
INTO identifier-3
POINTER identifier-4
WITH
OVERFLOW imperative-statement-1
ON
NOT OVERFLOW imperative-statement-2 END-STRING
ON
identifier-1, literal-1
Represents the sending fields.
DELIMITED BY phrase
Sets the limits of the string.
identifier-2, literal-2
Are delimiters; that is, characters that delimit the data to be
transferred.
SIZE Transfers the complete sending area.
INTO phrase
Identifies the receiving field.
identifier-3
Represents the receiving field.
POINTER phrase
Points to a character position in the receiving field. The pointer field
ON OVERFLOW phrases
imperative-statement-1
Executed when the pointer value (explicit or implicit):
v Is less than 1
v Exceeds a value equal to the length of the receiving field
When either of the above conditions occurs, an overflow condition exists,
and no more data is transferred. Then the STRING operation is terminated,
the NOT ON OVERFLOW phrase, if specified, is ignored, and control is
transferred to the end of the STRING statement or, if the ON OVERFLOW
phrase is specified, to imperative-statement-1.
If control is transferred to imperative-statement-1, execution continues
according to the rules for each statement specified in imperative-statement-1.
If a procedure branching or conditional statement that causes explicit
transfer of control is executed, control is transferred according to the rules
for that statement; otherwise, upon completion of the execution of
imperative-statement-1, control is transferred to the end of the STRING
statement.
If at the time of execution of a STRING statement, conditions that would
cause an overflow condition are not encountered, then after completion of
the transfer of data, the ON OVERFLOW phrase, if specified, is ignored.
Control is then transferred to the end of the STRING statement, or if the
NOT ON OVERFLOW phrase is specified, to imperative-statement-2.
If control is transferred to imperative-statement-2, execution continues
according to the rules for each statement specified in imperative-statement-2.
If a procedure branching or conditional statement that causes explicit
transfer of control is executed, control is transferred according to the rules
for that statement. Otherwise, upon completion of the execution of
imperative-statement-2, control is transferred to the end of the STRING
statement.
END-STRING phrase
This explicit scope terminator serves to delimit the scope of the STRING statement.
END-STRING permits a conditional STRING statement to be nested in another
conditional statement. END-STRING can also be used with an imperative STRING
statement.
Data flow
When the STRING statement is executed, characters are transferred from the
sending fields to the receiving field. The order in which sending fields are
processed is the order in which they are specified.
After STRING statement execution is completed, only that part of the receiving
field into which data was transferred is changed. The rest of the receiving field
contains the data that was present before this execution of the STRING statement.
When the following STRING statement is executed, the results obtained will be
like those illustrated in the figure after the statement.
SIZE ERROR imperative-statement-1
ON
NOT SIZE ERROR imperative-statement-2 END-SUBTRACT
ON
All identifiers or literals preceding the keyword FROM are added together and
their sum is subtracted from and stored immediately in identifier-2. This process is
repeated for each successive occurrence of identifier-2, in the left-to-right order in
which identifier-2 is specified.
GIVING identifier-3
ROUNDED
SIZE ERROR imperative-statement-1
ON
NOT SIZE ERROR imperative-statement-2 END-SUBTRACT
ON
All identifiers or literals preceding the keyword FROM are added together and
their sum is subtracted from identifier-2 or literal-2. The result of the subtraction is
stored as the new value of each data item referenced by identifier-3.
identifier-2
ROUNDED SIZE ERROR imperative-statement-1
ON
NOT SIZE ERROR imperative-statement-2 END-SUBTRACT
ON
Elementary data items within identifier-1 are subtracted from, and the results are
stored in, the corresponding elementary data items within identifier-2.
Floating-point data items and literals can be used anywhere numeric data items
and literals can be specified.
ROUNDED phrase
For information about the ROUNDED phrase, and for operand considerations, see
ROUNDED phrase on page 287.
For information about the SIZE ERROR phrases, and for operand considerations,
see SIZE ERROR phrases on page 287.
END-SUBTRACT phrase
This explicit scope terminator serves to delimit the scope of the SUBTRACT
statement. END-SUBTRACT permits a conditional SUBTRACT statement to be
nested in another conditional statement. END-SUBTRACT can also be used with
an imperative SUBTRACT statement.
Format
UNSTRING identifier-1
INTO
DELIMITED identifier-2
BY ALL literal-1
OR identifier-3
ALL literal-2
identifier-4
DELIMITER identifier-5 COUNT identifier-6
IN IN
POINTER identifier-7 TALLYING identifier-8
WITH IN
OVERFLOW imperative-statement-1 NOT OVERFLOW imperative-statement-2
ON ON
END-UNSTRING
identifier-1
Represents the sending field. Data is transferred from this field to the data
receiving fields (identifier-4).
identifier-1 must reference a data item of category alphabetic, alphanumeric,
alphanumeric-edited, DBCS, national, or national-edited.
identifier-2, literal-1, identifier-3, literal-2
Specifies one or more delimiters.
identifier-2 and identifier-3 must reference data items of category alphabetic,
alphanumeric, alphanumeric-edited, DBCS, national, or national-edited.
Count fields (identifier-6) and pointer fields (identifier-7) are incremented by number
of character positions (alphanumeric, DBCS, or national), not by number of bytes.
The rules for moving are the same as those for a MOVE statement for an
elementary sending item of the category of identifier-1, with the appropriate
identifier-4 as the receiving item (see MOVE statement on page 376). For example,
rules for moving a DBCS item are used when identifier-1 is a DBCS item.
DELIMITED BY phrase
This phrase specifies delimiters within the data that control the data transfer.
When two or more delimiters are specified, an OR condition exists, and each
nonoverlapping occurrence of any one of the delimiters is recognized in the
sending field in the sequence specified.
For example:
DELIMITED BY "AB" or "BC"
INTO phrase
POINTER phrase
When the POINTER phrase is specified, the value of the pointer field, identifier-7,
behaves as if it were increased by 1 for each examined character position in the
sending field. When execution of the UNSTRING statement is completed, the
pointer field contains a value equal to its initial value plus the number of character
positions examined in the sending field.
When this phrase is specified, the user must initialize the pointer field before
execution of the UNSTRING statement begins.
TALLYING IN phrase
When the TALLYING phrase is specified, the area count field, identifier-8, contains
(at the end of execution of the UNSTRING statement) a value equal to the initial
value plus the number of data receiving areas acted upon.
When this phrase is specified, the user must initialize the area count field before
execution of the UNSTRING statement begins.
ON OVERFLOW phrases
END-UNSTRING phrase
This explicit scope terminator serves to delimit the scope of the UNSTRING
statement. END-UNSTRING permits a conditional UNSTRING statement to be
nested in another conditional statement. END-UNSTRING can also be used with
an imperative UNSTRING statement.
Data flow
The data flow for the UNSTRING statement is based on certain rules.
When the UNSTRING statement is initiated, data is transferred from the sending
field to the current data receiving field, according to the following rules:
Stage 1: Examine
1. If the POINTER phrase is specified, the field is examined, beginning at the
relative character position specified by the value in the pointer field.
If the POINTER phrase is not specified, the sending field character-string is
examined, beginning with the leftmost character position.
2. If the DELIMITED BY phrase is specified, the examination proceeds from left to
right, examining character positions one-by-one until a delimiter is
encountered. If the end of the sending field is reached before a delimiter is
Stage 2: Move
3. The examined character positions (excluding any delimiter characters) are
treated as an elementary data item of the same data category as the sending
field except for the cases shown in the table below.
That elementary data item is moved to the current data receiving field
according to the rules for the MOVE statement for the categories of the sending
and receiving fields as described in MOVE statement on page 376.
4. If the DELIMITER IN phrase is specified, the delimiting characters in the
sending field are treated as an elementary alphanumeric item and are moved to
the current delimiter receiving field, according to the rules for the MOVE
statement. If the delimiting condition is the end of the sending field, the current
delimiter receiving field is filled with spaces.
5. If the COUNT IN phrase is specified, a value equal to the number of examined
character positions (excluding any delimiters) is moved into the data count
field, according to the rules for an elementary move.
Stage 3: Successive iterations
6. If the DELIMITED BY phrase is specified, the sending field is further examined,
beginning with the first character position to the right of the delimiter.
If the DELIMITED BY phrase is not specified, the sending field is further
examined, beginning with the first character position to the right of the last
character position examined.
The following figure shows the execution results for an example of the UNSTRING
statement.
WRITE record-name-1
FROM identifier-1
phrase 1
BEFORE identifier-2 END-WRITE
AFTER ADVANCING integer-1 LINE
LINES
mnemonic-name-1
PAGE
invalid_key not_invalid_key
phrase 1:
END-OF-PAGE imperative-statement-3
AT EOP
NOT END-OF-PAGE imperative-statement-4
AT EOP
invalid_key:
INVALID imperative-statement-1
KEY
not_invalid_key:
WRITE record-name-1
FROM identifier-1
INVALID imperative-statement-1
KEY
NOT INVALID imperative-statement-2 END-WRITE
KEY
WRITE record-name-1
FROM identifier-1
AFTER identifier-2
ADVANCING integer-1 LINE
LINES
PAGE
END-WRITE
record-name-1
Must be defined in a DATA DIVISION FD entry. record-name-1 can be
qualified. It must not be associated with a sort or merge file.
For relative files, the number of character positions in the record being
written can be different from the number of character positions in the
record being replaced.
FROM phrase
The result of the execution of the WRITE statement with the FROM
identifier-1 phrase is equivalent to the execution of the following statements
in the order specified:
MOVE identifier-1 TO record-name-1.
WRITE record-name-1.
ADVANCING phrase
The ADVANCING phrase controls positioning of the output record on the page.
The BEFORE and AFTER phrases are not supported for VSAM files. QSAM files
are sequentially organized. The ADVANCING and END-OF-PAGE phrases control
the vertical positioning of each line on a printed page.
You can specify the ADVANCING PAGE and END-OF-PAGE phrases in a single
WRITE statement.
If the printed page is held on an intermediate device (a disk, for example), the
format can appear different from the expected format when the output is edited or
browsed.
LINAGE-COUNTER rules
If the LINAGE clause is specified for this file, the associated LINAGE-COUNTER
special register is modified during the execution of the WRITE statement,
according to the following rules:
1. If ADVANCING PAGE is specified, LINAGE-COUNTER is reset to 1.
2. If ADVANCING identifier-2 or integer is specified, LINAGE-COUNTER is
increased by the value in identifier-2 or integer.
3. If the ADVANCING phrase is omitted, LINAGE-COUNTER is increased by 1.
4. When the device is repositioned to the first available line of a new page,
LINAGE-COUNTER is reset to 1.
Usage note: If you use the ADV compiler option, the compiler adds 1 byte to the
record length in order to allow for the control character. If in your record definition
you already reserve the first byte for the control character, you should use the
NOADV option. For files defined with the LINAGE clause, the NOADV option has
no effect. The compiler processes these files as if the ADV option were specified.
END-OF-PAGE phrases
When END-OF-PAGE is specified, and the logical end of the printed page is
reached during execution of the WRITE statement, the END-OF-PAGE
imperative-statement is executed. When the END-OF-PAGE phrase is specified, the
FD entry for this file must contain a LINAGE clause.
The logical end of the printed page is specified in the associated LINAGE clause.
If the WITH FOOTING phrase of the LINAGE clause is not specified, the
automatic page overflow condition exists because no end-of-page condition (as
distinct from the page overflow condition) can be detected.
If the WITH FOOTING phrase is specified, but the execution of a given WRITE
statement would cause the LINAGE-COUNTER to exceed both the footing value
and the page body value specified in the LINAGE clause, then both the
end-of-page condition and the automatic page overflow condition occur
simultaneously.
You can specify both the ADVANCING PAGE phrase and the END-OF-PAGE
phrase in a single WRITE statement.
The INVALID KEY phrase is not supported for VSAM sequential files.
END-WRITE phrase
This explicit scope terminator serves to delimit the scope of the WRITE statement.
END-WRITE permits a conditional WRITE statement to be nested in another
conditional statement. END-WRITE can also be used with an imperative WRITE
statement.
After the WRITE statement is executed, the logical record is no longer available in
record-name-1 unless either:
v The associated file is named in a SAME RECORD AREA clause (in which case,
the record is also available as a record of the other files named in the SAME
RECORD AREA clause)
v The WRITE statement is unsuccessful because of a boundary violation.
In either of these two cases, the logical record is still available in record-name-1.
The file position indicator is not affected by execution of the WRITE statement.
The number of character positions required to store the record in a file might or
might not be the same as the number of character positions defined by the logical
description of that record in the COBOL program. (See PICTURE clause editing
on page 212 and USAGE clause on page 230.)
If the FILE STATUS clause is specified in the file-control entry, the associated file
status key is updated when the WRITE statement is executed, whether or not
execution is successful.
The WRITE statement can only be executed for a sequential file opened in
OUTPUT or EXTEND mode for QSAM files.
When the punch function is used, the next I-O operation after the READ statement
must be a WRITE statement for the punch function file.
If you want to punch additional data into some of the cards and not into others, a
dummy WRITE statement must be executed for the null cards, first filling the
output area with SPACES.
If stacker selection for the punch function file is required, you can specify the
appropriate stacker function-names in the SPECIAL-NAMES paragraph, and then
code WRITE ADVANCING statements using the associated mnemonic-names.
After the punch function operations (if specified) are completed, you can issue
WRITE statements for the print function file.
If you wish to print additional data on some of the data cards and not on others,
the WRITE statement for the null cards can be omitted. Any attempt to write
beyond the limits of the card results in abnormal termination of the application,
thus, the END-OF-PAGE phrase cannot be specified.
Depending on the capabilities of the specific IBM 3525 model in use, the print file
can be either a two-line print file or a multiline print file. Up to 64 characters can
be printed on each line.
v For a two-line print file, the lines are printed on line 1 (top edge of card) and
line 3 (between rows 11 and 12). Line control cannot be specified. Automatic
spacing is provided.
v For a multiline print file, up to 25 lines of characters can be printed. Line control
can be specified. If line control is not specified, automatic spacing is provided.
Identifier and integer have the same meanings they have for other WRITE AFTER
ADVANCING statements. However, such WRITE statements must not increase the
line position on the card beyond the card limit, or abnormal termination results.
When you use the WRITE ADVANCING phrase with a mnemonic-name associated
with environment-name AFP-5A, a Print Services Facility (PSF) control character is
placed in the control character position of the output record. This control character
(X'5A') allows Advanced Function Printing (AFP) services to be used. For more
information, refer to the documentation for the Print Services Facility product:
PSF for OS/390 & z/OS (5655-B17).
If the ALTERNATE RECORD KEY clause is also specified in the file-control entry,
each alternate record key must be unique, unless the DUPLICATES phrase is
specified. If the DUPLICATES phrase is specified, alternate record key values
might not be unique. In this case, the system stores the records so that later
sequential access to the records allows retrieval in the same order in which they
were stored.
Format
ENCODING codepage XML-DECLARATION ATTRIBUTES
WITH WITH WITH
NAMESPACE identifier-4
IS literal-4 NAMESPACE-PREFIX identifier-5
IS literal-5
|
SUPPRESS identifier-8
when-phrase
generic-suppression-phrase
EXCEPTION imperative-statement-1
ON
NOT EXCEPTION imperative-statement-2 END-XML
ON
WHEN ZERO
ZEROES ZERO
ZEROS OR ZEROES
SPACE ZEROS
SPACES SPACE
LOW-VALUE SPACES
LOW-VALUES LOW-VALUE
HIGH-VALUE LOW-VALUES
HIGH-VALUES HIGH-VALUE
HIGH-VALUES
|
|
| generic-suppression-phrase Format
| when-phrase
EVERY NUMERIC
ATTRIBUTE
CONTENT
ELEMENT
NONNUMERIC
ATTRIBUTE
CONTENT
ELEMENT
ATTRIBUTE
CONTENT
ELEMENT
|
identifier-1
The receiving area for a generated XML document. identifier-1 must
reference one of the following items:
v An elementary data item of category alphanumeric
v An alphanumeric group item
v An elementary data item of category national
v A national group item
When identifier-1 references a national group item, identifier-1 is processed
as an elementary data item of category national. When identifier-1
references an alphanumeric group item, identifier-1 is treated as though it
were an elementary data item of category alphanumeric.
identifier-1 must not be described with the JUSTIFIED clause, and cannot be
a function identifier. identifier-1 can be subscripted or reference modified.
identifier-1 must not overlap identifier-2, identifier-3, codepage (if an
identifier), identifier-4, or identifier-5.
The generated XML output is encoded as described in the documentation
of the ENCODING phrase.
The following data items from the previous example can be specified as
identifier-2:
v STRUCT, of which subordinate data items STAT and IN-AREA would be
converted to XML format. (OK-AREA, NG-AREA1, and NG-AREA2 are ignored
because they specify the REDEFINES clause.)
v OK-AREA, of which subordinate data items FLAGS, COUNTER, and
UNREFERENCED would be converted. (The item whose data description
entry specifies 03 PIC X(3) is ignored because it is an elementary
FILLER data item. ASFNPTR is ignored because it specifies the
REDEFINES clause.)
v Any of the elementary data items that are subordinate to STRUCT except:
ASFNPTR or PTR (disallowed usage)
UNREFERENCED OF NG-AREA2 (nonunique names for data items that are
otherwise eligible)
Any FILLER data items
The following data items cannot be specified as identifier-2:
v NG-AREA1, because subordinate data item PTR specifies USAGE POINTER
but does not specify the REDEFINES clause. (PTR would be ignored if it
specified the REDEFINES clause.)
v NG-AREA2, because subordinate elementary data items have the
nonunique name UNREFERENCED.
COUNT IN phrase
If the COUNT IN phrase is specified, identifier-3 contains (after execution
of the XML GENERATE statement) the count of generated XML character
encoding units. If identifier-1 (the receiver) has category national, the count
is in UTF-16 character encoding units. For all other encodings (including
UTF-8), the count is in bytes.
identifier-3
The data count field. Must be an integer data item defined without
the symbol P in its picture string.
identifier-3 must not overlap identifier-1, identifier-2, codepage (if an
identifier), identifier-4, or identifier-5.
Only the first definition of each storage area is processed. Redefinitions of data
items are not included. Data items that are effectively defined by the RENAMES
clause are also not included.
For information about the format conversion of elementary data, see Format
conversion of elementary data on page 477 and Trimming of generated XML
data on page 479.
The XML element names and attribute names are obtained from the NAME phrase
if specified; otherwise by default they are derived from the data-names within
identifier-2 as described in XML element name and attribute name formation on
page 479. The names of group items that contain the selected elementary items are
retained as parent elements. If the NAMESPACE-PREFIX phrase is specified, the
prefix value, minus any trailing spaces, is used to qualify the start and end tag of
each element.
No extra white space (new lines, indentation, and so forth) is inserted to make the
generated XML more readable. An XML declaration is generated if the
XML-DECLARATION phrase is specified.
If the receiving area specified by identifier-1 is not large enough to contain the
resulting XML document, an error condition exists. See the description of the ON
EXCEPTION phrase above for details.
If identifier-1 is longer than the generated XML document, only that part of
identifier-1 in which XML is generated is changed. The rest of identifier-1 contains
the data that was present before this execution of the XML GENERATE statement.
To avoid referring to that data, either initialize identifier-1 to spaces before the XML
GENERATE statement or specify the COUNT IN phrase.
The XML PARSE statement also uses special register XML-CODE. Therefore if you
code an XML GENERATE statement in the processing procedure of an XML
PARSE statement, save the value of XML-CODE before that XML GENERATE
statement executes and restore the saved value after the XML GENERATE
statement terminates.
A byte order mark is not generated for XML documents that have Unicode
encoding.
Trimming:
After any conversion to character format, leading and trailing spaces and leading
zeroes are eliminated, as described under Trimming of generated XML data on
page 479.
Any remaining instances of the five characters & (ampersand), (apostrophe), >
(greater-than sign), < (less-than sign), and " (quotation mark) are converted into
the equivalent XML references '&', ''', '>', '<', and '"',
respectively.
For more information about the conversion, see Format conversion of elementary
data on page 477.
For values converted from signed numeric values, the leading space is removed if
the value is positive.
For values converted from numeric items, leading zeroes (after any initial minus
sign) up to but not including the digit immediately before the actual or implied
decimal point are eliminated. Trailing zeroes after a decimal point are retained. For
example:
v -012.340 becomes -12.340.
v 0000.45 becomes 0.45.
v 0013 becomes 13.
v 0000 becomes 0.
Character values from data items of class alphabetic, alphanumeric, DBCS, and
national have either trailing or leading spaces removed, depending on whether the
corresponding data items have left (default) or right justification, respectively. That
is, trailing spaces are removed from values whose corresponding data items do not
specify the JUSTIFIED clause. Leading spaces are removed from values whose data
items do specify the JUSTIFIED clause. If a character value consists solely of
spaces, one space remains as the value after trimming is finished.
DBCS data-names, when translated to Unicode, must be legal as names in the XML
specification, version 1.0. For details about the XML specification, see XML
specification.
The XML PARSE statement parses an XML document into its individual pieces and
passes each piece, one at a time, to a user-written processing procedure.
Format
VALIDATING identifier-2
WITH FILE xml-schema-name-1
EXCEPTION imperative-statement-1
ON
NOT EXCEPTION imperative-statement-2 END-XML
ON
identifier-1
identifier-1 must be an elementary data item of category national, a national
group, an elementary data item of category alphanumeric, or an
alphanumeric group item. identifier-1 cannot be a function-identifier.
identifier-1 contains the XML document character stream.
If identifier-1 is a national group item, identifier-1 is processed as an
elementary data item of category national.
If identifier-1 is of category national, its content must be encoded using
| Unicode UTF-16BE (CCSID 1200). If the XMLPARSE(COMPAT) compiler
| option is in effect, identifier-1 must not contain any character entities that
are represented using multiple encoding units. Use a character reference to
represent any such characters, for example:
v "񧘃" or
For each XML event, the parser transfers control to the first statement of
the procedure named procedure-name-1. Control is always returned from the
processing procedure to the XML parser. The point from which control is
returned is determined as follows:
Control flow
When the XML parser receives control from an XML PARSE statement, the parser
analyzes the XML document and transfers control at specific points in the process.
Control returns to the XML parser when the end of the processing procedure is
reached.
The exchange of control between the parser and the processing procedure
continues until either:
v The entire XML document has been parsed, ending with the
END-OF-DOCUMENT event.
v The processing procedure terminates parsing deliberately by setting XML-CODE
to -1 before returning to the parser.
| v When the XMLPARSE(XMLSS) compiler option is in effect: The parser detects an
| exception of any kind.
| v When the XMLPARSE(COMPAT) compiler option is in effect: The parser detects
an exception (other than an encoding conflict) and the processing procedure
does not reset special register XML-CODE to zero before to returning to the
parser.
| v When the XMLPARSE(COMPAT) compiler option is in effect: The parser detects
an encoding conflict exception and the processing procedure does not reset
special register XML-CODE to zero or to the CCSID of the document encoding.
In each case, the processing procedure returns control to the parser. Then, the
parser terminates and returns control to the XML PARSE statement with the
XML-CODE special register containing the most recent value set by the parser or -1
(which might have been set by the parser or by the processing procedure).
For each XML event passed to the processing procedure, the XML-CODE and
XML-EVENT special registers contain information about the particular event.
Special register XML-EVENT is set to the event name, such as
'START-OF-DOCUMENT'. For most events, the XML-TEXT or XML-NTEXT special
| register contains document text. Additionally, when the XMLPARSE(XMLSS)
| compiler option is in effect, the XML-NAMESPACE and XML-NAMESPACE-
| PREFIX or the XML-NNAMESPACE and XML-NNAMESPACE-PREFIX special
| registers contain a namespace identifier and namespace prefix when applicable. See
| XML-EVENT on page 26 for details.
For normal XML events, special register XML-CODE contains zero when the
processing procedure receives control. For XML exception events, XML-CODE
contains an XML exception code as described in XML PARSE exceptions in the
Enterprise COBOL Programming Guide.
For more information about the EXCEPTION event and exception processing, see
Handling XML PARSE exceptions in the Enterprise COBOL Programming Guide.
Data processing problems often require the use of values that are not directly
accessible in the data storage associated with the object program, but instead must
be derived through performing operations on other data. An intrinsic function is a
function that performs a mathematical, character, or logical operation, and thereby
allows you to make reference to a data item whose value is derived automatically
during execution.
The intrinsic functions can be grouped into six categories, based on the type of
service performed:
v Mathematical
v Statistical
v Date/time
v Financial
v Character-handling
v General
You can reference a function by specifying its name, along with any required
arguments, in a PROCEDURE DIVISION statement.
Functions are elementary data items, and return alphanumeric character, national
character, numeric, or integer values. Functions cannot serve as receiving operands.
Specifying a function
You can specify a function using the format as described in the topic.
Format: Function-identifier
FUNCTION function-name-1
( argument-1 )
reference-modifier
function-name-1
function-name-1 must be one of the intrinsic function names.
For some functions, the class and characteristics are determined by the arguments
to the function.
The evaluation of any intrinsic function is not affected by the context in which it
appears; in other words, function evaluation is not affected by operations or
operands outside the function. However, evaluation of a function can be affected
by the attributes of its arguments.
Types of functions
The topic introduces types of functions in COBOL.
Alphanumeric functions are of class and category alphanumeric. The value returned
has an implicit usage of DISPLAY. The number of character positions in the value
returned is determined by the function definition.
Numeric functions are of class and category numeric. The returned value is always
considered to have an operational sign and is a numeric intermediate result. For
more information, see Using numeric intrinsic functions in the Enterprise COBOL
Programming Guide.
Integer functions are of class and category numeric. The returned value is always
considered to have an operational sign and is an integer intermediate result. The
number of digit positions in the value returned is determined by the function
definition. For more information, see Using numeric intrinsic functions in the
Enterprise COBOL Programming Guide.
Usage notes:
v identifier-2 of the CALL statement must not be a function-identifier.
v The COPY statement accepts function-identifiers of all types in the REPLACING
phrase.
Arguments
The value returned by some functions is determined by the arguments specified in
the function-identifier when the functions are evaluated. Some functions require no
arguments; others require a fixed number of arguments, and still others accept a
variable number of arguments.
Some functions place constraints on their arguments, such as the acceptable range
of values. If the values assigned as arguments for a function do not comply with
specified constraints, the returned value is undefined.
Only those arguments at the same function level interact with each other. This
interaction occurs in two areas:
v The computation of an arithmetic expression that appears as a function
argument is affected by other arguments for that function.
v The evaluation of the function takes into consideration the attributes of all of its
arguments.
When a function is evaluated, its arguments are evaluated individually in the order
specified in the list of arguments, from left to right. The argument being evaluated
can be a function-identifier or an expression that includes function-identifiers.
Examples
See examples of using different types of intrinsic functions.
This statement uses the numeric function SUM to add the values of A, B, and C
and places the result in NUM-ITEM.
ALL subscripting
When a function allows an argument to be repeated a variable number of times,
you can refer to a table by specifying the data-name and any qualifiers that
identify the table. This can be followed immediately by subscripting where one or
more of the subscripts is the word ALL.
Tip: The evaluation of an ALL subscript must result in at least one argument or the
value returned by the function will be undefined; however, the situation can be
diagnosed at run time by specifying the SSRANGE compiler option.
For example,
FUNCTION MAX(Table(ALL))
is equivalent to
FUNCTION MAX(Table(1) Table(2) Table(3) ... Table(n))
If there are multiple ALL subscripts, Table-name(ALL, ALL, ALL), the first implicit
argument is Table-name(1, 1, 1), where each ALL has been replaced by 1. The
next argument is Table-name(1, 1, 2), where the rightmost subscript has been
incremented by 1. The subscript represented by the rightmost ALL is incremented
through its range of values to produce an implicit argument for each value.
Once a subscript specified as ALL has been incremented through its range of
values, the next subscript to the left that is specified as ALL is incremented by 1.
Each subscript specified as ALL to the right of the newly incremented subscript is
set to 1 to produce an implicit argument. Once again, the subscript represented by
the rightmost ALL is incremented through its range of values to produce an
implicit argument for each value. This process is repeated until each subscript
specified as ALL has been incremented through its range of values.
For example,
FUNCTION MAX(Table(ALL, ALL))
is equivalent to
FUNCTION MAX(Table(1, 1) Table(1, 2) Table(1, 3) ... Table(1, n)
Table(2, 1) Table(2, 2) Table(2, 3) ... Table(2, n)
Table(3, 1) Table(3, 2) Table(3, 3) ... Table(3, n)
...
Table(m, 1) Table(m, 2) Table(m, 3) ... Table(m, n))
where n is the number of elements in the column dimension of Table, and m is the
number of elements in the row dimension of Table.
For example,
FUNCTION MAX(Table(ALL, 2))
is equivalent to
FUNCTION MAX(Table(1, 2)
Table(2, 2)
Table(3, 2)
...
Table(m, 2))
In these function invocations, the subscript ALL is used to reference all elements of
the PAYROLL-HOURS array (depending on the execution time value of the
PAYROLL-WEEK field).
Function definitions
This section provides an overview of the argument type, function type, and value
returned for each of the intrinsic functions.
For more information about the intrinsic functions, see Table 51 on page 497.
Abbreviation Meaning
A Alphabetic
D DBCS
I Integer
N Numeric
X Alphanumeric
U National
O Other, as specified in the function definition (pointer,
function-pointer, procedure-pointer, or object reference)
Each intrinsic function is described in detail in the topics that follow the table
below.
ACOS
The ACOS function returns a numeric value in radians that approximates the
arccosine of the argument specified.
argument-1
Must be class numeric. The value of argument-1 must be greater than or
equal to -1 and less than or equal to +1.
The returned value is the approximation of the arccosine of the argument and is
greater than or equal to zero and less than or equal to Pi.
ANNUITY
The ANNUITY function returns a numeric value that approximates the ratio of an
annuity paid at the end of each period, for a given number of periods, at a given
interest rate, to an initial value of one.
Format
argument-1
Must be class numeric. The value of argument-1 must be greater than or
equal to zero.
argument-2
Must be a positive integer.
When the value of argument-1 is zero, the value returned by the function is the
approximation of:
1 / argument-2
When the value of argument-1 is not zero, the value of the function is the
approximation of:
Format
argument-1
Must be class numeric. The value of argument-1 must be greater than or
equal to -1 and less than or equal to +1.
The returned value is the approximation of the arcsine of argument-1 and is greater
than or equal to -Pi/2 and less than or equal to +Pi/2.
ATAN
The ATAN function returns a numeric value in radians that approximates the
arctangent of the argument specified.
Format
argument-1
Must be class numeric.
CHAR
The CHAR function returns a one-character alphanumeric value that is a character
in the program collating sequence having the ordinal position equal to the value of
the argument specified.
argument-1
Must be an integer. The value must be greater than zero and less than or
equal to the number of positions in the collating sequence associated with
alphanumeric data items (a maximum of 256).
If more than one character has the same position in the program collating
sequence, the character returned as the function value is that of the first literal
specified for that character position in the ALPHABET clause.
COS
The COS function returns a numeric value that approximates the cosine of the
angle or arc specified by the argument in radians.
Format
argument-1
Must be class numeric.
The returned value is the approximation of the cosine of the argument and is
greater than or equal to -1 and less than or equal to +1.
CURRENT-DATE
The CURRENT-DATE function returns a 21-character alphanumeric value that
represents the calendar date, time of day, and time differential from Greenwich
mean time provided by the system on which the function is evaluated.
Format
FUNCTION CURRENT-DATE
Character
positions Contents
1-4 Four numeric digits of the year in the Gregorian calendar
5-6 Two numeric digits of the month of the year, in the range 01 through
12
7-8 Two numeric digits of the day of the month, in the range 01 through 31
9-10 Two numeric digits of the hours past midnight, in the range 00 through
23
11-12 Two numeric digits of the minutes past the hour, in the range 00
through 59
13-14 Two numeric digits of the seconds past the minute, in the range 00
through 59
15-16 Two numeric digits of the hundredths of a second past the second, in
the range 00 through 99. The value 00 is returned if the system on
which the function is evaluated does not have the facility to provide
the fractional part of a second.
17 Either the character '-' or the character '+'. The character '-' is returned if
the local time indicated in the previous character positions is behind
Greenwich mean time. The character '+' is returned if the local time
indicated is the same as or ahead of Greenwich mean time. The
character '0' is returned if the system on which this function is
evaluated does not have the facility to provide the local time
differential factor.
18-19 If character position 17 is '-', two numeric digits are returned in the
range 00 through 12 indicating the number of hours that the reported
time is behind Greenwich mean time. If character position 17 is '+', two
numeric digits are returned in the range 00 through 13 indicating the
number of hours that the reported time is ahead of Greenwich mean
time. If character position 17 is '0', the value 00 is returned.
20-21 Two numeric digits are returned in the range 00 through 59 indicating
the number of additional minutes that the reported time is ahead of or
behind Greenwich mean time, depending on whether character position
17 is '+' or '-', respectively. If character position 17 is '0', the value 00 is
returned.
For more information, see Examples: numeric intrinsic functions in the Enterprise
COBOL Programming Guide.
DATE-OF-INTEGER
The DATE-OF-INTEGER function converts a date in the Gregorian calendar from
integer date form to standard date form (YYYYMMDD).
argument-1
A positive integer that represents a number of days succeeding December
31, 1600, in the Gregorian calendar. The valid range is 1 to 3,067,671, which
corresponds to dates ranging from January 1, 1601 thru December 31, 9999.
The INTDATE compiler option affects the starting date for the integer date
functions. For details, see INTDATE in the Enterprise COBOL Programming
Guide.
The returned value is an integer of the form YYYYMMDD where YYYY represents
a year in the Gregorian calendar; MM represents the month of that year; and DD
represents the day of that month.
DATE-TO-YYYYMMDD
The DATE-TO-YYYYMMDD function converts argument-1 from a date with a
two-digit year (YYnnnn) to a date with a four-digit year (YYYYnnnn). argument-2,
when added to the year at the time of execution, defines the ending year of a
100-year interval, or sliding century window, into which the year of argument-1
falls.
Format
argument-1
Must be zero or a positive integer less than 991232.
Note: The COBOL run time does not verify that the value is a valid date.
argument-2
Must be an integer. If argument-2 is omitted, the function is evaluated
assuming the value 50 was specified.
The sum of the year at the time of execution and the value of argument-2 must be
less than 10,000 and greater than 1,699.
See the following examples with returned values from the DATE-TO-YYYYMMDD
function:
DAY-OF-INTEGER
The DAY-OF-INTEGER function converts a date in the Gregorian calendar from
integer date form to Julian date form (YYYYDDD).
Format
argument-1
A positive integer that represents a number of days succeeding December
31, 1600, in the Gregorian calendar. The valid range is 1 to 3,067,671, which
corresponds to dates ranging from January 1, 1601 thru December 31, 9999.
The INTDATE compiler option affects the starting date for the integer date
functions. For details, see INTDATE in the Enterprise COBOL Programming
Guide.
The returned value represents the Julian equivalent of the integer specified as
argument-1. The returned value is an integer of the form YYYYDDD where YYYY
represents a year in the Gregorian calendar and DDD represents the day of that
year.
DAY-TO-YYYYDDD
The DAY-TO-YYYYDDD function converts argument-1 from a date with a two-digit
year (YYnnn) to a date with a four-digit year (YYYYnnn). argument-2, when added
to the year at the time of execution, defines the ending year of a 100-year interval,
or sliding century window, into which the year of argument-1 falls.
argument-1
Must be zero or a positive integer less than 99367.
The COBOL run time does not verify that the value is a valid date.
argument-2
Must be an integer. If argument-2 is omitted, the function is evaluated
assuming the value 50 was specified.
The sum of the year at the time of execution and the value of argument-2 must be
less than 10,000 and greater than 1,699.
DISPLAY-OF
The DISPLAY-OF function returns an alphanumeric character string consisting of
the content of argument-1 converted to a specific code page representation.
Format
argument-1
Must be of class national (categories national, national-edited, and
numeric-edited described with usage NATIONAL). argument-1 identifies
the source string for the conversion.
argument-2
Must be an integer. argument-2 identifies the output code page for the
conversion.
argument-2 must be a valid CCSID number and must identify an EBCDIC,
ASCII, UTF-8, or EUC code page. An EBCDIC or ASCII code page can
contain both single-byte and double-byte characters.
The length of the returned value depends on the content of argument-1 and the
characteristics of the output code page.
Usage notes
v The CCSID for UTF-8 is 1208.
v If the output code page includes DBCS characters, the returned value can be a
mixed SBCS and DBCS string.
v The DISPLAY-OF function, with argument-2 specified, can be used to generate
character data represented in a code page that differs from that specified in the
CODEPAGE compiler option. Subsequent COBOL operations on that data can
involve implicit conversions that assume the data is represented in the EBCDIC
code page specified in the CODEPAGE compiler option. See Converting to or from
national (Unicode) representation in the Enterprise COBOL Programming Guide for
examples and programming techniques for processing data represented using
more than one code page within a single program.
Exception: If the conversion fails, a severe runtime error occurs. Verify that the
z/OS Unicode conversion services are installed and are configured to include the
table for converting from CCSID 1200 to the output code page. See the
Customization Guide for installation requirements to support the conversion.
Format
argument-1
If the ARITH(COMPAT) compiler option is in effect, argument-1 must be an
integer greater than or equal to zero and less than or equal to 28. If the
ARITH(EXTEND) compiler option is in effect, argument-1 must be an
integer greater than or equal to zero and less than or equal to 29.
If the value of argument-1 is zero, the value 1 is returned; otherwise, the factorial of
argument-1 is returned.
INTEGER
The INTEGER function returns the greatest integer value that is less than or equal
to the argument specified.
Format
argument-1
Must be class numeric.
The returned value is the greatest integer less than or equal to the value of
argument-1. For example, FUNCTION INTEGER (2.5) returns a value of 2 and
FUNCTION INTEGER (-2.5) returns a value of -3.
INTEGER-OF-DATE
The INTEGER-OF-DATE function converts a date in the Gregorian calendar from
standard date form (YYYYMMDD) to integer date form.
argument-1
Must be an integer of the form YYYYMMDD, whose value is obtained
from the calculation (YYYY * 10,000) + (MM * 100) + DD, where:
v YYYY represents the year in the Gregorian calendar. It must be an
integer greater than 1600, but not greater than 9999.
v MM represents a month and must be a positive integer less than 13.
v DD represents a day and must be a positive integer less than 32,
provided that it is valid for the specified month and year combination.
The returned value is an integer that is the number of days that the date
represented by argument-1 succeeds December 31, 1600 in the Gregorian calendar.
The INTDATE compiler option affects the starting date for the integer date
functions. For details, see INTDATE in the Enterprise COBOL Programming Guide.
INTEGER-OF-DAY
The INTEGER-OF-DAY function converts a date in the Gregorian calendar from
Julian date form (YYYYDDD) to integer date form.
Format
argument-1
Must be an integer of the form YYYYDDD whose value is obtained from
the calculation (YYYY * 1000) + DDD, where:
v YYYY represents the year in the Gregorian calendar. It must be an
integer greater than 1600, but not greater than 9999.
v DDD represents the day of the year. It must be a positive integer less
than 367, provided that it is valid for the year specified.
The returned value is an integer that is the number of days that the date
represented by argument-1 succeeds December 31, 1600 in the Gregorian calendar.
The INTDATE compiler option affects the starting date for the integer date
functions. For details, see INTDATE in the Enterprise COBOL Programming Guide.
Format
argument-1
Must be class numeric.
If the value of argument-1 is zero, the returned value is zero. If the value of
argument-1 is positive, the returned value is the greatest integer less than or equal
to the value of argument-1. If the value of argument-1 is negative, the returned value
is the least integer greater than or equal to the value of argument-1.
LENGTH
The LENGTH function returns an integer equal to the length of the argument in
national character positions for arguments of usage NATIONAL and in
alphanumeric character positions or bytes for all other arguments. An
alphanumeric character position and a byte are equivalent.
Format
argument-1
Can be:
v An alphanumeric literal or a national literal
v A group item (including unbounded groups) or an elementary data item
of any class except DBCS
v A data item described with usage POINTER, PROCEDURE-POINTER,
FUNCTION-POINTER, or OBJECT REFERENCE
v The ADDRESS OF special register
v The LENGTH OF special register
v The XML-NTEXT special register
v The XML-TEXT special register
LOG
The LOG function returns a numeric value that approximates the logarithm to the
base e (natural log) of the argument specified.
Format
argument-1
Must be class numeric. The value of argument-1 must be greater than zero.
LOG10
The LOG10 function returns a numeric value that approximates the logarithm to
the base 10 of the argument specified.
Format
argument-1
Must be class numeric. The value of argument-1 must be greater than zero.
LOWER-CASE
The LOWER-CASE function returns a character string that contains the characters
in the argument with each uppercase letter replaced by the corresponding
lowercase letter.
Format
argument-1
Must be class alphabetic, alphanumeric, or national and must be at least
one character position in length.
The same character string as argument-1 is returned, except that each uppercase
letter is replaced by the corresponding lowercase letter.
MAX
The MAX function returns the content of the argument that contains the maximum
value.
Format
argument-1
Must be class alphabetic, alphanumeric, national, or numeric.
All arguments must be of the same class, except that a combination of alphabetic
and alphanumeric arguments is allowed.
The returned value is the content of argument-1 having the greatest value. The
comparisons used to determine the greatest value are made according to the rules
for simple conditions. For more information, see Conditional expressions on
page 260.
If more than one argument-1 has the same greatest value, the leftmost argument-1
having that value is returned.
If the type of the function is alphanumeric or national, the size of the returned
value is the size of the selected argument-1.
Format
argument-1
Must be class numeric.
The returned value is the arithmetic mean of the argument-1 series. The returned
value is defined as the sum of the argument-1 series divided by the number of
occurrences referenced by argument-1.
MEDIAN
The MEDIAN function returns the content of the argument whose value is the
middle value in the list formed by arranging the arguments in sorted order.
Format
argument-1
Must be class numeric.
The returned value is the content of argument-1 having the middle value in the list
formed by arranging all argument-1 values in sorted order.
The comparisons used to arrange the argument values in sorted order are made
according to the rules for simple conditions. For more information, see
Conditional expressions on page 260.
Format
argument-1
Must be class numeric.
The returned value is the arithmetic mean of the value of the greatest argument-1
and the value of the least argument-1. The comparisons used to determine the
greatest and least values are made according to the rules for simple conditions. For
more information, see Conditional expressions on page 260.
MIN
The MIN function returns the content of the argument that contains the minimum
value.
Format
argument-1
Must be class alphabetic, alphanumeric, national, or numeric.
The returned value is the content of argument-1 having the least value. The
comparisons used to determine the least value are made according to the rules for
simple conditions. For more information, see Conditional expressions on page
260.
If more than one argument-1 has the same least value, the leftmost argument-1
having that value is returned.
If the type of the function is alphanumeric or national, the size of the returned
value is the size of the selected argument-1.
MOD
The MOD function returns an integer value that is argument-1 modulo argument-2.
The function result is an integer with as many digits as the shorter of argument-1
and argument-2.
Format
argument-1
Must be an integer.
argument-2
Must be an integer. Must not be zero.
The returned value is argument-1 modulo argument-2. The returned value is defined
as:
The following table lists expected results for some values of argument-1 and
argument-2.
Format
argument-1
Must be of class alphabetic, alphanumeric, or DBCS. argument-1 specifies
the source string for the conversion.
argument-2
Must be an integer. argument-2 identifies the source code page for the
conversion.
argument-2 must be a valid CCSID number and must identify an EBCDIC,
ASCII, UTF-8, or EUC code page. An EBCDIC or ASCII code page can
contain both single-byte and double-byte characters.
If argument-2 is omitted, the source code page is the one that was in effect
for the CODEPAGE compiler option when the source code was compiled.
The length of the returned value depends on the content of argument-1 and the
characteristics of the source code page.
Exception: If the conversion fails, a severe runtime error occurs. Verify that the
z/OS Unicode conversion services are installed and are configured to include the
table for converting from the source code page to CCSID 1200. See the
Customization Guide for installation requirements to support the conversion.
NUMVAL
The NUMVAL function returns the numeric value represented by the alphanumeric
character string or national character string specified as the argument. The function
removes any leading or trailing spaces in the string to produce a numeric value.
argument-1
Must be an alphanumeric literal, a national literal, or a data item of class
national or class alphanumeric that contains a character string in either of
the following formats:
Format 1: argument-1
digit
space + space . space
- digit
. digit
digit
space . space + space
digit -
. digit CR
DB
Format
argument-1
Must be an alphanumeric literal, a national literal, or a data item of class
alphanumeric or class national that contains a character string in either of
the following formats:
Format 1: argument-1
space + space cs space
-
digit
. space
digit
, digit
. digit
space cs space
digit
. space +
digit -
, digit CR
. digit DB
space
ORD
The ORD function returns an integer value that is the ordinal position of its
argument in the collating sequence for the program. The lowest ordinal position is
1.
Format
argument-1
Must be one character in length and must be class alphabetic or
alphanumeric.
ORD-MAX
The ORD-MAX function returns a value that is the ordinal position in the
argument list of the argument that contains the maximum value.
Format
argument-1
Must be class alphabetic, alphanumeric, national, or numeric.
All arguments must be of the same class, except that a combination of alphabetic
and alphanumeric arguments is allowed.
The returned value is the ordinal number that corresponds to the position of the
argument-1 having the greatest value in the argument-1 series.
If more than one argument-1 has the same greatest value, the number returned
corresponds to the position of the leftmost argument-1 having that value.
ORD-MIN
The ORD-MIN function returns a value that is the ordinal position in the argument
list of the argument that contains the minimum value.
Format
argument-1
Must be class alphabetic, alphanumeric, national, or numeric.
The returned value is the ordinal number that corresponds to the position of the
argument-1 having the least value in the argument-1 series.
If more than one argument-1 has the same least value, the number returned
corresponds to the position of the leftmost argument-1 having that value.
PRESENT-VALUE
The PRESENT-VALUE function returns a value that approximates the present
value of a series of future period-end amounts specified by argument-2 at a
discount rate specified by argument-1.
Format
argument-1
Must be class numeric. Must be greater than -1.
argument-2
Must be class numeric.
argument-2 / (1 + argument-1) ** n
RANDOM
The RANDOM function returns a numeric value that is a pseudorandom number
from a rectangular distribution.
FUNCTION RANDOM
( argument-1 )
argument-1
If argument-1 is specified, it must be zero or a positive integer. However,
only values in the range from zero up to and including 2,147,483,645 yield
a distinct sequence of pseudorandom numbers.
If the first reference to this function in the run unit does not specify argument-1, the
seed value used will be zero.
In each case, subsequent references without specifying argument-1 return the next
number in the current sequence.
For a given seed value, the sequence of pseudorandom numbers is always the
same.
The RANDOM function can be used in threaded programs. For an initial seed, a
single sequence of pseudorandom numbers is returned, regardless of the thread
that is running when RANDOM is invoked.
RANGE
The RANGE function returns a value that is equal to the value of the maximum
argument minus the value of the minimum argument.
Format
argument-1
Must be class numeric.
REM
The REM function returns a numeric value that is the remainder of argument-1
divided by argument-2.
Format
argument-1
Must be class numeric.
argument-2
Must be class numeric. Must not be zero.
REVERSE
The REVERSE function returns a character string of exactly the same length as the
argument, whose characters are exactly the same as those specified in the
argument except that they are in reverse order. For arguments of type national,
character positions are reversed.
Format
The returned value is a character string of the same length as argument-1, with the
characters of argument-1 in reversed order. For example, if argument-1 contains ABC,
the returned value is CBA.
SIN
The SIN function returns a numeric value that approximates the sine of the angle
or arc specified by the argument in radians.
Format
argument-1
Must be class numeric.
The returned value is the approximation of the sine of argument-1 and is greater
than or equal to -1 and less than or equal to +1.
SQRT
The SQRT function returns a numeric value that approximates the square root of
the argument specified.
Format
argument-1
Must be class numeric. The value of argument-1 must be zero or positive.
The returned value is the absolute value of the approximation of the square root of
argument-1.
Format
argument-1
Must be class numeric.
If the argument-1 series consists of only one value, or if the argument-1 series
consists of all variable-occurrence data items and the total number of occurrences
for all of them is one, the returned value is zero.
SUM
The SUM function returns a value that is the sum of the arguments.
Format
The returned value is the sum of the arguments. If the argument-1 series are all
integers, the value returned is an integer. If the argument-1 series are not all
integers, a numeric value is returned.
TAN
The TAN function returns a numeric value that approximates the tangent of the
angle or arc that is specified by the argument in radians.
Format
argument-1
Must be class numeric.
ULENGTH
The ULENGTH function returns an integer value that is equal to the number of
UTF-8 characters in a character string argument that is encoded in UTF-8.
Format
argument-1
Must be of class alphabetic or alphanumeric. argument-1 must contain valid
UTF-8 encoded characters.
If the UTF-8 argument contains composed characters, the combining characters are
counted individually in determining the length. For example, when encoded in
UTF-8, the Unicode character can be x'C3A4' or x'61CC88'. With either of the
UTF-8 characters as argument-1, the returned values of the ULENGTH function are
different. See the following table for details.
UPOS
The UPOS function returns an integer value that is equal to the index of the nth
UTF-8 character in a character string argument that is encoded in UTF-8.
Format
argument-1
Must be of class alphabetic or alphanumeric. argument-1 must contain valid
UTF-8 encoded characters.
argument-2
Must be an integer.
Suppose argument-2=n, the returned value is the byte position of the nth UTF-8
character in argument-1.
UPPER-CASE
The UPPER-CASE function returns a character string that contains the characters in
the argument with each lowercase letter replaced by the corresponding uppercase
letter.
Format
argument-1
Must be of class alphabetic, alphanumeric, or national and must be at least
one character position in length.
The same character string as argument-1 is returned, except that each lowercase
letter is replaced by the corresponding uppercase letter.
If argument-1 is alphabetic or alphanumeric, the lowercase letters 'a' through 'z' are
replaced by the corresponding uppercase letters 'A' through 'Z', where the range of
'a' through 'z' and the range of 'A' through 'Z' are as shown in EBCDIC collating
sequence on page 587, regardless of the code page in effect.
USUBSTR
The USUBSTR function returns a substring of a character string argument that is
encoded in UTF-8.
Format
argument-1
Must be of class alphabetic or alphanumeric. argument-1 must contain valid
UTF-8 encoded characters.
Note: The sum of argument-2 and argument-3 minus one must be less than or equal
to ULENGTH(argument-1).
USUPPLEMENTARY
The USUPPLEMENTARY function returns an integer value that is equal to the
index of the first Unicode supplementary character in a character string argument
that is encoded in UTF-8 or UTF-16.
Format
argument-1
Must be of class alphabetic, alphanumeric, or national. argument-1 must
contain valid UTF-8 or UTF-16 data based on its class:
v If argument-1 is of class alphabetic or alphanumeric, it must contain valid
UTF-8 data.
v If argument-1 is of class national, it must contain valid UTF-16 data.
The returned value is an integer, which differs based on the argument-1 value:
v If the contents of argument-1 are not valid Unicode (UTF-8 or UTF-16, depending
on class), the returned result is unpredictable.
v If argument-1 contains no supplementary characters, the returned value is zero.
For example, the musical G-clef symbol is represented in UTF-16 Unicode by the
surrogate pair nx'D834DD1E', or in UTF-8 Unicode by x'F09D849E'. Thus, for the
following COBOL program fragment, the output of both DISPLAY statements is
value 3.
01 N pic N(4) value nx00200020D834DD1E.
01 X pic X(6) value x2020F09D849E.
01 I pic 9.
...
Compute I = function Usupplementary(N)
Display I
Compute I = function Usupplementary(X)
Display I
UVALID
If a character string consists of valid Unicode UTF-8 or UTF-16 data, the UVALID
function returns the value zero. If a character string contains invalid Unicode data,
the UVALID function returns the index of the first invalid element.
Format
argument-1
Must be of class alphabetic, alphanumeric, or national.
Note: The UVALID function indicates whether the character string contains
well-formed Unicode UTF-8 or UTF-16 data. It does not indicate whether any or all
of the Unicode code points represented by the character string are assigned to
characters.
For UTF-16 data, the validity of an encoding unit varies according to its range as
listed in the table:
Table 54. Encoding unit validity for UTF-16 data
Number of bytes if converted
Value Range Dependency Validity to UTF-8
nx'0000' - nx'007F' None Valid 1
nx'0080' - nx'07FF' None Valid 2
nx'0800' - nx'D7FF' None Valid 3
nx'D800' - nx'DBFF' Must be followed by a second Valid 4
encoding unit with a value in (A Unicode surrogate pair)
the range nx'DC00' to nx'DFFF'
Other cases Invalid Not applicable
nx'E000' - nx'FFFF' None Valid 3
Format
argument-1
Must be of class alphabetic or alphanumeric, and it must contain valid
UTF-8 data.
argument-2
Must be an integer.
VARIANCE
The VARIANCE function returns a numeric value that approximates the variance
of its arguments.
Format
argument-1
Must be class numeric.
The returned value is defined as the square of the standard deviation of the
argument-1 series. This value is calculated as follows:
1. The difference between each argument-1 value and the arithmetic mean of the
argument-1 series is calculated and squared.
2. The values obtained are then added together. This quantity is divided by the
number of values in the argument series.
If the argument-1 series consists of only one value, or if the argument-1 series
consists of all variable-occurrence data items and the total number of occurrences
for all of them is one, the returned value is zero.
WHEN-COMPILED
The WHEN-COMPILED function returns the date and time that the program was
compiled as provided by the system on which the program was compiled.
Format
FUNCTION WHEN-COMPILED
Reading from left to right, the 21 character positions of the returned value are as
follows:
Character
positions Contents
1-4 Four numeric digits of the year in the Gregorian calendar
5-6 Two numeric digits of the month of the year, in the range 01 through
12
7-8 Two numeric digits of the day of the month, in the range 01 through 31
9-10 Two numeric digits of the hours past midnight, in the range 00 through
23
11-12 Two numeric digits of the minutes past the hour, in the range 00
through 59
13-14 Two numeric digits of the seconds past the minute, in the range 00
through 59
15-16 Two numeric digits of the hundredths of a second past the second, in
the range 00 through 99. The value 00 is returned if the system on
which the function is evaluated does not have the facility to provide
the fractional part of a second.
The returned value is the date and time of compilation of the source unit that
contains this function. If a program is a contained program, the returned value is
the compilation date and time associated with the containing program.
YEAR-TO-YYYY
The YEAR-TO-YYYY function converts argument-1, a two-digit year, to a four-digit
year. argument-2, when added to the year at the time of execution, defines the
ending year of a 100-year interval, or sliding century window, into which the year
of argument-1 falls.
Format
argument-1
Must be a non-negative integer that is less than 100.
argument-2
Must be an integer. If argument-2 is omitted, the function is evaluated
assuming the value 50 was specified.
The sum of the year at the time of execution and the value of argument-2 must be
less than 10,000 and greater than 1,699.
Examples of return values from the YEAR-TO-YYYY function are shown in the
following table.
BASIS statement
The BASIS statement is an extended source text library statement. It provides a
complete COBOL program as the source for a compilation.
Format
BASIS basis-name
sequence-number literal-1
sequence-number
Can optionally appear in columns 1 through 6, followed by a space. The
content of this field is ignored.
BASIS
Can appear anywhere in columns 1 through 72, followed by basis-name.
There must be no other text in the statement.
basis-name, literal-1
Is the name by which the library entry is known to the system
environment.
For rules of formation and processing rules, see the description under
literal-1 and text-name of the COPY statement on page 542.
Usage note: If INSERT or DELETE statements are used to modify the COBOL
source text provided by a BASIS statement, the sequence field of the COBOL
source text must contain numeric sequence numbers in ascending order.
Format
CBL
PROCESS options-list
options-list
A series of one or more compiler options, each one separated by a comma
or a space.
For more information about compiler options, see Compiler options in the
Enterprise COBOL Programming Guide.
The CBL (PROCESS) statement must end before or at column 72, and options
cannot be continued across multiple CBL (PROCESS) statements. However, you
can use more than one CBL (PROCESS) statement. Multiple CBL (PROCESS)
statements must follow one another with no intervening statements of any other
type.
The CBL (PROCESS) statement must be placed before any comment lines or other
compiler-directing statements.
*CONTROL SOURCE
*CBL NOSOURCE .
LIST
NOLIST
MAP
NOMAP
For a complete discussion of the output produced by these options, see Getting
listings in the Enterprise COBOL Programming Guide.
The characters *CONTROL or *CBL can start in any column beginning with
column 7, followed by at least one space or comma and one or more option
keywords. The option keywords must be separated by one or more spaces or
commas. This statement must be the only statement on the line, and continuation
is not allowed. The statement can be terminated with a period.
The *CONTROL and *CBL statements must be embedded in a program source. For
example, in the case of batch applications, the *CONTROL and *CBL statements
must be placed between the PROCESS (CBL) statement and the end of the
program (or END PROGRAM marker, if specified).
The source line containing the *CONTROL (*CBL) statement will not appear in the
source listing.
For example, either of the following sets of statements produces a storage map
listing in which A and B will not appear:
*CONTROL NOMAP *CBL NOMAP
01 A 01 A
02 B 02 B
*CONTROL MAP *CBL MAP
COPY statement
The COPY statement is a library statement that places prewritten text in a COBOL
compilation unit.
The effect of processing a COPY statement is that the library text associated with
text-name is copied into the compilation unit, logically replacing the entire COPY
statement, beginning with the word COPY and ending with the period, inclusive.
When the REPLACING phrase is not specified, the library text is copied
unchanged.
| Format
| COPY text-name
| literal-1 OF library-name SUPPRESS
IN literal-2
| .
|
REPLACING operand-1 BY operand-2
LEADING == partial-word-1 == BY == partial-word-2 ==
TRAILNG
|
text-name, library-name
text-name identifies the copy text. library-name identifies where the copy text
exists.
v Can be from 1-30 characters in length
v Can contain the following characters: Latin uppercase letters A-Z, Latin
lowercase letters a-z, digits 0-9, and hyphen
v The first or last character must not be a hyphen
v Cannot contain an underscore
Neither text-name nor library-name need to be unique within a program.
They can be identical to other user-defined words in the program.
text-name need not be qualified. If text-name is not qualified, a library-name
of SYSLIB is assumed.
When compiling from JCL or TSO, only the first eight characters are used
as the identifying name. When compiling with the cob2 command and
processing COPY text residing in the z/OS UNIX file system, all characters
are significant.
literal-1 , literal-2
Must be alphanumeric literals. literal-1 identifies the copy text. literal-2
identifies where the copy text exists.
When compiling from JCL or TSO:
v Literals can be from 1-30 characters in length.
v Literals can contain characters: A-Z, a-z, 0-9, hyphen, @, #, or $.
v The first or last character must not be a hyphen.
v Literals cannot contain an underscore.
v Only the first eight characters are used as the identifying name.
When compiling with the cob2 command and processing COPY text
residing in the z/OS UNIX file system, the literal can be from 1 to 160
characters in length.
For information about the mapping of characters in the text-name, library-name, and
literals, see Compiler-directing statements in the Enterprise COBOL Programming
Guide.
operand-1, operand-2
Can be pseudo-text, an identifier, a function-identifier, a literal, or a
COBOL word (except the word COPY). For details, see REPLACING
| phrase on page 545.
|
| Format
| == pseudo-text ==
identifier
function-identifier
literal
word
|
| partial-word-1, partial-word-2
| Can be a partial-word. For details, see REPLACING phrase on page 545.
Each COPY statement must be preceded by a space and ended with a separator
period.
A COPY statement can appear in the source text anywhere a character string or a
separator can appear.
| COPY statements can be nested, and any COPY statement in a chain of nested
| COPY statements can have the REPLACING phrase, provided there is only one
| such COPY statement in the chain. When the REPLACING phrase is specified for a
| COPY statement that appears in a chain of nested COPY statements, the
| REPLACING phrase applies to all library text that is included by COPY statements
| nested under the COPY statement that has the REPLACING phrase.
A nested COPY statement cannot cause recursion. That is, a COPY member can be
named only once in a set of nested COPY statements until the end-of-file for that
COPY member is reached. For example, assume that the source text contains the
statement: COPY X. and library text X contains the statement: COPY Y..
| In this case, library text contained in Y must not have a COPY X or a COPY Y
| statement.
Library text copied from the library is placed into the same area of the resultant
program as it is in the library. Library text must conform to the rules for the 85
| COBOL Standard format. Library text can consist of or include any words,
| identifiers, or literals that can be written in the source text. This includes DBCS
| user-defined words, DBCS literals, and national literals.
SUPPRESS phrase
The SUPPRESS phrase specifies that the library text is not to be printed on the
source listing.
REPLACING phrase
When the REPLACING phrase is specified, the library text is copied, and each
| properly matched occurrence of operand-1 or partial-word-1 within the library text is
| replaced by the associated operand-2 or partial-word-2.
| In the discussion that follows, when the LEADING or TRAILING keyword of the
| REPLACING phrase is specified, each operand of the REPLACING phrase must be
| a partial-word. Otherwise, each operand can consist of one of the following items:
v Pseudo-text
v An identifier
v A literal
v A COBOL word (except the word COPY)
| v A function-identifier
pseudo-text
| A sequence of text words that are bounded by, but not including,
| pseudo-text delimiters (==). Both characters of each pseudo-text delimiter
| must appear on one line.
| Individual text words within pseudo-text can be up to 322 characters long.
| They can be continued subject to the normal continuation rules for source
| code format.
| A text word must be delimited by separators. For more information, see
| Chapter 1, Characters, on page 3.
pseudo-text-1 refers to pseudo-text when used for operand-1, and
pseudo-text-2 refers to pseudo-text when used for operand-2.
| pseudo-text-1 can be one or more text words. It can consist solely of the
| separator comma or separator semicolon. pseudo-text-2 can be zero or more
| text words. It can consist solely of space characters, comment lines, or
| inline comments.
Each text word in pseudo-text-2 that is to be copied into the program is
placed in the same area of the resultant program as the area in which it
appears in pseudo-text-2.
| Pseudo-text can consist of or include any words (except COPY), identifiers,
| or literals that can be written in the source text. This includes DBCS
| user-defined words, DBCS literals, and national literals.
DBCS user-defined words must be wholly formed; that is, there is no
partial-word replacement for DBCS words.
Words or literals containing DBCS characters cannot be continued across
lines.
Sequences of code (such as file and data descriptions, error, and exception
routines) that are common to a number of programs can be saved in a library, and
then used with the COPY statement. If naming conventions are established for
such common code, the REPLACING phrase need not be specified. If the names
Example 1
In this example, the library text PAYLIB consists of the following DATA DIVISION
entries:
01 A.
02 B PIC S99.
02 C PIC S9(5)V99.
02 D PIC S9999 OCCURS 1 TO 52 TIMES
DEPENDING ON B OF A.
You can use the COPY statement in the DATA DIVISION of a program as follows:
COPY PAYLIB.
In this program, the library text is copied. The resulting text is treated as if it were
written as follows:
01 A.
02 B PIC S99.
02 C PIC S9(5)V99.
02 D PIC S9999 OCCURS 1 TO 52 TIMES
DEPENDING ON B OF A.
Example 2
To change some or all of the names within the library text, you can use the
REPLACING phrase:
COPY PAYLIB REPLACING A BY PAYROLL
B BY PAY-CODE
C BY GROSS-PAY
D BY HOURS.
In this program, the library text is copied. The resulting text is treated as if it were
written as follows:
01 PAYROLL.
02 PAY-CODE PIC S99.
02 GROSS-PAY PIC S9(5)V99.
02 HOURS PIC S9999 OCCURS 1 TO 52 TIMES
DEPENDING ON PAY-CODE OF PAYROLL.
The changes that are shown are made only for this program. The text remains
unchanged as it appears in the library.
Example 3
If the following conventions are followed in the library text, parts of names (for
example, the prefix portion of data names) can be changed with the REPLACING
phrase.
In this example, the library text PAYLIB consists of the following DATA DIVISION
entries:
01 :TAG:.
02 :TAG:-WEEK PIC S99.
02 :TAG:-GROSS-PAY PIC S9(5)V99.
02 :TAG:-HOURS PIC S999 OCCURS 1 TO 52 TIMES
DEPENDING ON :TAG:-WEEK OF :TAG:.
In this program, the library text is copied. The resulting text is treated as if it were
written as follows:
01 PAYROLL.
02 PAYROLL-WEEK PIC S99.
02 PAYROLL-GROSS-PAY PIC S9(5)V99.
02 PAYROLL-HOURS PIC S999 OCCURS 1 TO 52 TIMES
DEPENDING ON PAYROLL-WEEK OF PAYROLL.
The changes that are shown are made only for this program. The text remains
unchanged as it appears in the library.
Example 4
This example shows how to selectively replace level numbers without replacing the
numbers in the PICTURE clause:
COPY xxx REPLACING ==(01)== BY ==(01)==
== 01 == BY == 05 ==.
| Example 5
| You can use the COPY statement in the DATA DIVISION of a program as follows:
| COPY PAYLIB REPLACING LEADING == DEPT == BY == PAYROLL ==.
| In this program, the library text is copied. The resulting text is treated as if it were
| written as follows:
| 01 PAYROLL.
| 02 PAYROLL-WEEK PIC S99.
| 02 PAYROLL-GROSS-PAY PIC S9(5)V99.
| 02 PAYROLL-HOURS PIC S999 OCCURS 1 TO 52 TIMES
| DEPENDING ON PAYROLL-WEEK OF PAYROLL.
| The changes that are shown are made only for this program. The text remains
| unchanged as it appears in the library.
| Example 6
| You can use the COPY statement in the DATA DIVISION of a program as follows:
| COPY PAYLIB REPLACING TRAILING == GROSS-PAY == BY == NET-PAY ==.
| In this program, the library text is copied. The resulting text is treated as if it were
| written as follows:
| 01 PAYROLL.
| 02 PAYROLL-WEEK PIC S99.
| 02 PAYROLL-NET-PAY PIC S9(5)V99.
| 02 PAYROLL-HOURS PIC S999 OCCURS 1 TO 52 TIMES
| DEPENDING ON PAYROLL-WEEK OF PAYROLL.
| The changes that are shown are made only for this program. The text remains
| unchanged as it appears in the library.
| Example 7
| You can use the COPY statement in the DATA DIVISION of a program as follows:
| COPY PAYLIB REPLACING == :TAG: == BY == PAYROLL ==
| TRAILING == GROSS-PAY == BY == NET-PAY ==.
| In this program, the library text is copied. The resulting text is treated as if it were
| written as follows:
| 01 PAYROLL.
| 02 PAYROLL-WEEK PIC S99.
| 02 PAYROLL-GROSS-PAY PIC S9(5)V99.
| 02 PAYROLL-HOURS PIC S999 OCCURS 1 TO 52 TIMES
| DEPENDING ON PAYROLL-WEEK OF PAYROLL.
| The changes that are shown are made only for this program. The text remains
| unchanged as it appears in the library.
| Example 8
| The library text PAYLIB2 consists of the following DATA DIVISION entries:
| 01 PAYROLL2.
| 02 PAYROLL2-WEEK PIC S99.
| 02 :TAG:2-GROSS-PAY PIC S9(5)V99.
| 02 PAYROLL2-HOURS PIC S999 OCCURS 1 TO 52 TIMES
| DEPENDING ON PAYROLL2-WEEK OF PAYROLL2.
| You can use the COPY statement in the DATA DIVISION of a program as follows:
| COPY PAYLIB REPLACING == :TAG: == BY == PAYROLL ==
| TRAILING == GROSS-PAY == BY == NET-PAY ==.
| In this program, the library text is copied. The resulting text is treated as if it were
| written as follows:
| 01 PAYROLL.
| 02 PAYROLL-WEEK PIC S99.
| 02 PAYROLL-NET-PAY PIC S9(5)V99.
| 02 PAYROLL-HOURS PIC S999 OCCURS 1 TO 52 TIMES
| DEPENDING ON PAYROLL-WEEK OF PAYROLL.
|
| 01 PAYROLL2.
| 02 PAYROLL2-WEEK PIC S99.
| 02 PAYROLL2-NET-PAY PIC S9(5)V99.
| 02 PAYROLL2-HOURS PIC S999 OCCURS 1 TO 52 TIMES
| DEPENDING ON PAYROLL2-WEEK OF PAYROLL2.
| The REPLACING phrase in the outermost COPY statement applies not only to the
| library text in PAYLIB but also to the text in PAYLIB2.
| The changes that are shown are made only for this program. The text remains
| unchanged as it appears in the library.
DELETE statement
The DELETE statement is an extended source library statement. It removes COBOL
statements from a source program that was included by a BASIS statement.
Format
DELETE sequence-number-field
sequence-number
sequence-number
Can optionally appear in columns 1 through 6, followed by a space. The
content of this field is ignored.
Source program statements can follow a DELETE statement. These source program
statements are then inserted into the BASIS source program before the statement
following the last statement deleted (that is, in the example above, before the next
statement following deleted statement 000450).
Usage note: If INSERT or DELETE statements are used to modify the COBOL
source program provided by a BASIS statement, the sequence field of the COBOL
source program must contain numeric sequence numbers in ascending order. The
source file remains unchanged. Any INSERT or DELETE statements referring to
these sequence numbers must occur in ascending order.
EJECT statement
The EJECT statement specifies that the next source statement is to be printed at the
top of the next page.
Format
EJECT
.
The EJECT statement must be embedded in a program source. For example, in the
case of batch applications, the EJECT statement must be placed between the CBL
(PROCESS) statement and the end of the program (or the END PROGRAM marker,
if specified).
The EJECT statement has no effect on the compilation of the source unit itself.
ENTER statement
The ENTER statement is designed to facilitate the use of more than one source
language in the same source program. However, only COBOL is allowed in the
source program.
The ENTER statement is syntax checked but has no effect on the execution of the
program.
Format
ENTER language-name-1 .
routine-name-1
language-name-1
A system name that has no defined meaning. It must be either a correctly
formed user-defined word or the word "COBOL." At least one character
must be alphabetic.
routine-name-1
Must follow the rules for formation of a user-defined word. At least one
character must be alphabetic.
INSERT statement
The INSERT statement is a library statement that adds COBOL statements to a
source program that was included by a BASIS statement.
Format
INSERT sequence-number-field
sequence-number
sequence-number
Can optionally appear in columns 1 through 6, followed by a space. The
content of this field is ignored.
New source program statements following the INSERT statement can include any
COBOL syntax.
Usage note: If INSERT or DELETE statements are used to modify the COBOL
source program provided by a BASIS statement, the sequence field of the COBOL
source program must contain numeric sequence numbers in ascending order. The
source file remains unchanged. Any INSERT or DELETE statements referring to
these sequence numbers must occur in ascending order.
Format
READY TRACE .
RESET
You can trace the execution of procedures by using the USE FOR DEBUGGING
declarative as described in Example: USE FOR DEBUGGING in the Enterprise
COBOL Programming Guide.
REPLACE statement
The REPLACE statement is used to replace source text.
Format 1
| REPLACE
|
== pseudo-text-1 == BY == pseudo-text-2 == .
LEADING == partial-word-1 == BY == partial-word-2 ==
TRAILING
Format 2
REPLACE OFF.
Any text replacement currently in effect is discontinued with the format-2 form of
REPLACE. If format 2 is not specified, a specific occurrence of the REPLACE
statement is in effect from the point at which it is specified until the next
occurrence of a REPLACE statement or the end of the separately compiled
program.
| pseudo-text-1, pseudo-text-2
| A sequence of text words that are bounded by, but not including,
| pseudo-text delimiters (==). Both characters of each pseudo-text delimiter
| must appear on one line.
| Individual text words within pseudo-text can be up to 322 characters long.
| They can be continued subject to the normal continuation rules for source
| code format.
| A text word must be delimited by separators. For more information, see
| Chapter 1, Characters, on page 3.
| pseudo-text-1 can be one or more text words. It can consist solely of the
| separator comma or separator semicolon. pseudo-text-2 can be zero or more
| text words. It can consist solely of space characters, comment lines, or
| inline comments.
| Each text word in pseudo-text-2 that is to be copied into the program is
| placed in the same area of the resultant program as the area in which it
| appears in pseudo-text-2.
556 Enterprise COBOL for z/OS, V5.2 Language Reference
| Pseudo-text can consist of or include any words (except COPY), identifiers,
| or literals that can be written in the source text. This includes DBCS
| user-defined words, DBCS literals, and national literals.
| DBCS user-defined words must be wholly formed; that is, there is no
| partial-word replacement for DBCS words.
| Words or literals containing DBCS characters cannot be continued across
| lines.
| partial-word-1, partial-word-2
| A single text word that is bounded by, but not including, pseudo-text
| delimiters (==). Both characters of each pseudo-text delimiter must appear
| on one line. However, the text word within a partial-word can be
| continued.
| The following rules apply to partial-word-1 and partial-word-2:
| v partial-word-1 consists of one text word.
| v partial-word-2 consists of zero or one text word.
| v partial-word-1 and partial-word-2 cannot be an alphanumeric literal,
| national literal, DBCS literal, or DBCS word.
The compiler processes REPLACE statements in source text after the processing of
any COPY statements. COPY must be processed first to assemble complete source
text. Then, REPLACE can be used to modify that source text, performing simple
string substitution. REPLACE statements cannot themselves contain COPY
statements.
| Comparison rules
| The comparison operation that determines text replacement starts with the leftmost
| source text word that follows the REPLACE statement, and with the first word of
| pseudo-text-1 or partial-word-1.
| v pseudo-text-1 is compared to an equivalent number of contiguous source text
| words. pseudo-text-1 matches the source text only if the ordered sequence of text
| words that forms pseudo-text-1 is equal, character for character, to the ordered
| sequence of source text words. For national characters, the sequence of national
| characters must be equal, national character for national character, to the ordered
| sequence of library words.
| v When the LEADING phrase is specified, partial-word-1 matches the source text
| only if the contiguous sequence of characters that forms partial-word-1 is equal,
| character for character, to an equal number of contiguous characters that start
| with the leftmost character position of a source text word.
| When the TRAILING phrase is specified, partial-word-1 matches the source text
| only if the contiguous sequence of characters that forms partial-word-1 is equal,
Replacement rules
| This topic introduces detailed rules for replacement.
| v The sequence of text words in the source text, pseudo-text-1, and partial-word-1 is
| determined by the rules for reference format. For more information, see
| Chapter 6, Reference format, on page 53.
| v Text words that are inserted into the source text as a result of processing a
| REPLACE statement are placed in the source text according to the rules for
| reference format. When inserting text words of pseudo-text-2 or partial-word-2 into
| the source text, additional spaces are introduced only between text words where
| there already exists a space, including the assumed space between source lines.
v If more lines are introduced into the source text as a result of the processing of
REPLACE statements, the indicator area of the introduced lines contains the
same character as the line on which the text being replaced begins, unless that
line contains a hyphen, in which case the introduced line contains a space.
| v If any literal within pseudo-text-2 or partial-word-2 is of a length too great to be
| accommodated on a single line without continuation to another line in the
| resultant program, and the literal is not being placed on a debugging line, more
| continuation lines are introduced that contain the remainder of the literal. If
| replacement requires the continued literal to be continued on a debugging line,
| the program is in error.
Format
SERVICE LABEL
The SERVICE LABEL statement can appear only in the PROCEDURE DIVISION,
but not in the declaratives section.
Format
SKIP statements
The SKIP1, SKIP2, and SKIP3 statements specify blank lines that the compiler
should add when printing the source listing. SKIP statements have no effect on the
compilation of the source text itself.
Format
SKIP1
SKIP2 .
SKIP3
SKIP1
Specifies a single blank line to be inserted in the source listing.
SKIP2
Specifies two blank lines to be inserted in the source listing.
SKIP3
Specifies three blank lines to be inserted in the source listing.
The SKIP statements must be embedded in a program source. For example, in the
case of batch applications, a SKIP1, SKIP2, or SKIP3 statement must be placed
between the CBL (PROCESS) statement and the end of the program or class (or the
END CLASS marker or END PROGRAM marker, if specified).
TITLE statement
The TITLE statement specifies a title to be printed at the top of each page of the
source listing produced during compilation.
Format
TITLE literal
.
literal
Must be an alphanumeric literal, DBCS literal, or national literal and can
be followed by a separator period.
Must not be a figurative constant.
In addition to the default or chosen title, the right side of the title line contains the
following items:
v For programs, the name of the program from the PROGRAM-ID paragraph for
the outermost program. (This space is blank on pages preceding the
PROGRAM-ID paragraph for the outermost program.)
v For classes, the name of the class from the CLASS-ID paragraph.
v Current page number.
v Date and time of compilation.
A title line is produced for each page in the listing produced by the LIST option.
This title line uses the last TITLE statement found in the source statements or the
default.
No other statement can appear on the same line as the TITLE statement.
USE statement
The USE statement defines the conditions under which the procedures that follow
the statement will be executed.
EXCEPTION/ERROR declarative
The EXCEPTION/ERROR declarative specifies procedures for input/output
exception or error handling that are to be executed in addition to the standard
system procedures.
The words EXCEPTION and ERROR are synonymous and can be used
interchangeably.
file-name-1
INPUT
OUTPUT
I-O
EXTEND
file-name-1
Valid for all files. When this option is specified, the procedure is executed
only for the files named. No file-name can refer to a sort or merge file. For
any given file, only one EXCEPTION/ERROR procedure can be specified;
thus, file-name specification must not cause simultaneous requests for
execution of more than one EXCEPTION/ERROR procedure.
A USE AFTER EXCEPTION/ERROR declarative statement specifying the
name of a file takes precedence over a declarative statement specifying the
open mode of the file.
You can include a statement that executes a previously called USE procedure that
is still in control. However, to avoid an infinite loop, you must be sure that there is
an eventual exit at the bottom.
EXCEPTION/ERROR procedures can be used to check the file status key values
whenever an input/output error occurs.
In applying these rules, only the first qualifying declarative is selected for
execution. The order of precedence for selecting a declarative is:
1. A file-specific declarative (that is, a declarative of the form USE AFTER ERROR
ON file-name-1) within the program that contains the statement that caused the
qualifying condition.
2. A mode-specific declarative (that is, a declarative of the form USE AFTER
ERROR ON INPUT) within the program that contains the statement that
caused the qualifying condition.
3. A file-specific declarative that specifies the GLOBAL phrase and is within the
program directly containing the program that was last examined for a
qualifying declarative.
4. A mode-specific declarative that specifies the GLOBAL phrase and is within the
program directly containing the program that was last examined for a
qualifying condition.
Steps 3 and 4 are repeated until the last examined program is the outermost
program, or until a qualifying declarative has been found.
DEBUGGING declarative
Debugging sections are permitted only in the outermost program; they are not
valid in nested programs. Debugging sections are never triggered by procedures
contained in nested programs.
| CALLINTERFACE is the only compiler directive supported. You can use the
| CALLINTERFACE directive to specify the interface convention for CALL and SET
| statements. For more information about CALLINTERFACE, see
| CALLINTERFACE.
| CALLINTERFACE
| The CALLINTERFACE directive specifies the interface convention for CALL and
| SET statements. The convention specified stays in effect until another
| CALLINTERFACE directive is encountered in the source.
| Format
| >>CALLINTERFACE
>>CALLINT DLL
DYNAMIC
STATIC
|
||
| DLL Specifies that the interface convention for subsequent CALL statements is a
| call to a DLL, and that subsequent SET function-pointer and
| procedure-pointer statements are treated as if the DLL compiler option was
| in effect.
| DYNAMIC
| Specifies that the interface convention for subsequent CALL literal
| statements and subsequent SET function-pointer and procedure-pointer
| statements is dynamic (as if the DYNAM compiler option was in effect).
| STATIC
| Specifies that the interface convention for subsequent CALL statements and
| subsequent SET function pointer and procedure pointer statements is static
| (as if the NODLL and NODYNAM compiler options were in effect).
| The REPLACE statement and REPLACING phrase of the COPY statement do not
| affect the CALLINTERFACE directive.
| If you specify both the CALLINTERFACE directive (with suboptions) and the DLL
| or the DYNAM compiler option, the directive overrides the compiler option in
| effect and determines the interface to be used for subsequent CALL and SET
| statements.
| If you specify the CALLINTERFACE directive without any suboptions, the DLL or
| the DYNAM compiler option will determine the interface to use for subsequent
| CALL and SET statements.
| Part 9. Appendixes
| Table 56 lists IBM extensions with a brief description. Standard behavior is shown
| in brackets, [ ], when the standard behavior is not obvious. Extensions are
| described in more detail throughout this document, but they are not further
| identified as extensions.
| Many IBM extensions are distinguished from standard language by their syntax.
| For others, you use compiler options to choose between standard and extension
| behavior. Generally, the related compiler options are noted in the detailed rules.
| For information about compiler options, see Option settings for 85 COBOL Standard
| conformance in the Enterprise COBOL Programming Guide.
| If an item is listed as an extension, all related rules are also extensions. For
| example, USAGE DISPLAY-1 for DBCS characters is listed as an extension; its
| many uses in statements and clauses are also extensions, but are not listed
| separately.
| Table 56. IBM extension language elements
| Language area Extension elements
| COBOL words User-defined words written in DBCS characters
| Method-names
| User-defined words can include an underscore, but not as the first character.
| National character support Support for UTF-16 with USAGE NATIONAL
| (Unicode support)
| Allowance of UTF-8 with USAGE DISPLAY
| Special registers:
| v ADDRESS OF
| v JNIENVPTR
| v LENGTH OF
| v RETURN-CODE
| v SHIFT-IN
| v SHIFT-OUT
| v SORT-CONTROL
| v SORT-CORE-SIZE
| v SORT-FILE-SIZE
| v SORT-MESSAGE
| v SORT-MODE-SIZE
| v SORT-RETURN
| v TALLY
| v WHEN-COMPILED
| v XML-CODE
| v XML-EVENT
| v XML-INFORMATION
| v XML-NAMESPACE
| v XML-NAMESPACE-PREFIX
| v XML-NNAMESPACE
| v XML-NNAMESPACE-PREFIX
| v XML-NTEXT
| v XML-TEXT
| Figurative constants Selection of apostrophe () as the value of the figurative constant QUOTE
| Hexadecimal notation for alphanumeric literals, defined by opening delimiters X" and
| X
| DBCS literals, defined by opening delimiters N", N, G", and G. N" and N are defined
| as DBCS when the NSYMBOL(DBCS) compiler option is in effect.
| National literals N", N, NX", NX for storing literal content as national characters. N"
| and N are defined as national when the NSYMBOL(NATIONAL) compiler option is
| in effect.
| Inline comments
| End markers The following end markers:
| v END CLASS
| v END FACTORY
| v END METHOD
| v END OBJECT
| Indexing and subscripting Referencing a table with an index-name defined for a different table
| In a method definition:
| v METHOD-ID paragraph
| v EXIT METHOD statement
| v END METHOD marker
| Configuration section Repository paragraph
| SPECIAL-NAMES The optional order of clauses. [The 85 COBOL Standard requires that the clauses be
| paragraph coded in the order presented in the syntax diagram.]
| Optionality of a period after the last clause when no clauses are coded. [The 85
| COBOL Standard requires a period, even when no clauses are coded.]
| PASSWORD clause
| A primary or alternate record key defined outside the minimum record size for
| indexed files containing variable-length records. [The 85 COBOL Standard requires
| that the primary and alternate record keys be within the minimum record size.]
| A numeric data item of usage DISPLAY or NATIONAL in the FILE STATUS clause.
| [The 85 COBOL Standard requires an alphanumeric file status data item.]
| Specifying level numbers that are lower than other level numbers at the same
| hierarchical level in a data description entry. [The 85 COBOL Standard requires that
| all elementary or group items at the same level in the hierarchy be assigned identical
| level numbers.]
| Implicit qualification of a key specified without qualifiers when the key name is not
| unique
| Selecting a currency sign and currency symbol with the CURRENCY compiler option
| The effect of the TRUNC compiler option on the value of data items described with a
| usage of BINARY, COMPUTATIONAL, or COMPUTATIONAL-4
| REDEFINES clause Specifying REDEFINES of a redefined data item
| At a subordinate level, specifying a redefining data item that has a size greater than
| the size of the redefined data item
| SYNCHRONIZED clause Specifying SYNCHRONIZED for a level 01 entry
| USAGE clause The following phrases:
| v NATIVE
| v COMP-1 and COMPUTATIONAL-1
| v COMP-2 and COMPUTATIONAL-2
| v COMP-3 and COMPUTATIONAL-3
| v COMP-4 and COMPUTATIONAL-4
| v COMP-5 and COMPUTATIONAL-5
| v DISPLAY-1
| v OBJECT REFERENCE
| v NATIONAL
| v POINTER
| v PROCEDURE-POINTER
| v FUNCTION-POINTER
Referencing data items in the LINKAGE SECTION without a USING phrase in the
PROCEDURE DIVISION header (when those data-names are the operand of an
ADDRESS OF phrase or ADDRESS OF special register)
Specifying a data item in the USING phrase when the data item has a REDEFINES
clause in its description
Omitting the section-header after the declaratives or when there are no declaratives.
[The 85 COBOL Standard requires a section-header following the "DECLARATIVES."
syntax and following the "END DECLARATIVES." syntax.]
Specifying paragraphs that are not contained within a section, even if some
paragraphs are so contained. [The 85 COBOL Standard requires that paragraphs be
within a section except when there are no declaratives. The 85 COBOL Standard
requires that either all paragraphs be in sections or that none be.]
The data-pointer format, the procedure-pointer and function-pointer format, and the
object-reference format
The effect of the PGMNAME compiler option on the name of the program to be
canceled
CLOSE statement WITH NO REWIND phrase
Initializing a data item that contains the DEPENDING phrase of the OCCURS clause
MERGE statement Specifying file-names in a SAME clause
MULTIPLY statement A composite of operands greater than 18 digits
OPEN statement The line-sequential format
Specifying the EXTEND phrase for files that have a LINAGE clause
PERFORM statement An empty in-line PERFORM statement
Omission of both the INVALID KEY phrase and an applicable declarative procedure
Read into an item that is neither an alphanumeric group item nor an elementary
alphanumeric item
RETURN statement Return into an item that is neither an alphanumeric group item nor an elementary
alphanumeric item
REWRITE statement Omission of both the INVALID KEY phrase and an applicable declarative procedure
Rewriting a record with a different number of character positions than the number of
character positions in the record being rewritten
SEARCH statement Specifying END SEARCH with NEXT SENTENCE
Omission of both the NEXT SENTENCE phrase and imperative statements in the
binary search format
SET statement The data-pointer format
For a relative file, writing a different number of character positions than the number
of character positions in the record being replaced
The effect of the ADV compiler option on the length of the record written to a file
Using WRITE ADVANCING with stacker selection for a card punch file
For a relative or indexed file, omission of both the INVALID KEY phrase and an
applicable exception procedure
Intrinsic functions The effect of the INTDATE compiler options on the INTEGER-OF-DATE and
INTEGER-OF-DAY functions
SUPPRESS phrase
Hyphen as the first or last character in the word form of REPLACING operands
The use of any character (other than a COBOL separator) in the word form of
REPLACING operands. [The 85 COBOL Standard accepts only the characters used in
formation of user-defined words.]
With ARITH(EXTEND): 31
PICTURE clause, numeric-edited character positions 249
Picture symbol replication ( ) 999,999,999 bytes
Picture symbol replication (editing) 32,767
Picture symbol replication ( ), class DBCS items 499,999,999 bytes
Picture symbol replication ( ), class national items 499,999,999 bytes
Elementary item size 134,217,727 bytes
OCCURS integer 999,999,999
Total number of ODOs 4,194,303(Note 1)
Table size 999,999,999 bytes
Table element size 999,999,999 bytes
ASCENDING or DESCENDING KEY . . . (per OCCURS 12 KEYS
clause)
Total length of keys (per OCCURS clause) 256 bytes
INDEXED BY . . . (index names per OCCURS clause) 12
Total number of indexes (index names) per class or 65,535
program
Size of relative index 32,765
FILE SECTION
FD record description entry 1,048,575 bytes
FD file-name . . . 65,535
LABEL data-name . . . (if no optional clauses) 255
Label record length 80 bytes
BLOCK CONTAINS integer 2,147,483,647(Note 8)
RECORD CONTAINS integer 1,048,575(Note 5)
LINAGE clause values 99,999,999
SD file-name . . . 65,535
DATA RECORD data-name . . . No limit(Note 2)
LINKAGE SECTION
Total size No limit
LOCAL-STORAGE SECTION
Total size 2,147,483,646 bytes
WORKING-STORAGE SECTION
The ascending collating sequences for both the single-byte EBCDIC (Extended
Binary Coded Decimal Interchange Code) and single-byte ASCII (American
National Standard Code for Information Interchange) character sets are shown in
this appendix. The collating sequence is defined by the ordinal number of
characters in the character set, relative to 1.
The symbols and associated meanings shown for the EBCDIC collating sequence
are those defined in the EBCDIC code page defined with CCSID 1140. Symbols and
meanings can vary for other EBCDIC code pages, but the collating sequence is
unchanged.
The following table presents the collating sequence for single-byte EBCDIC code
page 1140.
The following table presents the collating sequence for the US English ASCII code
page. The collating sequence is the order in which characters are defined in ANSI
INCITS 4, the 7-Bit American National Standard Code for Information Interchange
(7-Bit ASCII), and in the International Reference Version of ISO/IEC 646, 7-Bit Coded
Character Set for Information Interchange.
Debugging lines
A debugging line is a statement that is compiled only when the compile-time switch
is activated. Debugging lines allow you, for example, to check the value of a data
item at certain points in a procedure.
All your debugging lines must be written so that the program is syntactically
correct, whether the debugging lines are compiled or treated as comments.
You can code debugging lines anywhere in your program after the
OBJECT-COMPUTER paragraph.
A debugging line that contains only spaces in Area A and in Area B is treated as a
blank line.
Debugging sections
Debugging sections are permitted only in the outermost program; they are not
valid in nested programs. Debugging sections are never triggered by procedures
contained in nested programs.
A debugging section executes only if both the compile-time switch and the
object-time switch are activated.
For details of the DEBUG-ITEM special register, see DEBUG-ITEM on page 17.
Format
SOURCE-COMPUTER.
computer-name .
DEBUGGING MODE
WITH
Usage note: If you include a COPY statement as a debugging line, the letter "D"
must appear on the first line of the COPY statement. The compiler treats the
copied text as the debugging line or lines. The COPY statement is executed,
regardless of whether WITH DEBUGGING MODE is specified or not.
For details on the format, see the Language Environment Programming Guide.
The USE FOR DEBUGGING declarative procedures are activated when DEBUG is
in effect and inhibited when NODEBUG is in effect.
The debugging lines (lines with "D" or "d" in column 7) are not affected by the
DEBUG or NODEBUG option; they are always active if they have been compiled.
The following table identifies words that are reserved in Enterprise COBOL and
words that you should avoid because they might be reserved in a future release of
Enterprise COBOL.
v Words marked X under Reserved are reserved for function implemented in
Enterprise COBOL. If used as user-defined names, these words are flagged with
an S-level message.
v Words marked X under Standard only are 85 COBOL Standard reserved words
for function not implemented in Enterprise COBOL. (Some of the function is
implemented in the Report Writer Precompiler.) Use of these words as
user-defined names is flagged with an S-level message.
v Words marked X under Potential reserved words are words that might be reserved
in a future release of Enterprise COBOL. IBM recommends that you not use
these words as user-defined names. Use of these words as user-defined names is
flagged with an I-level message.
This column includes words reserved in the 2002 COBOL Standard.
The default reserved word table is shown below. You can select a different reserved
word table by using the WORD compiler option. For details, see WORD in the
Enterprise COBOL Programming Guide.
Table 60. Reserved words
Potential
Word Reserved Standard only reserved words
+ Arithmetic operator - unary plus or X
addition
- Arithmetic operator - unary minus or X
subtraction
* Arithmetic operator - multiplication X
/ Arithmetic operator - division X
** Arithmetic operator - exponentiation X
> Relational operator - greater than X
< Relational operator - less than X
= Relational operator - equal and X
assignment operator in COMPUTE
== Pseudo-text delimiter in COPY and X
REPLACE statements
>= Relational operator - greater than or X
equal
<= Relational operator - less than or X
equal
<> Relational operator - not equal X
*> Comment indicator X
Single-byte ASCII-encoded tape files, when read into the system, are automatically
translated in the buffers into single-byte EBCDIC. Internal manipulation of data is
performed exactly as if the ASCII files were single-byte EBCDIC-encoded files. For
an output file, the system translates the EBCDIC characters into single-byte ASCII
in the buffers before writing the file on tape. Therefore, there are special
considerations concerning ASCII-encoded files when they are processed in COBOL.
ENVIRONMENT DIVISION
In the ENVIRONMENT DIVISION, the OBJECT-COMPUTER, SPECIAL-NAMES,
and FILE-CONTROL paragraphs are affected by the use of ASCII-encoded files.
When alphanumeric comparisons within the object program are to use the ASCII
collating sequence, the PROGRAM COLLATING SEQUENCE clause of the
OBJECT-COMPUTER paragraph must be specified; the alphabet-name used must
also be specified as an alphabet-name in the SPECIAL-NAMES paragraph, and
associated with STANDARD-1. For example:
Object-computer. IBM-system
Program collating sequence is ASCII-sequence.
Special-names. Alphabet ASCII-sequence is standard-1.
The literal option of the alphabet-name clause can be used to process internal data
in a collating sequence other than NATIVE or STANDARD-1.
FILE-CONTROL paragraph
For ASCII files, the ASSIGN clause assignment-name has the following format:
name
label- S-
I-O-CONTROL paragraph
The assignment-name in a RERUN clause must not specify an ASCII-encoded file.
DATA DIVISION
In the DATA DIVISION, there are special considerations for the FD entry and for
data description entries.
For each logical file defined in the ENVIRONMENT DIVISION, there must be a
corresponding FD entry and level-01 record description entry in the FILE
SECTION of the DATA DIVISION.
For example:
Special-names. Alphabet ASCII-sequence is standard-1.
...
FD ASCII-file label records standard
Recording mode is f
Code-set is ASCII-sequence.
PROCEDURE DIVISION
An ASCII-collated sort or merge operation can be specified in two ways as
described in the topic.
v Through the PROGRAM COLLATING SEQUENCE clause in the
OBJECT-COMPUTER paragraph. In this case, the ASCII collating sequence is
used for alphanumeric comparisons explicitly specified in relation conditions
and condition-name conditions.
v Through the COLLATING SEQUENCE phrase of the SORT or MERGE
statement. In this case, only this sort or merge operation uses the ASCII collating
sequence.
For this sort or merge operation, the COLLATING SEQUENCE phrase of the SORT
or MERGE statement takes precedence over the PROGRAM COLLATING
SEQUENCE clause in the OBJECT-COMPUTER paragraph.
See Option settings for 85 COBOL Standard conformance in the Enterprise COBOL
Programming Guide for specification of the compiler options and Language
Environment runtime options that are required to support the above standards.
Appendix H. 2002 COBOL Standard features implemented in Enterprise COBOL Version 5 621
| Table 62. 2002 COBOL Standard features implemented in V5 that will not affect existing programs (continued)
| Features Notes
| Index data item The definition of an index data item may include the
| SYNCHRONIZED clause.
| Intrinsic function facility Previously, the intrinsic function facility was a separate
| module and its implementation was optional. The
| intrinsic function facility is integrated into the
| specification and it shall be implemented by a
| conforming implementation
| New intrinsic functions New intrinsic functions are added:
| v DATE-TO-YYYYMMDD
| v DAY-TO-YYYYDDD
| v DISPLAY-OF
| v NATIONAL-OF
| v YEAR-TO-YYYY
| INVALID KEY phrase The INVALID KEY phrase does not have to be specified
| if there is no applicable USE statement.
| LOCAL-STORAGE SECTION A facility was added to define data that is set to its initial
| values each time a function, method, or program is
| activated. Each instance of this source element has its
| own copy of this data.
| National character handling The capability is added for using large character sets,
| such as ISO/IEC 10646-1, in source text and library text
| and in data at execution time. Class national and
| categories national and national-edited are specified by
| picture character-strings containing the symbol 'N';
| national literals are identified by a separator N", N', NX",
| or NX'. Usage national specifies representation of data in
| a national character set. User-defined words can contain
| extended letters. Processing of data of class national is
| comparable to processing data of class alphanumeric,
| though there are some minor differences. Conversions
| between data of classes alphanumeric and national are
| provided by intrinsic functions.
| Object orientation Support for object-oriented programming has been
| added.
| OCCURS clause Repetition vertically or horizontally and a STEP phrase
| are added for Report Writer.
| Optional word OF Allowed after SUM.
| Optional word FOR and ON Allowed after TYPE CH or CF.
| OR PAGE phrase of the CONTROL HEADING phrase This enables the control heading group to be printed at
| the top of each page and after a control break.
| PAGE FOOTING report group Such a group is allowed to have all relative LINE
| clauses.
| PAGE LIMIT clause New COLUMNS phrase is provided to define maximum
| number of horizontal print positions in each report line
| and a LAST CONTROL HEADING phrase was added.
| Paragraph-name A paragraph-name is not required at the beginning of the
| procedure division or a section.
| PERFORM statement A common exit for multiple active PERFORM statements
| is allowed.
Appendix H. 2002 COBOL Standard features implemented in Enterprise COBOL Version 5 623
| Table 62. 2002 COBOL Standard features implemented in V5 that will not affect existing programs (continued)
| Features Notes
| SUM clause in a report description entry The SUM clause was extended in the following ways:
| v Extension to total a repeating entry.
| v Now allowed in any TYPE of report group, not only
| control footing.
| v SUM of arithmetic-expression format.
| v Checks for overflow of a sum counter during totalling.
| v Any numeric report section item can be totalled, not
| just another sum counter.
| v ROUNDED phrase.
| Underscore (_) character The basic special characters of the COBOL character
| repertoire have been expanded to include the underscore
| (_) character, which can be used in the formation of
| COBOL words.
| UNSTRING statement The sending operand can be reference modified.
| USE BEFORE REPORTING The effect of GLOBAL in a report description and a USE
| declarative is further elucidated.
| VARYING clause A VARYING clause is provided in the validate and
| Report Writer facilities to be used with an OCCURS
| clause.
| WITH RESET phrase This was added to the NEXT PAGE phrase of the NEXT
| GROUP clause to reset PAGE-COUNTER back to 1.
|
Notices
This information was developed for products and services offered in the U.S.A.
IBM might not offer the products, services, or features discussed in this document
in other countries. Consult your local IBM representative for information on the
products and services currently available in your area. Any reference to an IBM
product, program, or service is not intended to state or imply that only that IBM
product, program, or service may be used. Any functionally equivalent product,
program, or service that does not infringe any IBM intellectual property right may
be used instead. However, it is the user's responsibility to evaluate and verify the
operation of any non-IBM product, program, or service.
IBM may have patents or pending patent applications covering subject matter
described in this document. The furnishing of this document does not give you
any license to these patents. You can send license inquiries, in writing, to:
For license inquiries regarding double-byte (DBCS) information, contact the IBM
Intellectual Property Department in your country or send inquiries, in writing, to:
The following paragraph does not apply to the United Kingdom or any other
country where such provisions are inconsistent with local law:
INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS
PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS
FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or
implied warranties in certain transactions, therefore, this statement may not apply
to you.
Any references in this publication to non-IBM Web sites are provided for
convenience only and do not in any manner serve as an endorsement of those Web
sites. The materials at those Web sites are not part of the materials for this IBM
product and use of those Web sites is at your own risk.
Licensees of this program who wish to have information about it for the purpose
of enabling: (i) the exchange of information between independently created
programs and other programs (including this one) and (ii) the mutual use of the
information which has been exchanged, should contact:
IBM Corporation
J46A/G4
555 Bailey Avenue
San Jose, CA 95141-1003
U.S.A.
The licensed program described in this document and all licensed material
available for it are provided by IBM under terms of the IBM Customer Agreement,
IBM International Program License Agreement or any equivalent agreement
between us.
All statements regarding IBM's future direction or intent are subject to change or
withdrawal without notice, and represent goals and objectives only.
If you are viewing this information in softcopy, the photographs and color
illustrations might not appear.
Trademarks
IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of
International Business Machines Corp., registered in many jurisdictions worldwide.
Other product and service names might be trademarks of IBM or other companies.
A current list of IBM trademarks is available on the Web at Copyright and
trademark information at www.ibm.com/legal/copytrade.html.
Intel is a registered trademark of Intel Corporation in the United States and other
countries.
Java and all Java-based trademarks and logos are trademarks or registered
trademarks of Oracle and/or its affiliates.
Microsoft, Windows, Windows NT, and the Windows logo are trademarks of
Microsoft Corporation in the United States, other countries, or both.
Other product and service names might be trademarks of IBM or other companies.
Notices 627
628 Enterprise COBOL for z/OS, V5.2 Language Reference
Glossary
The terms in this glossary are defined in character-string that contains only the
accordance with their meaning in COBOL. These symbol A. An alphabetic data item has
terms might or might not have the same meaning usage DISPLAY.
in other languages.
alphanumeric character
Any character in the computer's
This glossary includes terms and definitions from
single-byte character set.
the following publications:
v ANSI INCITS 23-1985, Programming Languages - alphanumeric character position
COBOL as amended by: See character position.
ANSI INCITS 23a-1989, Programming alphanumeric data item
Languages - Intrinsic Function Module for A general reference to a data item
COBOL, described implicitly or explicitly with
ANSI INCITS 23b-1993, Programming usage DISPLAY and category
Language - Correction Amendment for COBOL alphanumeric, alphanumeric-edited, or
numeric-edited, possibly limited to
v ANSI INCITS 172-2002 American National
specific data categories or specific data
Standard Dictionary of Information Technology.
descriptions by detailed specifications.
American National Standard definitions are alphanumeric-edited data item
preceded by an asterisk (*). A data item described by a PICTURE
character-string that contains at least one
A symbol A or X and at least one of the
simple insertion symbols B, 0, or /. An
* abbreviated combined relation condition
alphanumeric-edited data item has usage
The combined condition that results from
DISPLAY.
the explicit omission of a common subject
or a common subject and common * alphanumeric function
relational operator in a consecutive A function that returns a value that is
sequence of relation conditions. composed of a string of one or more
characters from the computer's
abend Abnormal termination of program.
alphanumeric character set.
* access mode
alphanumeric group item
The manner in which records are to be
A group item that is defined without a
operated upon within a file.
GROUP-USAGE NATIONAL clause. For
* actual decimal point operations such as INSPECT, STRING,
The physical representation, using the and UNSTRING, an alphanumeric group
decimal point characters period (.) or item is processed as though all its content
comma (,), of the decimal point position were described with usage DISPLAY,
in a data item. regardless of the actual content of the
group. For operations that require
* alphabet-name
processing of the elementary items within
A user-defined word, defined in the
a group, such as MOVE
SPECIAL-NAMES paragraph of the
CORRESPONDING, ADD
ENVIRONMENT DIVISION, that names a
CORRESPONDING, and INITIALIZE
specific character set or collating
identifier, an alphanumeric group item is
sequence, or both.
processed using group semantics.
* alphabetic character
alphanumeric literal
A letter or a space character.
A literal that has an opening delimiter
alphabetic data item from the following set:
A data item described with a PICTURE
Glossary 631
to any class of character. For specific to the proposition for which a truth value
classes of characters, the following terms can be defined, that the content of a data
apply: item consists exclusively of those
v Alphanumeric character position, for characters listed in the definition of the
characters represented in usage class-name.
DISPLAY * clause
v DBCS character position, for DBCS An ordered set of consecutive COBOL
characters represented in usage character-strings whose purpose is to
DISPLAY-1 specify an attribute of an entry.
v National character position, for characters COBOL character set
represented in usage NATIONAL; See basic character set.
synonymous with character encoding
unit for UTF-16 * COBOL word
See word.
character set
See basic character set and coded character code page
set. An assignment of graphic characters and
control character meanings to the code
* character-string points in a coded character set; for
A sequence of contiguous characters that example, assignment of characters and
forms a COBOL word, a literal, a meanings to the 256 code points in
PICTURE character-string, or a single-byte EBCDIC or ASCII. The terms
comment-entry. Must be delimited by coded character set and code page can be
separators. used interchangeably.
checkpoint code point
A point at which information about the A unique bit pattern defined in a code
status of a job and the system can be page. Graphic symbols and control
recorded so that the job step can be characters are assigned to code points.
restarted later.
coded character set
class (object-oriented) A set of graphic characters and control
The entity that defines common behavior characters along with their unambiguous
and implementation for zero, one, or assignment to specific code points (their
more objects. The objects that share the encodings). EBCDIC is an example of a
same implementation are considered to be coded character set. A specific instance of
objects of the same class. encodings is called a code page. A code
* class condition page specified by IBM is identified by a
The proposition (for which a truth value CCSID.
can be determined) that the content of an coded character set identifier (CCSID)
item is wholly alphabetic, is wholly An IBM-defined number in the range 1 to
numeric, is wholly DBCS, is wholly Kanji, 65,535 that identifies a specific code page.
or consists exclusively of the characters
that are listed in the definition of a * collating sequence
class-name. The sequence in which the characters that
are acceptable to a computer are ordered
class definition for purposes of sorting, merging,
The COBOL source unit that defines a comparing, and for processing indexed
class. files sequentially.
class-name (object-oriented) column
The name of an object-oriented class A byte position within a print line or
definition. Class-name can refer to a within a reference format line. The
COBOL class-name or a Java class-name. columns are numbered from 1, by 1,
* class-name (of data) starting at the leftmost position of the line
A user-defined word, defined in the
SPECIAL-NAMES paragraph, that refers
Glossary 633
PERFORM, or SEARCH statement. See number, or to be changed or reset to zero
also simple condition and complex condition. or to an arbitrary positive or negative
value.
* conditional phrase
A conditional phrase specifies the action cs See currency symbol.
to be taken upon determination of the
currency sign value
truth value of a condition resulting from
A character-string that identifies the
the execution of a conditional statement.
monetary units stored in a numeric-edited
* conditional statement item. Some examples are '$', 'USD', 'JPY',
A statement specifying that the truth and 'EUR'. A currency sign value can be
value of a condition is to be determined defined by either the CURRENCY
and that the subsequent action of the compiler option or the CURRENCY SIGN
object program is dependent on this truth clause in the SPECIAL-NAMES paragraph
value. of the ENVIRONMENT DIVISION. If the
CURRENCY SIGN clause is not specified
* conditional variable
and the NOCURRENCY compiler option
A data item one or more values of which
is in effect, the dollar sign ($) is used as
has a condition-name assigned to it.
the default currency sign value. See also
* condition-name currency symbol.
A user-defined word that assigns a name
currency symbol
to a subset of values that a conditional
A character used in a PICTURE clause to
variable is permitted to assume; or a
indicate the position of a currency sign
user-defined word assigned to a status of
value in a numeric-edited item. A currency
an implementor defined switch or device.
symbol can be defined by either the
* condition-name condition CURRENCY compiler option or by the
The proposition, for which a truth value CURRENCY SIGN clause in the
can be determined, that the value of a SPECIAL-NAMES paragraph of the
conditional variable is a member of the PROCEDURE DIVISION. If the
set of values attributed to a CURRENCY SIGN clause is not specified
condition-name associated with the and the NOCURRENCY compiler option
conditional variable. is in effect, the dollar sign ($) is used as
the default currency sign value and
* configuration section
currency symbol. Multiple currency
A section of the ENVIRONMENT
symbols and currency sign values can be
DIVISION that describes overall
defined. See also currency sign value.
specifications of source and object
programs, method definitions, and class * current record
definitions. In file processing, the record that is
available in the record area associated
CONSOLE
with a file.
A COBOL environment-name associated
with the operator console. * current volume pointer
A conceptual entity that points to the
* contiguous items
current volume of a sequential file.
Items that are described by consecutive
entries in the DATA DIVISION, and that
D
bear a definite hierarchic relationship to
each other. * data description entry
An entry in the DATA DIVISION
contained program
composed of a level-number followed by
A COBOL program that is nested within
a data-name, if required, and then
another COBOL program.
followed by a set of clauses that describe
* counter the attributes of a data item or record.
A data item used for storing numbers or
* DATA DIVISION
number representations in a manner that
A COBOL division that describes data
permits these numbers to be increased or
and files to be processed at run time.
decreased by the value of another
Glossary 635
do-until edited data item
In structured programming, a do-until A data item that has been modified by
loop will be executed at least once, and suppressing zeroes or inserting editing
until a given condition is true. In COBOL, characters.
a TEST AFTER phrase used with the
* editing character
PERFORM statement functions in the
A single character or a fixed two-character
same way.
combination belonging to the following
do-while set:
In structured programming, a do-while
loop will be executed if, and while, a Character Meaning
given condition is true. In COBOL, a Space
TEST BEFORE phrase used with the 0 Zero
PERFORM statement functions in the
same way. + Plus
- Minus
double-byte ASCII
An IBM character set that includes DBCS CR Credit
and single-byte ASCII characters. (Also DB Debit
known as ASCII DBCS.)
Z Zero suppress
double-byte EBCDIC * Check protect
An IBM character set that includes DBCS
and single-byte EBCDIC characters. (Also $ Currency sign
known as EBCDIC DBCS.) , Comma (decimal point)
Double-Byte Character Set (DBCS) . Period (decimal point)
An IBM coded character set in which each / Forward slash
character is represented by two bytes.
Languages such as Japanese, Chinese, and
Korean, which contain more symbols than * elementary item
can be represented by 256 code points, A data item that is described as not being
require double-byte character sets. further logically subdivided.
Because each character requires two bytes, encoding unit
entering, displaying, and printing DBCS See character encoding unit.
characters requires hardware and
supporting software that are end class marker
DBCS-capable. A combination of words, followed by a
separator period, that indicates the end of
* dynamic access a COBOL class definition. The end class
An access mode in which specific logical marker is:
records can be obtained from or placed END CLASS class-name.
into a mass storage file in a nonsequential
manner and obtained from a file in a end method marker
sequential manner during the scope of the A combination of words, followed by a
same OPEN statement. separator period, that indicates the end of
a COBOL method definition. The end
E method marker is:
END METHOD method-name.
EBCDIC (Extended Binary-Coded Decimal
Interchange Code) * end of PROCEDURE DIVISION
A coded character set consisting of 8-bit The physical position of a COBOL
coded characters. PROCEDURE DIVISION after which no
further procedures appear.
EBCDIC character
Any one of the graphic characters or end program marker
control characters encoded in EBCDIC. A combination of words, followed by a
EBCDIC DBCS
See double-byte EBCDIC.
Glossary 637
and named by the implementor, which is file-name, and then followed by a set of
used to indicate that one of two alternate clauses that include the attributes of the
states exists. file.
* file-name
F
A user-defined word that names a file
factory data connector described in a file description
Data of a factory object. Factory data is entry or a sort-merge file description
allocated once for a class and shared by entry within the FILE SECTION of the
all instances of the class. Factory data is DATA DIVISION.
declared in the WORKING-STORAGE
* file organization
SECTION in the factory paragraph of a
The permanent logical file structure
class definition. Factory data is equivalent
established at the time that a file is
to private static data in Java.
created.
factory method
*file position indicator
A method that is supported by a class
A conceptual entity that contains the
independently of any object instance.
value of the current key within the key of
Factory methods are defined in the
reference for an indexed file, or the record
factory paragraph of the class definition,
number of the current record for a
and are equivalent to public static
sequential file, or the relative record
methods in Java. They are typically used
number of the current record for a
to customize the creation of objects.
relative file, or indicates that no next
* figurative constant logical record exists, or that an optional
A compiler-generated value referenced input file is not available, or that the at
through the use of certain reserved end condition already exists, or that no
words. valid next record has been established.
* file A collection of logical records. * FILE SECTION
The section of the DATA DIVISION that
* file attribute conflict condition
contains file description entries and
An unsuccessful attempt has been made
sort-merge file description entries together
to execute an input-output operation on a
with their associated record descriptions.
file and the file attributes, as specified for
that file in the program, do not match the file system
fixed attributes for that file. The collection of files and file
management structures on a physical or
* file connector
logical mass storage device, such as a
A storage area which contains information
diskette or minidisk.
about a file and is used as the linkage
between a file-name and a physical file * fixed file attributes
and between a file-name and its Information about a file which is
associated record area. established when a file is created and
cannot subsequently be changed during
* file control entry
the existence of the file. These attributes
A SELECT clause and all its subordinate
include the organization of the file
clauses which declare the relevant
(sequential, relative, or indexed), the
physical attributes of a file.
prime record key, the alternate record
* file-control paragraph keys, the code set, the minimum and
A paragraph in the ENVIRONMENT maximum record size, the record type
DIVISION in which the data files for a (fixed or variable), the collating sequence
given source unit are declared. of the keys for indexed files, the blocking
factor, the padding character, and the
* file description entry
record delimiter.
An entry in the FILE SECTION of the
DATA DIVISION that is composed of the * fixed-length record
level indicator FD, followed by a A record associated with a file whose file
description or sort-merge description
Glossary 639
method-name in a parent class. Thus, the indexed data-name
method in the subclass hides the method An identifier that is composed of a
in the parent class. data-name, followed by one or more
index-names enclosed in parentheses.
* high order end
The leftmost character of a string of * indexed file
characters. A file with indexed organization.
* indexed organization
I
The permanent logical file structure in
IBM extensions which each record is identified by the
COBOL syntax and semantics specified by value of one or more keys within that
IBM, rather than by the 85 COBOL record.
Standard.
indexing
IDENTIFICATION DIVISION Subscripting using index-names.
One of the four main component parts of
* index-name
a COBOL program, class definition, or
A user-defined word that names an index
method definition. The IDENTIFICATION
associated with a specific table.
DIVISION identifies the program, class, or
method. The IDENTIFICATION inheritance
DIVISION can include the following A mechanism for using the
documentation: author name, installation, implementation of a class (the superclass)
or date. as the basis for a new class (a subclass).
Each subclass inherits from exactly one
* identifier
class. The inherited class can itself be a
Syntax that references a resource, such as
subclass that inherits from another class.
a data item. An identifier that refers to
data item includes the data-name and Enterprise COBOL does not support
optionally includes qualifiers, multiple inheritance. It supports the Java
subscripting, and reference modification. object model, which provides single
inheritance.
* imperative statement
A statement that specifies an * initial program
unconditional action to be taken or a A program that is placed into an initial
conditional statement that is delimited by state every time the program is called in a
its explicit scope terminator (a delimited run unit.
scope statement). An imperative statement
* initial state
can consist of a sequence of imperative
The state of a program when it is first
statements.
called in a run unit.
* implicit scope terminator
inline
A separator period that terminates the
In a program, instructions that are
scope of any preceding unterminated
executed sequentially, without branching
statement, or a phrase of a statement that
to routines, subroutines, or other
by its occurrence indicates the end of the
programs.
scope of any statement contained within
the preceding phrase. * input file
A file that is opened in the INPUT mode.
* index
A computer storage area or register, the * input mode
content of which represents the The state of a file after execution of an
identification of a particular element in a OPEN statement, with the INPUT phrase
table. specified, for that file and before the
execution of a CLOSE statement, without
* index data item
the REEL or UNIT phrase for that file.
A data item in which the values
associated with an index-name can be * input-output file
stored in a form specified by the A file that is opened in the I-O mode.
implementor.
Glossary 641
OPEN statement, with the I-O phrase v Uppercase letters: A, B, C, D, E, F, G,
specified, for that file and before the H, I, J, K, L, M, N, O, P, Q, R, S, T, U,
execution of a CLOSE statement without V, W, X, Y, Z
the REEL or UNIT phase for that file. v Lowercase letters: a, b, c, d, e, f, g, h, i,
* I-O status j, k, l, m, n, o, p, q, r, s, t, u, v, w, x, y, z
A conceptual entity which contains the * level indicator
two-character value indicating the Two alphabetic characters that identify a
resulting status of an input-output specific type of file or a position in a
operation. This value is made available to hierarchy. The level indicators in the
the program through the use of the FILE DATA DIVISION are: CD, FD, and SD.
STATUS clause in the file control entry for
the file. * level-number
A user-defined word, expressed as a
J two-digit number, which indicates the
hierarchical position of a data item or the
Java Native Interface (JNI) special properties of a data description
A programming interface that allows Java entry. Level-numbers in the range from 1
code running inside a Java virtual through 49 indicate the position of a data
machine (JVM) to interoperate with item in the hierarchical structure of a
applications and libraries written in other logical record. Level-numbers in the range
programming languages. 1 through 9 can be written either as a
single digit or as a zero followed by a
K significant digit. Level-numbers 66, 77,
K When referring to storage capacity, two to and 88 identify special properties of a
the tenth power; 1024 in decimal notation. data description entry.
L * LINAGE-COUNTER
A special register whose value points to
* language-name the current position within the page body.
A system-name that specifies a particular
programming language. LINKAGE SECTION
The section in the DATA DIVISION of an
last-used state activated unit (a called program or an
The state of storage in which internal invoked method) that describes data
values remain the same as when the items available from the activating unit (a
program or method was exited (are not program or a method). These data items
reset to their initial values on reentry). can be referred to by both the activated
* letter unit and the activating unit.
A character belonging to one of the literal
following two sets: A character-string whose value is
Glossary 643
national character data associated with the computer specified in
A general reference to data represented in the OBJECT-COMPUTER paragraph.
UTF-16.
* native collating sequence
national character position The implementor-defined collating
See character position. sequence associated with the computer
specified in the OBJECT-COMPUTER
national data
paragraph.
See national character data.
* negated combined condition
national data item
The 'NOT' logical operator immediately
A data item of class national. Class
followed by a parenthesized combined
national includes categories national,
condition.
national-edited, and numeric-edited with
USAGE NATIONAL. * negated simple condition
The 'NOT' logical operator immediately
national decimal data item
followed by a simple condition.
A data item described by a PICTURE
character-string that contains valid nested program
combinations of picture symbols 9, S, P, A program that is directly contained
and V. A national decimal data item is an within another program.
external decimal data item that has usage
* next executable sentence
NATIONAL.
The next sentence to which control will be
national-edited data item transferred after execution of the current
A data item described by a PICTURE statement is complete.
character-string that contains the symbol
* next executable statement
N and at least one of the simple insertion
The next statement to which control will
symbols B, 0, and /. A national-edited
be transferred after execution of the
data item has usage NATIONAL.
current statement is complete.
national floating-point data item
* next record
A data item described with usage
The record that logically follows the
NATIONAL and a picture character-string
current record of a file.
that describes a floating-point data item.
See floating-point. * noncontiguous items
Elementary data items in the
national group item
WORKING-STORAGE or LINKAGE
A group item that is explicitly or
SECTION that bear no hierarchic
implicitly described with a
relationship to other data items.
GROUP-USAGE clause with the
NATIONAL phrase. A national group is null A figurative constant that represents a
processed as though it were defined as an value used to indicate that a pointer data
elementary data item of category national item does not contain a valid address or
for operations such as INSPECT, STRING, that an object reference does not reference
and UNSTRING. This ensures correct an object. NULLS can be used wherever
padding and truncation of national NULL can be used.
characters, as opposed to defining data
* numeric character
items described with USAGE NATIONAL
A character that belongs to the following
within an alphanumeric group item. For
set of digits: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9.
operations that require processing of the
elementary items within a group, such as numeric data item
MOVE CORRESPONDING, ADD (1) A data item whose description restricts
CORRESPONDING, and INITIALIZE its content to a value represented by
identifier, a national group is processed characters chosen from the digits from '0'
using group semantics. through '9'; if signed, the item can also
contain a '+', '-', or other representation of
* native character set
an operational sign. (2) A data item of
The implementor-defined character set
class numeric and category numeric,
Glossary 645
WORKING-STORAGE SECTION OPEN statement, with the OUTPUT or
01 TABLE-1. EXTEND phrase specified, for that file
05 X PICS9.
and before the execution of a CLOSE
05 Y OCCURS 3 TIMES
DEPENDING ON X PIC X. statement without the REEL or UNIT
phrase for that file.
X is the object of the OCCURS * output procedure
DEPENDING ON clause (ODO object). A set of statements to which control is
The value of the ODO object determines | given during execution of a format 1
how many of the ODO subject appear in | SORT statement after the sort function is
the table. completed, or during execution of a
ODO subject MERGE statement after the merge
In the example above, Y is the subject of function reaches a point at which it can
the OCCURS DEPENDING ON clause select the next record in merged order
(ODO subject). The number of Y ODO when requested.
subjects that appear in the table depends overflow condition
on the value of X. A condition that occurs when a portion of
* open mode the result of an operation exceeds the
The state of a file after execution of an capacity of the intended unit of storage.
OPEN statement for that file and before overload
the execution of a CLOSE statement To define a method with the same name
without the REEL or UNIT phrase for that as another method available in the same
file. The particular open mode is specified class, but with a different signature. See
in the OPEN statement as either INPUT, also signature.
OUTPUT, I-O, or EXTEND.
override
operand To redefine (in a subclass) an instance
Data that is operated upon. In this method inherited from a parent class.
document, any lowercase word (or words)
that appears in a statement or entry P
format is an operand in that it is a
reference to the data identified by that package
word (or words). In Java, a group of related classes that can
be imported individually or as a whole.
* operational sign
An algebraic sign, associated with a packed decimal item
numeric data item or a numeric literal, to See internal decimal item.
indicate whether its value is positive or padding character
negative. An alphanumeric or national character or
optional file literal used to fill the unused character
A file that is declared as being not positions in a physical record.
necessarily available each time the object page A vertical division of output data
program is executed. representing a physical separation of such
* optional word data, the separation being based on
A reserved word that is included in a internal logical requirements or external
specific format only to improve the characteristics of the output medium.
readability of the language and whose * page body
presence is optional to the user when the That part of the logical page in which
format in which the word appears is used lines can be written or spaced.
in a source unit.
* paragraph
* output file In the PROCEDURE DIVISION, a
A file that is opened in either the paragraph-name followed by a separator
OUTPUT mode or EXTEND mode. period and by zero, one, or more
* output mode sentences. In the identification and
The state of a file after execution of an
Glossary 647
* punctuation character * record
A character that belongs to the following See logical record.
set:
* record area
Character Meaning A storage area allocated for the purpose
of processing the record described in a
, Comma
record description entry in the FILE
; Semicolon SECTION of the DATA DIVISION. In the
: Colon FILE SECTION, the current number of
character positions in the record area is
. Period (full stop)
determined by the explicit or implicit
" Quotation mark RECORD clause.
( Left parenthesis * record description
) Right parenthesis See record description entry.
Space * record description entry
= Equal sign The total set of data description entries
associated with a particular record. The
term is synonymous with record
Q description.
QSAM (Queued Sequential Access Method) record key
An extended version of the basic A key whose contents identify a record
sequential access method (BSAM). When within an indexed file.
this method is used, a queue is formed of * record-name
input data blocks that are awaiting A user-defined word that names a record
processing or of output data blocks that described in a record description entry in
have been processed and are awaiting the DATA DIVISION of a COBOL
transfer to auxiliary storage or to an program.
output device.
* record number
* qualified data-name The ordinal number of a record in the file
An identifier that is composed of a whose organization is sequential.
data-name followed by one or more sets
of either of the connectives OF and IN recording mode
followed by a data-name qualifier. The format of the logical records in a file.
Recording mode can be F (fixed-length), V
* qualifier (variable-length), S (spanned), or U
(1) A data-name or a name associated (undefined).
with a level indicator which is used in a
reference either together with another recursion
data-name which is the name of an item A program calling itself or being directly
that is subordinate to the qualifier or or indirectly called by a one of its called
together with a condition-name. (2) A programs.
section-name that is used in a reference recursively capable
together with a paragraph-name specified A program is recursively capable (can be
in that section. (3) A library-name that is called recursively) if the RECURSIVE
used in a reference together with a clause is on the PROGRAM-ID statement.
text-name associated with that library.
reel A discrete portion of a storage medium
R that contains part of a file, all of a file, or
any number of files. The term is
* random access synonymous with unit and volume.
An access mode in which the
program-specified value of a key data reentrant
item identifies the logical record that is The attribute of a program or routine that
obtained from, deleted from, or placed allows more than one user to share a
into a relative or indexed file. single copy of a program object.
Glossary 649
* routine-name * sentence
A user-defined word that identifies a A sequence of one or more statements, the
procedure written in a language other last of which is terminated by a separator
than COBOL. period.
* run time * separately compiled program
The time at which an object program is A program that, together with its
executed. The term is synonymous with contained programs, is compiled
object time. separately from all other programs.
runtime environment * separator
The environment in which a COBOL A character or two or more contiguous
program executes. characters used to delimit
character-strings.
* run unit
A stand-alone object program, or several * separator comma
object programs, that interact via COBOL A comma (,) followed by a space used to
CALL or INVOKE statements and delimit character-strings.
function at run time as an entity.
* separator period
A period (.) followed by a space used to
S
delimit character-strings.
SBCS (Single Byte Character Set)
* separator semicolon
See Single Byte Character Set (SBCS).
A semicolon (;) followed by a space used
scope terminator to delimit character-strings.
A COBOL reserved word that marks the
* sequential access
end of certain PROCEDURE DIVISION
An access mode in which logical records
statements. It can be either explicit
are obtained from or placed into a file in
(END-ADD, for example) or implicit (a
a consecutive predecessor-to-successor
separator period, for example).
logical record sequence determined by the
* section order of records in the file.
A set of zero, one or more paragraphs or
* sequential file
entities, called a section body, the first of
A file with sequential organization.
which is preceded by a section header.
Each section consists of the section header * sequential organization
and the related section body. The permanent logical file structure in
which a record is identified by a
* section header
predecessor-successor relationship
A combination of words followed by a
established when the record is placed into
separator period that indicates the
the file.
beginning of a section. For example,
WORKING-STORAGE SECTION. serial search
A search in which the members of a set
* section-name
are consecutively examined, beginning
A user-defined word that names a section
with the first member and ending with
in the PROCEDURE DIVISION.
the last.
segmentation
* 77-level-description-entry
A feature of Enterprise COBOL that is
A data description entry that describes a
based on the 85 COBOL Standard
noncontiguous data item with the
segmentation module. The segmentation
level-number 77.
feature uses priority-numbers in section
headers to assign sections to fixed * sign condition
segments or independent segments. The proposition, for which a truth value
Segment classification affects whether can be determined, that the algebraic
procedures contained in a segment receive value of a data item or an arithmetic
control in initial state or last-used state. expression is either less than, greater than,
or equal to zero.
Glossary 651
subclass switch-status condition
A class that inherits from another class. The proposition, for which a truth value
When two classes in an inheritance can be determined, that an UPSI switch,
relationship are considered together, the capable of being set to an 'on' or 'off'
subclass is the inheriting class; the status, has been set to a specific status.
superclass is the inherited class.
* symbolic-character
A subclass is also referred to as a child A user-defined word that specifies a
class or derived class. user-defined figurative constant.
* subject of entry syntax
An operand or reserved word that (1) The relationship among characters or
appears immediately following the level groups of characters, independent of their
indicator or the level-number in a DATA meanings or the manner of their
DIVISION entry. interpretation and use. (2) The structure
of expressions in a language. (3) The rules
* subprogram
governing the structure of a language. (4)
Any called program.
The relationship among symbols. (5) The
* subscript rules for the construction of a statement.
An occurrence number represented by
* system-name
either an integer, a data-name optionally
A COBOL word that is used to
followed by an integer with the operator
communicate with the operating
+ or -, or an index-name optionally
environment.
followed by an integer with the operator
+ or -, that identifies a particular element
T
in a table. A subscript can be the word
ALL when the subscripted identifier is * table
used as a function argument for a A set of logically consecutive items of
function allowing a variable number of data that are defined in the DATA
arguments. DIVISION by means of the OCCURS
clause.
* subscripted data-name
An identifier that is composed of a * table element
data-name followed by one or more A data item that belongs to the set of
subscripts enclosed in parentheses. repeated items comprising a table.
superclass text deck
A class that is inherited by another class. Synonym for object deck or object module.
When two classes in an inheritance
* text-name
relationship are considered together, the
A user-defined word that identifies library
subclass is the inheriting class; the
text.
superclass is the inherited class.
* text word
The superclass is also referred to as the
A character or a sequence of contiguous
parent class.
characters between margin A and margin
surrogate pair R in COBOL source code. A text word can
In the UTF-16 format of Unicode, a pair be:
of encoding units that together represents v A separator, except for: space; a
a single Unicode graphic character. The pseudo-text delimiter; and the opening
first unit of the pair is called a high and closing delimiters for alphanumeric
surrogate and the second a low surrogate. literals. The right parenthesis and left
The code value of a high surrogate is in parenthesis characters, regardless of
the range X'D800' through X'DBFF'. The context within the library, source unit,
code value of a low surrogate is in the or pseudo-text, are always considered
range X'DC00' through X'DFFF'. Surrogate text words.
pairs provide for more characters than the
v A literal including, in the case of
65,536 characters that fit in the Unicode
alphanumeric literals, the opening
16-bit coded character set.
U * variable-length record
A record associated with a file whose file
* unary operator description or sort-merge description
A plus (+) or a minus (-) sign that entry permits records to contain a varying
precedes a variable or a left parenthesis in number of character positions.
an arithmetic expression and that has the
effect of multiplying the expression by +1 * variable-occurrence data item
or -1, respectively. A variable-occurrence data item is a table
element which is repeated a variable
unbounded table number of times. Such an item must
A table with OCCURS integer-1 to contain an OCCURS DEPENDING ON
UNBOUNDED instead of specifying integer-2 clause in its data description entry, or be
as the upper bound. subordinate to such an item.
Unicode variably located group
A coded character set that encodes all the A group item following, and not
characters required for the written subordinate to, a variable-length table in
expression of any of the languages of the the same level-01 record. A variably
modern world. There are multiple formats located group can be an alphanumeric
for representing Unicode, including group or a national group.
UTF-8, UTF-16, and UTF-32. Enterprise
COBOL supports Unicode using UTF-16 variably located item
big-endian format as the representation A data item following, and not
for the national data type. subordinate to, a variable-length table in
the same level-01 record.
unit A module of direct access, the dimensions
of which are determined by IBM. volume
A module of external storage. For tape
universal object reference devices it is a reel; for direct-access
An object reference data item that can devices it is a unit.
contain a reference to an object of any
class. volume switch procedures
System procedures executed automatically
* unsuccessful execution when the end of a unit or reel has been
The attempted execution of a statement reached before end-of-file has been
reached.
Glossary 653
W XML document
A data object that is well formed as
white space characters
defined by the W3C XML specification.
Characters that introduce space into a
document. They are: XML namespace
v Space A mechanism, defined by the W3C XML
Namespace specifications, that limits the
v Horizontal tabulation
scope of a collection of element names
v Carriage return and attribute names. A uniquely chosen
v Line feed XML namespace ensures the unique
v Next line identity of an element name or attribute
name across multiple XML documents or
as named in the Unicode Standard. multiple contexts within an XML
* word document.
A character-string that forms a XML schema
user-defined word, a system-name, a A mechanism, defined by the W3C, for
reserved word, or a function-name. describing and constraining the structure
* WORKING-STORAGE SECTION and content of XML documents. An XML
The section of the DATA DIVISION that schema, which is itself expressed in XML,
describes WORKING-STORAGE data effectively defines a class of XML
items, composed either of noncontiguous documents of a given type, for example,
items or WORKING-STORAGE records, purchase orders.
or both.
Z
X zoned decimal data item
XML Extensible Markup Language. A A data item described by a PICTURE
metalanguage for defining markup character-string that contains valid
languages that was derived from and is a combinations of picture symbols 9, S, P,
subset of SGML. XML omits the more and V. A zoned decimal data item is an
complex and less-used parts of SGML and external decimal data item that has usage
makes it much easier to: DISPLAY. See external decimal data item
and national decimal data item.
v Write applications to handle document
types
| #
v Author and manage structured
information | 85 COBOL Standard
| The COBOL language defined by the
v Transmit and share structured
| ANSI and ISO standards identified in
information across diverse computing
| Appendix G, Industry specifications, on
systems
| page 617.
XML is being developed under the
| 2002 COBOL Standard
auspices of the World Wide Web
| The COBOL language defined by the
Consortium (W3C).
| following standards:
XML data | v INCITS/ISO/IEC 1989-2002,
Data that is organized into a hierarchical | Information Technology - Programming
structure with XML elements. The data | Languages - COBOL
definitions are defined in XML element
| v ISO/IEC 1989:2002, Information
type declarations.
| technology -- Programming languages
XML declaration | -- COBOL
XML text that specifies characteristics of
the XML document such as the version of
XML being used and the encoding of the
document.
Java
v IBM SDK for Java - Tools Documentation,
publib.boulder.ibm.com/infocenter/javasdk/
tools/index.jsp
v The Java 2 Enterprise Edition Developer's Guide,
download.oracle.com/javaee/1.2.1/devguide/
html/DevGuideTOC.html
v Java 2 SDK, Standard Edition Documentation,
download.oracle.com/javase/1.4.2/docs/
v Java 2 on z/OS, www.ibm.com/servers/eserver/
zseries/software/java/
v The Java EE 5 Tutorial, download.oracle.com/
javaee/5/tutorial/doc/
v The Java Language Specification, Third Edition, by
Gosling et al., java.sun.com/docs/books/jls/
v The Java Native Interface, download.oracle.com/
javase/1.5.0/docs/guide/jni/
XML
v Extensible Markup Language (XML),
www.w3.org/XML/
Index 659
continuation data description entry 187 data organization
area 53 BLANK WHEN ZERO clause 190 access modes and 141
lines 56, 58 data-name 189 indexed 138
CONTINUE statement 325 FILLER phrase 189 line-sequential 138
CONTROL statement (*CONTROL) 540 GLOBAL clause 191 relative 138
conversion of data, DISPLAY indentation and 163 sequential 138
statement 328 JUSTIFIED clause 191 DATA RECORDS clause
CONVERTING phrase 359 level-66 format (previously defined description 182
COPY libraries 68 items) 187 format 171
COPY statement level-88 format (condition- data relationships
comparison rules 546 names) 188 DATA DIVISION 161
description and format 542 level-number description 188 data transfer 300
example 549 OCCURS clause 193 data units
replacement rules 546 OCCURS DEPENDING ON (ODO) factory data 160
REPLACING phrase 545 clause 197 file data 159
SUPPRESS option 545 format 197 instance data 160
CORRESPONDING (CORR) phrase PICTURE clause 200 method data 160
ADD statement 306 REDEFINES clause 218 overview 159
description 306 RENAMES clause 221 program data 160
MOVE statement 376 SIGN clause 223 data-item-description-entry
SUBTRACT statement 450 SYNCHRONIZED clause 225 LINKAGE SECTION 159
with ON SIZE ERROR phrase 288 USAGE clause 230 data-name
COS function 502 USAGE IS NATIONAL clause data description entry 189
COUNT IN phrase and 191 definition 62
UNSTRING statement 455 VALUE clause 239 DATE 303
XML GENERATE statement 471 VOLATILE clause 244 DATE YYYYMMDD 303
CR (credit) data division DATE-COMPILED paragraph
insertion character 214 file description (FD) entry 176 description 107
symbol in PICTURE clause 203 levels of data 161 format 99
cs (currency symbol) LINKAGE SECTION 159 DATE-OF-INTEGER function 503
in PICTURE clause 201 LOCAL-STORAGE SECTION 158 DATE-TO-YYYYMMDD function 504
CURRENCY SIGN clause sort description (SD) entry 176 DATE-WRITTEN paragraph
description 120 WORKING-STORAGE SECTION 157 description 107
Euro currency sign 120 DATA DIVISION format 99
currency sign value 120 ASCII considerations 614 DAY 303
currency symbol 205 data description entry 187 DAY YYYYDDD 303
in PICTURE clause 203 data relationships 161 DAY-OF-INTEGER function 505
specifying in CURRENCY SIGN in factory definition 155 DAY-OF-WEEK 303
clause 120 in method definition 155 DAY-TO-YYYYDDD function 505
currency symbol, default ($) 214 in object definition 155 DB (debit)
CURRENT-DATE function 502 in program definition 155 insertion character 214
customer support 655 DATA DIVISION names 69 symbol in PICTURE clause 203
data flow DBCS (Double-Byte Character Set)
STRING statement 447 elementary move rules 379
D UNSTRING statement 456
data item
using in comments 108
DBCS category 166
data
characteristics 187 DBCS character set 3
alignment 168
description entry definition 157 DBCS characters
categories 164, 206
EXTERNAL clause 190 in COBOL words 10
classes 164
data item description entry 158 in literals 38
hierarchies used in qualification 161
data items DBCS class condition 261
organization 138
categories 165 DBCS comparisons 269
signed 170
classes 165 DBCS function arguments 493
truncation of 169, 192
data manipulation statements DBCS items
data category
ACCEPT 300 alignment rules 168
alphabetic 206
INITIALIZE 350 how to define 209
alphanumeric 208
list of 290 in ACCEPT 300
alphanumeric-edited 209
MOVE 376 PICTURE clause 209
DBCS 209
overlapping operands 290 DBCS literals 41
national 210
READ 402 in ACCEPT 300
national-edited 210
RELEASE 409 DBCS notation xv
numeric 207
RETURN 411 de-editing 380
numeric-edited 208
REWRITE 413 DEBUG-CONTENTS 18
data category descriptions 166
SET 423 DEBUG-ITEM special register 17, 596
data conversion, DISPLAY
STRING 444 DEBUG-LINE 18
statement 328
UNSTRING 452 DEBUG-NAME 18
data description entries
WRITE 460 debugging 595
ASCII considerations 615
Index 661
EXCEPTION/ERROR declarative FD (file description) entry (continued) fixed segments 256
(continued) format 171 fixed-length
DELETE statement 326 GLOBAL clause 177 records 177
description and format 562 level indicator 161 floating comment indicator (*>)
execution flow VALUE OF clause 182 comment lines 58
ALTER statement 307 figurative constant description 59
basic PERFORM statement 392 DISPLAY statement 328 inline comment 59
PERFORM statement 391 STOP statement 443 floating comment indicators 13
EXIT METHOD statement STRING statement 445 floating insertion editing 215
format and description 343 figurative constants 14 floating-point
EXIT PARAGRAPH statement ALL literal 15 DISPLAY statement 328
format and description 344 HIGH-VALUE 14 floating-point literals 41
EXIT PERFORM statement HIGH-VALUES 14 FOOTING phrase of LINAGE
format and description 343 LOW-VALUE 14 clause 182
EXIT PROGRAM statement LOW-VALUES 14 FOR REMOVAL phrase 319, 320
format and description 342 NULL 15 format notation, rules for xi
EXIT SECTION statement NULLS 15 FROM phrase
format and description 344 QUOTE 14 ACCEPT statement 300
EXIT statement QUOTES 14 REWRITE statement 413
format and description 341 SPACE 14 SUBTRACT statement 449
PERFORM statement 392 SPACES 14 with identifier 296
explicit attributes, of data 80 symbolic-character 15 WRITE statement 461
explicit scope terminators 284 ZERO 14 function arguments 492
exponentiation ZEROES 14 function definitions 496
exponential expression 258 ZEROS 14 function pointer
expression, arithmetic 257 file in SET statement 423
EXTEND phrase definition 159 function pointer data items 235
OPEN statement 387 file organization relation condition 273
extended character set 3 and access modes 141 function type 490
extension language elements 571 definition 141 function-identifier 79
EXTERNAL clause LINAGE clause 182 function-names 12
with data item 190 line-sequential 138 function-pointer data items
with file name 176 types of 138 SET statement 427
external decimal item file position indicator FUNCTION-POINTER phrase in USAGE
DISPLAY statement 328 description 297 clause 235
external floating-point READ statement 406 functions
DISPLAY statement 328 file section arguments 492
external floating-point category 167 RECORD clause 179 categories 165
external floating-point in ACCEPT 300 FILE SECTION 156, 176 class and category of 164
external floating-point items EXTERNAL clause 176 classes 165
alignment rules 168 FILE STATUS clause description 489
how to define 211 DELETE statement and 326 rules for usage 491
PICTURE clause 211 description 145 types of functions 490
external-class-name 12, 125 file status key 291
external-fileid 12 format 128
INVALID KEY phrase and 295
file status key
G
G symbol in PICTURE clause 202
F common processing facility 291
value and meaning 291
garbage collection 91
FACTORIAL function 508 GIVING phrase
FILE-CONTROL paragraph
factory data 91 ADD statement 305
ASSIGN clause 132
factory data division 155 arithmetic 287
description and format 128
format 156 DIVIDE statement 334
FILE STATUS clause 145
factory data unit 160 MERGE statement 374
ORGANIZATION clause 137
factory definition MULTIPLY statement 384
PADDING CHARACTER clause 139
FACTORY paragraph 106 SORT statement 436
RECORD KEY clause 142
format and description 93 SUBTRACT statement 451
RELATIVE KEY clause 144
factory identification division 99, 106 GLOBAL clause
RESERVE clause 137
factory method 91, 96 with data item 191
SELECT clause 132
FACTORY paragraph 106 with file name 177
file-description-entry 156
factory procedure division 249 glossary 629
file-name 62
factory procedure division header 251 GO TO statement 307
file-name, specifying on SELECT
factory WORKING-STORAGE 157 altered 347
clause 132
FALSE phrase 338 conditional 346
FILLER phrase 187
FD (file description) entry format and description 346
CORRESPONDING phrase 189
BLOCK CONTAINS clause 177 SEARCH statement 417, 421
data description entry 189
DATA RECORDS clause 182 unconditional 346
fixed insertion editing 214
description 176 GO TO, DEPENDING ON phrase 307
Index 663
intrinsic functions (continued) INVOKE statement (continued) level indicator
classes 165 NOT ON EXCEPTION phrase 367 (FD and SD) 55
COS 502 ON EXCEPTION phrase 367 definition 161
CURRENT-DATE 502 RETURNING phrase 366 level-number 58, 161, 187
DATE-OF-INTEGER 503 SELF special object identifier 364 (01 and 77) 55
DATE-TO-YYYYMMDD 504 SUPER special object identifier 364 66, renames 163
DAY-OF-INTEGER 505 USING phrase 365 77, elementary item 163
DAY-TO-YYYYDDD 505 ISCII considerations 613 88, conditional variable 163
DISPLAY-OF 506 ISCII standard 617 definition 161
FACTORIAL 508 ISO 646 613 description and format 188
floating-point literals 493 ISO COBOL standards 617 FILLER phrase 189
INTEGER 508 levels of data 161
integer functions 490 library-name 11, 62
INTEGER-OF-DATE 508
INTEGER-OF-DAY 509
J COPY statement 543
limits of the compiler 583
Java
INTEGER-PART 510 LINAGE clause 463
class-name 125
LENGTH 510 description 182
package 125
LOG 511 diagram of phrases 183
Java classes 91
LOG10 512 format 171
Java interoperability 91
LOWER-CASE 512 LINAGE-COUNTER special register
data types 365, 368, 370
MAX 513 description 20
literal types 365
MEAN 514 WRITE statement 463
Java interoperation 91
MEDIAN 514 LINE
Java Native Interface (JNI) 19, 91, 642
MIDRANGE 515 WRITE statement 462
Java objects 91
MIN 515 line advancing 462
Java String data 91
MOD 516 line-sequential file organization 138
java.lang.Object 91
national functions 490 LINES
JNI environment pointer 91
NATIONAL-OF 517 WRITE statement 462
JNIENVPTR special register 19, 91
numeric functions 490 LINES AT BOTTOM phrase 183
JUSTIFIED clause
NUMVAL 517 LINES AT TOP phrase 183
description and format 191
NUMVAL-C 519 linkage section
effect on initial settings 192
ORD 520 requirement for indexed items 196
STRING statement 445
ORD-MAX 521 VALUE clause 239
truncation of data 192
ORD-MIN 521 LINKAGE SECTION
USAGE IS INDEX clause and 191
PRESENT-VALUE 522 called subprogram 254
VALUE clause and 239
RANDOM 522 description 159
RANGE 523 literals
REM 524 and arithmetic expressions 257
REVERSE 524 K ASSIGN clause 132
SIN 525 Kanji 262 categories 165
SQRT 525 key of reference 138 classes 165
STANDARD-DEVIATION 526 KEY phrase CODE-SET clause and ALPHABET
SUM 526 OCCURS clause 195 clause 117
summary of 496 READ statement 403 CURRENCY SIGN clause 120
TAN 527 SEARCH statement 420 DBCS 41
ULENGTH 527 SORT statement 431, 433 description 36
UPOS 528 START statement 440 null-terminated alphanumeric 39
UPPER-CASE 528 keyboard navigation xix STOP statement 443
USUBSTR 529 VALUE clause 240
USUPPLEMENTARY 530 Z literals 39
UVALID 531
UWIDTH 533
L literals, class and category of 164
local-storage
LABEL RECORDS clause
VARIANCE 533 requirement for indexed items 196
format 171
WHEN-COMPILED 534 LOCAL-STORAGE 158
language-name 12
YEAR-TO-YYYY 535 defining with RECURSIVE
LEADING phrase
invalid key condition 295 clause 103
INSPECT statement 356, 357
INVALID KEY phrase LOG function 511
SIGN clause 224
DELETE statement 327 LOG10 function 512
LENGTH function 510
READ statement 404 logical operator
LENGTH OF special register 19
REWRITE statement 413 complex condition 275
INVOKE statement 365
START statement 441 in evaluation of combined
LESS THAN OR EQUAL TO symbol
WRITE statement 464 conditions 277
(<=) 264
INVOKE statement list of 275
LESS THAN symbol (<) 264
BY VALUE phrase 365 logical record
level
format and description 363 definition 159
01 item 161
LENGTH OF special register 365 file data 159
02-49 item 161
NEW phrase 364 program data 160
Index 665
numeric items (continued) OCCURS clause (continued) ORGANIZATION clause (continued)
alignment rules 168 restrictions 194 format 128
how to define 207 UNBOUNDED 197 INDEXED phrase 137
millennium dates 207 variable-length tables format 197 LINE SEQUENTIAL phrase 137
PICTURE clause 207 OCCURS DEPENDING ON (ODO) RELATIVE phrase 137
numeric literals 40 clause SEQUENTIAL phrase 137
numeric-edited category 168 complex 200 out-of-line PERFORM statement 392
numeric-edited item description 198 outermost programs, debugging 564
editing signs 171 object of 198 OUTPUT phrase 387
elementary move rules 379 RECORD clause 179 OUTPUT PROCEDURE phrase
numeric-edited items REDEFINES clause and 193 MERGE statement 374
alignment rules 168 SEARCH statement and 193 RETURN statement 411
how to define 208 subject and object of 198 SORT statement 437
PICTURE clause 208 subject of 193, 198 OVERFLOW phrase
NUMVAL function 517 subscripting 73 CALL statement 316
NUMVAL-C function 519 OFF phrase, SET statement 425 STRING statement 446, 456
OMITTED phrase 312, 313 overlapping operands invalid in
ON EXCEPTION phrase arithmetic statements 289
O CALL statement 315
INVOKE statement 367
data manipulation statements 290
overloading 106
object data division 155
XML GENERATE statement 475 overriding 107
format 156
XML PARSE statement 483
object definition
ON OVERFLOW phrase
OBJECT paragraph 106
object identification division 99, 106
CALL statement 316
STRING statement 446, 456
P
object instance data 160 P symbol in PICTURE clause 202, 204
ON phrase, SET statement 425
OBJECT paragraph 106 PACKED-DECIMAL phrase in USAGE
ON SIZE ERROR phrase
object procedure division 249 clause 233
ADD statement 306
object program 85 PADDING CHARACTER clause 139
arithmetic statements 287
object reference 91 PAGE
COMPUTE statement 324
in SET statement 423 WRITE statement 462
DIVIDE statement 334
OBJECT REFERENCE phrase 236 page eject 59
MULTIPLY statement 385
object WORKING-STORAGE 157 paragraph
SUBTRACT statement 451
OBJECT-COMPUTER paragraph 112 header, specification of 54
OPEN statement
ASCII considerations 613 termination, EXIT statement 341
for new/existing files 387
object-oriented class-name 63 paragraph-name 11, 62
format and description 386
object-oriented COBOL description 257
I-O phrase 387
class definition 91 specification of 54
phrases 386
comparison rules 273 paragraphs
programming notes 389
conformance rules description 51, 257
system dependencies 390
SET...USAGE OBJECT syntactical hierarchy 51
operands
REFERENCE 429 parent class 91
comparison of alphanumeric 268
effect of VALUE clause 157 parentheses
comparison of DBCS 269
factory definition 93 combined conditions, use 277
comparison of group 271
IDENTIFICATION DIVISION (class in arithmetic expressions 258
comparison of national 269
and method) 99 parsing XML documents
comparison of numeric 270
INHERITS clause 105 with validation
composite of 289
INVOKE statement 363 restrictions 482
overlapping 289, 290
method definition 95 partial listings 540
operation of XML GENERATE
method-name 62 PASSWORD clause
statement 476
object definition 93 description 145
operational sign
OBJECT REFERENCE phrase in system dependencies 145
algebraic, description of 170
USAGE clause 236 PERFORM statement
SIGN clause and 170
OO class name 63 branching 392
USAGE clause and 170
procedure division (classes and conditional 394
operational signs 170
methods) 249 END-PERFORM phrase 391
optional words, syntax notation xi
REPOSITORY paragraph 123 EVALUATE statement 337
ORD function 520
SELF and SUPER special object execution sequences 393
ORD-MAX function 521
identifiers 13 EXIT statement 341
ORD-MIN function 521
specifying configuration section 111 format and description 391
order of entries
subclasses and methods 105 in-line 392
clauses in FILE-CONTROL
objects in EVALUATE statement 338 out-of-line 392
paragraph 128
obsolete language elements xiv TIMES phrase 393
I-O-CONTROL paragraph 146
OCCURS clause VARYING phrase 395, 398
order of evaluation in combined
ASCENDING/DESCENDING KEY period (.)
conditions 277
phrase 195 actual decimal point 214
ORGANIZATION clause
description 193 PGMNAME compiler option
description 137
INDEXED BY phrase 196 CANCEL statement 317
Index 667
record (continued) relational operator restrictions
logical, definition of 159 in abbreviated combined relation CICS
physical, definition of 159 condition 278 parsing with validation using
record area meaning of each 265 FILE 482
MOVE statement 381 relation condition use 264 result field
RECORD clause relational operators 13 GIVING phrase 287
description and format 179 relative files NOT ON SIZE ERROR phrase 287
omission of 179 access modes allowed 142 ON SIZE ERROR phrase 287
RECORD CONTAINS 0 CLOSE statement 320 ROUNDED phrase 287
CHARACTERS 179 DELETE statement 327 RETURN statement
RECORD DELIMITER clause 140 FILE-CONTROL paragraph AT END phrase 412
record description entry 158, 187 format 128 description and format 411
levels of data 161 I-O-CONTROL paragraph overlapping operands, unpredictable
logical record 160 format 146 results 289
RECORD KEY clause organization 138 RETURN-CODE special register 21
description 142 permissible statements for 390 RETURNING NATIONAL phrase, in
format 128 READ statement 405 XML PARSE 481
record key in indexed file 327 RELATIVE KEY clause 142, 144 RETURNING phrase
record-description entry REWRITE statement 415 CALL statement 314
LINKAGE SECTION 159 START statement 442 INVOKE statement 366
record-description-entry 157 RELATIVE KEY clause PROCEDURE DIVISION header 254
record-name 62 description 144 reusing logical records 414
RECORDING MODE clause 184 format 128 REVERSE function 524
RECORDS phrase relative organization REWRITE statement
BLOCK CONTAINS clause 177 access modes allowed 142 description and format 413
RERUN clause 149 description 138 FROM identifier phrase 296
RECURSIVE clause 103 FILE-CONTROL paragraph INVALID KEY phrase 413
recursive methods 363 format 128 ROUNDED phrase
recursive programs 103 I-O-CONTROL paragraph ADD statement 306
requirement for indexed items 196 format 146 COMPUTE statement 323
REDEFINES clause RELEASE statement 289, 409 description 287
description 218 REM function 524 DIVIDE statement 334
examples of 220 REMAINDER phrase of DIVIDE MULTIPLY statement 384
format 218 statement 334 size error checking and 288
general considerations 219 RENAMES clause 163 SUBTRACT statement 451
OCCURS clause restriction 218 description and format 221 RSD file
undefined results 221 INITIALIZE statement 351 WRITE statement 462
VALUE clause and 218 level 66 item 163, 221 rules for condition-name entries 242
redefinition, implicit 176 PICTURE clause 201 rules for syntax notation xi
REEL phrase 319, 320 repeated words, syntax notation xii run unit
reference format 53 REPLACE statement description 85
reference-modification comparison operation 557 termination with CANCEL
description 76 continuation rules for pseudo-text and statement 318
MOVE statement evaluation 377 partial-word 557 runtime options
reference, methods of description and format 555 DEBUG 596
simple data 69 special notes 558 NODEBUG 596
relation character replacement editing 216
COPY statement 545 replacement rules for COPY
INITIALIZE statement 350
INSPECT statement 356
statement 546
REPLACING phrase
S
S symbol in PICTURE clause 202
relation conditions COPY statement 545
SAME clause 150
abbreviated combined 278 INITIALIZE statement 350, 351
SAME RECORD AREA clause
alphanumeric comparisons 265, 268 REPOSITORY paragraph 123, 125
description 150
comparison operations 265 required words, syntax notation xi
format 146
data pointer 271 RERUN clause
SAME SORT AREA clause
DBCS comparisons 265, 269 checkpoint processing 148
description 151
description 263 description 148
format 146
function-pointer operands 273 format 146
SAME SORT-MERGE AREA clause
general relation 264 RECORDS phrase 148
description 151
group comparisons 265 sort/merge 149
format 146
national comparisons 265 RESERVE clause
scope of names 61
numeric comparisons 265 description 137
scope terminator
object reference 273 format 128
explicit 284
operands of equal size 268 reserved words 12, 599
implicit 285
operands of unequal size 268 RESET TRACE statement 555
SD (sort file description) entry
procedure pointer operands 273 resolution of names 64
data division 176
DATA RECORDS clause 182
Index 669
special registers (continued) status key syntax notation, rules for xi
TALLY 24 common processing facility 291 system considerations, subprogram
WHEN-COMPILED 25 file processing 563 linkage
XML-CODE 25, 26 STOP RUN statement 443 CALL statement 309
XML-EVENT 26 STOP statement 443 CANCEL statement 317
XML-INFORMATION 31 storage system information transfer, ACCEPT
XML-NAMESPACE 26, 32 map listing 542 statement 302
XML-NAMESPACE-PREFIX 26, 34 MEMORY SIZE clause 113 system input device, ACCEPT
XML-NNAMESPACE 26, 33 REDEFINES clause 218 statement 300
XML-NNAMESPACE-PREFIX 26, 34 STRING statement system-names 12, 112
XML-NTEXT 26, 35 description and format 444 computer-name 112
XML-TEXT 26, 36 execution of 446 SOURCE-COMPUTER
SPECIAL-NAMES paragraph overlapping operands, unpredictable paragraph 112
ACCEPT statement 300 results 289
ALPHABET clause 117 structure of the COBOL language 3
ASCII considerations 613
ASCII-encoded file specification 185
structured programming
DO-WHILE and DO-UNTIL 394
T
table references
CLASS clause 120 subclass 91
indexing 73
CODE-SET clause and 185 subclasses and methods 105
subscripting 73
CURRENCY SIGN clause 120 subjects in EVALUATE statement 338
TALLY special register 24
DECIMAL-POINT IS COMMA subprogram linkage
TALLYING phrase
clause 122 CALL statement 309
INSPECT statement 356
description 114 CANCEL statement 317
UNSTRING statement 455
format 114 ENTRY statement 336
TAN function 527
mnemonic-name 117 subprogram termination
termination of execution
XML-SCHEMA clause 122 CANCEL statement 317
EXIT METHOD statement 343
SQRT function 525 EXIT PROGRAM statement 342
EXIT PARAGRAPH statement 344
STANDALONE-DECLARATION XML GOBACK statement 345
EXIT PERFORM statement 343
event 26 subscripting
EXIT PROGRAM statement 342
standard alignment definition and format 73
EXIT SECTION statement 344
JUSTIFIED clause 192 INDEXED BY phrase of OCCURS
GOBACK statement 345
standard alignment rules 168 clause 196
STOP RUN statement 443
STANDARD-1 MOVE statement evaluation 377
terminators, scope 284
RECORD DELIMITER clause 140 OCCURS clause specification 193
text words 544
STANDARD-1 phrase 118 table references 73
text-name 11, 63
STANDARD-2 phrase 118 using data-names 75
literal-1 543
STANDARD-DEVIATION function 526 using index-names (indexing) 73
THREAD compiler option 196
standards 617 using integers 75
requirement for indexed items 196
START statement substitution characters
THROUGH (THRU) phrase
description and format 440 DISPLAY-OF 507
ALPHABET clause 117
indexed file 441 NATIONAL-OF 517
CLASS clause 120
INVALID KEY phrase 295, 441 substitution field of INSPECT
EVALUATE statement 338
relative files 442 REPLACING 356
PERFORM statement 392
status key considerations 440 substrings, specifying
RENAMES clause 221
START-OF-CDATA-SECTION XML (reference-modification) 76
VALUE clause 241
event 26 SUBTRACT statement
TIME 303
START-OF-DOCUMENT XML event 26 common phrases 285
TIMES phrase of PERFORM
START-OF-ELEMENT XML event 26 description and format 449
statement 393
statement operations SUM function 526
TITLE statement 561
common phrases 285 SUPER special object identifier 13, 364
TO phrase, SET statement 423
file position indicator 297 superclass 91
TO TRUE phrase, SET statement 426
INTO and FROM phrases 296 support 655
transfer of control
statements SUPPRESS option, COPY 545
ALTER statement 307, 308
categories of 280 suppress output 540
basic PERFORM statement 392
conditional 282 SUPPRESS phrase
explicit 81
data manipulation 290 XML GENERATE statement 474
GO TO statement 346
definition 52 suppression editing 216
IF statement 349
delimited scope 284 switch-status condition 274
implicit 81
description 257 SYMBOLIC CHARACTERS clause 119
PERFORM statement 391
imperative 281 symbolic-character 11, 63
XML PARSE statement 480
input-output 290 symbolic-character figurative
transfer of data
procedure branching 299 constant 15
ACCEPT statement 300
syntactical hierarchy 51 symbols in PICTURE clause 201
MOVE statement 376
types of 52 SYNCHRONIZED clause 225
STRING statement 444
static data 91 effect on other language
UNSTRING statement 452
static method 91 elements 225
trimming of generated XML data 479
VALUE clause and 239
TRUNC compiler option 170
Index 671
XML event (continued) XML processing (continued)
PROCESSING-INSTRUCTION- XML-NAMESPACE-PREFIX special
DATA 26 register 26, 34, 480
PROCESSING-INSTRUCTION- XML-NNAMESPACE special
TARGET 26 register 26, 33, 480
STANDALONE-DECLARATION 26 XML-NNAMESPACE-PREFIX special
START-OF-CDATA-SECTION 26 register 26, 34, 480
START-OF-DOCUMENT 26 XML-NTEXT special register 26, 35,
START-OF-ELEMENT 26 480
UNKNOWN-REFERENCE-IN- XML-TEXT special register 26, 36,
ATTRIBUTE 26 480
UNKNOWN-REFERENCE-IN- XML schema file
CONTENT 26 environment variable 122
UNRESOLVED-REFERENCE 26 XML-CODE special register 25, 26
VERSION-INFORMATION 26 use in XML GENERATE 475
XML GENERATE statement use in XML PARSE 483
ATTRIBUTES phrase 472 XML-DECLARATION phrase 472
COUNT IN phrase 471 XML-EVENT special register 26, 485
description 469 XML-INFORMATION special register 31
element name formation 479 XML-NAMESPACE special register 26,
ENCODING phrase 472 32
END-XML phrase 476 XML-NAMESPACE special register, in
exception event 475 XML PARSE 485
format 469 XML-NAMESPACE-PREFIX special
format conversion 477 register 26, 34
NAME phrase 473 XML-NNAMESPACE special register 26,
NAMESPACE phrase 473 33
NAMESPACE-PREFIX phrase 473 XML-NNAMESPACE-PREFIX special
NOT ON EXCEPTION phrase 476 register 26, 34
ON EXCEPTION phrase 475 XML-NTEXT special register 26, 35, 486
operation 476 XML-SCHEMA clause 122
SUPPRESS phrase 474 specified in SPECIAL-NAMES
trimming 479 paragraph 122
TYPE phrase 474 xml-schema-name 63, 122
XML-DECLARATION phrase 472 description 122
XML PARSE statement specifying in SPECIAL-NAMES
control flow 485 paragraph 122
description 480 XML-SCHEMA clause 122
exception event 483 XML-TEXT special register 26, 36, 486
format 480 XML, definition 654
nested XML GENERATE 485
nested XML PARSE 485
ON EXCEPTION phrase 483
PROCESSING PROCEDURE
Y
YEAR-TO-YYYY function 535
phrase 482
XML parsing
with validation
restrictions 482 Z
XML processing Z
ENCODING phrase, in XML insertion character 216
GENERATE 472 null-terminated literals 39
ENCODING phrase, in XML symbol in PICTURE clause 203
PARSE 482 Z literals 39
PROCESSING PROCEDURE phrase, zero
in XML PARSE 482 filling, elementary moves 377
RETURNING NATIONAL phrase, in suppression and replacement
XML PARSE 481 editing 216
VALIDATING phrase, in XML ZERO figurative constant 14
PARSE 481 ZERO in sign condition 274
XML-CODE special register 25, 26, ZEROES figurative constant 14
480 ZEROS figurative constant 14
XML-EVENT special register 26, 480
XML-INFORMATION special
register 31
XML-NAMESPACE special
register 26, 32, 480
Printed in USA
SC14-7381-03