Programmer's Guide to Writing Programs

Index

! A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

ACCEPT and EBCDIC 7.9.1
ACCEPT FROM ENVIRONMENT-VALUE 3.4
Adis portability 6.6
adisctrl database and NLS 7.4
Advanced language features Ch3
ALIGN Compiler directive 1.1.3.2
ALIGN Compiler Directive 9.2.4
Alphanumeric data, efficiency of manipulation 1.1.2.2
Alt key portability 6.8.7
ALTER Compiler directive 1.1.3.1
ALTER statement 1.1.2.6 , 4.2.2
AND logic operator 1.1.2.5 , 3.5.1 , 16.3
Animator
and wide mode 10.3.6
maximum programs loaded 4.1.2
reinitializing terminal 10.3.6
ANSI, COMP usage 1.1.1
Application Configuration System Ch12
See also Configuration file
and Menu Handler 12.3.4
call interface 12.4
closing configuration file 12.4.2
error messages 12.4.2
parameters 12.4.1
processing method 12.4.2
Application subsystem routines 16.1.1
Applications, mixed language programs Ch9
ARGUMENT-NUMBER function-name 14.5
ARGUMENT-VALUE function-name 14.5
Arithmetic statement efficiency 1.1.2.1
ASCII
collating example 7.9.3
collating sequences 7.9.3
ASCII/EBCDIC
converting 7.9
converting using _CODESET 7.9.4
Attribute routines, set PC attribute table 16.3
Attributes
portability 6.8.2
setting for application 12.3.2.1
Attributes tag, configuration file 12.3.2.1

B

BASIS and Integrated Preprocessor 15.3.3
Bit manipulation programming 3.5
Boolean operators
Calling 3.5.1
using 3.5
BOUND Compiler directive 1.1.3.1
BOUNDOPT Compiler directive 1.1.2.3
BY REFERENCE phrase 9.1.1.2
BY VALUE phrase 9.1.1.2 , 9.2.2
Byte packing 16.1.2

C

C, interfacing with COBOL 10.3
C functions
cobcall 10.3.1
cobcancel 10.3.1
cobexit 10.3.2
cobfunc 10.3.1
cobgetfuncaddr 10.3.1
cobinit 10.3.2
coblongjmp 10.3.8
cobsetjmp() 10.3.8
cobthreadtidy 10.3.3
cobtidy 10.3.2 , 10.3.2
C screen handling
cobaddch 10.3.5
cobaddstr 10.3.5
cobaddstrc 10.3.5
cobclear 10.3.5
cobcols 10.3.5
cobgetch 10.3.5
cobgetenv 10.3.4
cobkeypad 10.3.6
coblines 10.3.5
cobmove 10.3.5
cobprintf 10.3.5
cobputenv 10.3.4
cobrescanenv 10.3.4
cobscroll 10.3.5
cobtermmode 10.3.6
SYSTEM 10.3.7
C signal handling
cobpostsighandler 10.3.9
cobremovesighandler 10.3.9
C-language header 11.1
CALL 2.1
efficiency 1.1.2.7
parameters 9.2.1
requirements 2.1.1
Call convention 9.2.1
efficiency 1.1.2.7
Call interface, compatibility 9.1.1
CALL prototype syntax 11.1
Calling, programs 2.5
Calling C functions 10.1
CANCEL 2.1
Cancelling non-COBOL programs 10.1.2
Case conversion
CBL_TOLOWER routine 16.3
CBL_TOUPPER routine 16.3
in National Language Support 7.7 , 7.7.5
Case sensitivity and portability 6.8.4
CBL_ALLOC_DYN_MEM 16.3
CBL_ALLOC_MEM 16.3
efficiency 1.1.2.8
CBL_ALLOC_SHMEM 16.3
CBL_AND 16.3
CBL_CLOSE_VFILE 16.3
CBL_CULL_RUN_UNITS 16.3
CBL_EQ 16.3
CBL_ERROR_PROC 16.3
CBL_EXEC_RUN_UNIT 16.3
CBL_EXIT_PROC 16.3
CBL_FREE_MEM 16.3
CBL_GET_OS_INFO 16.3
CBL_GET_PROGRAM_INFO 16.3
CBL_GET_SHMEM_PTR 16.3
CBL_IMP 16.3
CBL_NOT 16.3
CBL_OPEN_VFILE 16.3
CBL_OR 16.3
CBL_PUT_SHMEM_PTR 16.3
CBL_READ_VFILE 16.3
CBL_SCR_SET_PC_ATTRIBUTES 16.3
CBL_SUBSYSTEM 16.3
CBL_TOLOWER 16.3
CBL_TOUPPER 16.3
CBL_WRITE_VFILE 16.3
CBL_XOR 16.3
CBL_YIELD_RUN_UNIT 16.3
Character sets
converting 7.9.4
extended character set and portability 6.8.6
CHARSET Compiler directive 7.9.1
Child run-unit 13.2
CHIP Compiler directive 6.6
Class condition tests in National Language Support 7.7.2
Closedown procedure registration 16.3
cobaddch routine 10.3.5
cobaddstr routine 10.3.5
cobaddstrc routine 10.3.5
cobcall function 10.3.1
cobcancel function 10.3.1
cobchtype 10.3.5
cobclear routine 10.3.5
cobcols routine 10.3.5
cobexit function 10.3.2
cobfunc function 10.3.1
cobgetch routine 10.3.5
cobgetenv routine 10.3.4
cobgetfuncaddr function 10.3.1
cobinit function 10.3.2
cobkeypad routine 10.3.6
COBLANG environment variable 7.7
Coblines routine 10.3.5
coblongjmp function 10.3.8
COBLPFORM environment variable 14.5
cobmove routine 10.3.5
COBOL
call conventions 9.2.1
calling C functions 10.1
interfacing environment Ch9
interfacing with C 10.3
COBOL language, advanced features Ch3
COBOL protection violations 5.2.2
COBOL syntax
not implemented 4.2.1
used for interfacing 9.2
COBOL system
See System
COBOL type definition 11.1
cobpostsighandler routine 10.3.9
COBPRINTER environment variable 14.5
cobprintf routine 10.3.5
cobputenv routine 10.3.4
cobremovesighandler 10.3.9
cobrescanenv routine 10.3.4
cobscreen.h header file 10.3.5
cobscroll routine 10.3.5
cobsetjmp() function 10.3.8
COBTERMINFO environment variable, and wide mode 10.3.6
cobtermmode routine 10.3.6
cobthreadtidy function 10.3.3
cobtidy function 10.3.2 , 10.3.2
Codecomp utility 7.9.5
Codepage environment in National Language Support 7.5
_CODESET program, configuring 7.9.5
Collating sequence for ASCII and EBCDIC 7.9.3
Colorizing applications 12.3.2.1
Column, number in wide mode 10.3.6
COMMAND-LINE function-name 14.5
Communication
between programs 2.1
between run-units 13.2.1
COMP Compiler directive 1.1.3.1
COMP usage 1.1.1
COMP-3 1.1.1
COMP-5
efficiency 1.1.1
representation 9.2.3
speed 1.1.1
COMP-X
efficiency 1.1.1
representation 9.2.3 , 9.2.3
speed 1.1.1
Comparisons
EQUALS 1.1.2.4
GREATER 1.1.2.4
LESS 1.1.2.4
NOT EQUAL 1.1.2.4
Compiler directives
ALIGN 1.1.3.2
CHIP 6.6
efficiency 1.1.3
ENDP 15.2
FLAG-CHIP 6.6
INTLEVEL 6.1
MF 6.4.1
NLS 7.6
portability 6.7
PREPROCESS 15.2
RETRYLOCK 6.6
size optimization 1.1.3.2
speed optimization 1.1.3.1
XREF 15.1.1
Compiling, native object code Ch9
Concurrency support Ch13
Conditional statement efficiency 1.1.2.4
Conditions 1.1.2.4
Configuration file
attributes tag 12.3.2.1
color 12.3.2.1
comment indicators 12.3.3
comments 12.3.3
error messages 12.4.2
examples 12.3.4
location 12.2.1
mfcobolrc 12.2.2
mftools.cfg 12.2.1
structure 12.3
tag 12.3
tag indicators 12.3.1
tag names 12.3.2
Configuration System
See Application Configuration System
Configuring applications
See Application Configuration System
CONSOLE 14.5
COPY limits 4.1.1
Core heap size 4.2.8
Correcting protection violations 5.4
CORRESPONDING phrase 1.1.2.1
Coru 13.2
Create named values 16.3
Ctrl key portability 6.8.7
Currency sign and National Language Support 7.5 , 7.7
Currency sign and NLS 7.7.8

D

Data item maximum size 4.1.1
Data types
COMP-5 9.2.3
COMP-X 9.2.3
efficiency 1.1.1
storage representation 9.2.3
DBCS
support 7.3
transparency 7.3.1
Debugging, applications containing protection violations 5.5
Decimal point 1.1.2.1
DEFAULTCALLS Compiler directive 1.1.2.7
DISPLAY statement 7.9.1 , 7.9.2
DISPLAY UPON ENVIRONMENT-NAME 3.4
DISPLAY UPON ENVIRONMENT-VALUE 3.4
DISPLAY usage 1.1.1
Double-Byte Character Set support 7.3

E

EBCDIC
collating example 7.9.3
collating sequences 7.9.3
converting to ASCII 7.9
converting to ASCII using _CODESET 7.9.4
Editing NLS programs 7.7.7
Efficiency 1.1
Embedded directives and portability 6.8.10
ENDP Compiler directive 15.2
ENTRY 4.2.3
Entry point 2.3 , 4.2.3
Environment variables
COBLANG 7.7
LANG 7.7
setting 3.4
ENVIRONMENT-NAME function-name 3.4 , 14.5
ENVIRONMENT-VALUE function-name 3.4 , 14.5
EQ logic operator 3.5.1
Equivalence logic operator 16.3
Error messages
Application Configuration System 12.4.2
Integrated Preprocessor 15.3.2.2
Error procedure registration 16.3
Error procedure routines 16.1.4
ERRORLEVEL 9.2.5
Example, configuration file 12.3.4
eXclusive-OR logic operator 16.3
EXIT 2.1
Exit procedure registration 16.3
Exit procedure routines 16.1.4
External data efficiency 1.1.2.8
External File Mapper, environment variables 3.4

F

Files, portability 6.9.1
FLAG-CHIP Compiler directive 6.6
Flicker, with Animator 10.3.6
Floating-point
external data item 1.3.3
implementation (32-bit and 64-bit) 1.3
inaccuracies 1.3.4
literal 1.3.3
FORMFEED function-name 14.5
Free dynamically allocated memory 16.3

G

General protection violation 5.2.1
General protection violations 5.2.1
Generated code portability 6.3
GO TO statement, efficiency 1.1.2.6

H

H2cpy Ch11
command-line options 11.2.1
invoking 11.2
Handling large programs 1.4
Handling return codes 9.2.5
Header-to-COPY Ch11
Headers preprocessor 11.2.3
Heap routines
close heap 16.3
open heap 16.3
read heap 16.3
write heap 16.3

I

IF statement
collating considerations 7.9.3
efficiency 1.1.2.4
IMP logic operator 3.5.1 , 16.3
Inheritance 2.7
Initialization data 1.1.2.1
Instance, recursion 3.1.1
Integrated Preprocessor Ch15
interfacing with Compiler 15.3.1
invoking 15.2
parameters 15.3.1.1
response codes 15.3.2
stack 15.3.4
writing 15.3
Integration tools Ch12
Inter-program communication 2.1
CALL 2.1
Intercommunication between run-units 13.2.1
Interfacing Ch10
COBOL syntax 9.2
environment Ch9 , 9.2
Intermediate code
creating portable 6.4
vs native code 6.3
Internationalization Support Ch7
INTLEVEL Compiler directive 6.1
intrins.cbl sample program 3.3
Intrinsic functions
coding 3.3
in National Language Support 7.7.8
Invoking, H2cpy 11.2

J

No entries

K

No entries

L

LANG environment variable 7.7
Language and National Language Support 7.5 , 7.7.9
Language levels and Integrated Preprocessor 15.3.4
Large programs, handling 1.4
Library files and entry points 2.3
Library routines Ch16
application subsystem 16.1.1
CBL_ALLOC_DYN_MEM 16.3
CBL_ALLOC_MEM 16.3
CBL_ALLOC_SHMEM 16.3
CBL_CLOSE_VFILE 16.3
CBL_CULL_RUN_UNITS 16.3
CBL_ERROR_PROC 16.3
CBL_EXEC_RUN_UNIT 16.3
CBL_EXIT_PROC 16.3
CBL_FREE_MEM 16.3
CBL_GET_OS_INFO 16.3
CBL_GET_PROGRAM_INFO 16.3
CBL_GET_SHMEM_PTR 16.3 , 16.3
CBL_OPEN_VFILE 16.3
CBL_READ_VFILE 16.3
CBL_SCR_SET_PC_ATTRIBUTES 16.3
CBL_SUBSYSTEM 16.3
CBL_TOLOWER 16.3
CBL_TOUPPER 16.3
CBL_WRITE_VFILE 16.3
CBL_YIELD_RUN_UNIT 16.3
error procedure 16.1.4
exit procedure 16.1.4
logic operators 3.5
memory handling 13.3 , 16.1.3
multiple run-units 13.2 , 13.2.1
National Language Support 7.7.1 , 7.8
NLS 7.7.4
operating system information 16.1.6 , 16.1.8
portability 16.1.7
run-units 13.3 , 16.1.3
text 7.7.5 , 16.1.9
virtual heap 16.1.10
Library routines (call-by-name)
portability 6.4.1 , 6.6
Limits, COBOL system Ch4
Linkage Section 1.1.2.8
efficiency 1.1.2.8
Linking, as source of protection violations 5.4.7
LITVAL-SIZE Compiler directive 9.2.2
Local-Storage Section 3.1.1 , 3.1.1 , 4.2.5
Locale and National Language Support 7.5
Logic operators
AND 16.3
Calling 3.5.1
efficiency 1.1.2.5
EQuivalence 16.3
eXclusive-OR 16.3
IMPlies 16.3
library routines 3.5
NOT 16.3
OR 16.3
Lowercase, CBL_TOLOWER 16.3

M

Managing multiple run-units 13.2
Maximum
core heap size 4.2.8
data item size 4.1.1
EXTERNAL data item size 4.1.1
nesting 4.1.2
number of names 4.1.1
number size 4.2.7
OCCURS (screen section) 4.1.1
parameters in USING 4.1.1
program size 4.1.1 , 4.1.1
programs loaded 4.1.2
record size 4.1.1
table dimensions 4.1.1
Memory
CBL_ALLOC_DYN_MEM 16.3
CBL_ALLOC_MEM 16.3
CBL_ALLOC_SHMEM 16.3
CBL_FREE_MEM 16.3
free dynamically allocated 16.3
library routines 13.3 , 16.1.3
Menu Handler and Application Configuration System 12.3.4
MF Compiler directive 6.4.1
mfcobolrc configuration file 12.2.2
Mfconfig program
See Application Configuration System
mftools.cfg configuration file 12.2.1
Mixed-language programming Ch9 , Ch10
Multiple run-units
concurrency 13.1
dynamically allocated memory 13.2.1
intercommunication 13.2.1
management 13.2
named values 13.2.1

N

Named values
allocate memory 16.3 , 16.3 , 16.3
create/update 16.3
read 16.3
National Language Support
adisctrl database 7.4
case conversion 7.7 , 7.7.5
class condition tests 7.7.2
codepage environment 7.5
collating sequence 7.7.6
currency symbol 7.5 , 7.7 , 7.7.8
editing programs 7.7.7
indexed sequential file 7.7.3
intrinsic functions 7.7.8
language environment 7.5 , 7.7.9
library routines 7.7.1 , 7.7.4 , 7.8
locale 7.5
%NLS% 7.7.3
territory environment 7.5
using 7.4
NATIVE Compiler directive collating considerations 7.9.3
Native object code Ch9
NESTCALL Compiler directive 1.1.2.7 , 1.1.3.1
Nesting limits 4.1.2
NLS
See National Language Support
NLS Compiler directive 7.6
Non-COBOL programs, canceling 2.2.2
NOT logic operator 3.5.1 , 16.3
Numbers, maximum size 4.2.7
Numeric items and National Language Support 7.7
Numeric overflow checking 1.1.3.1

O

OCCURS, maximum in screen section 4.1.1
OCCURS DEPENDING ON clause, efficiency 1.1.2.3
ON SIZE ERROR phrase 1.1.2.1
optimization 1.1.2.1
Operating system
CBL_GET_OS_INFO 16.3
portability features 6.8.1
Operating system information routines 16.1.6 , 16.1.8
Optimizing
for small program 1.1.3.2
for speed at run time 1.1.3.1
OR logic operator 1.1.2.5 , 3.5.1 , 16.3
Ordering parameters 9.1.1.1
Originator run-unit 13.2

P

Pack byte 16.3
Packing bytes 16.1.2
Parameter, mismatch as source of protection violations 5.4.2
Parameters 9.2.1
alignment 9.2.4
efficiency 1.1.2.8
format 9.1.1.2
methods of passing 9.1.1.2
ordering 9.1.1.1
passed by value 9.2.2
passing by reference 9.1.1.2
passing by value 9.1.1.2
received by value 9.2.2
Parent run-unit 13.2
PERFORM
efficiency 1.1.2.6
nesting 4.2.6
Performance 1.1
Pointer
as source of protection violations 5.4.5
illegal 5.4.5
Portability
ACCEPT and DISPLAY 6.6
alt/ctrl keys 6.8.7
case sensitivity 6.8.4
COBOL syntax 6.5
Compiler directives 6.7
embedding directives 6.8.10
extended character sets 6.8.6
file 6.9.1
guidelines 6.8
issues Ch6
library routines (call-by-name) 6.6
operating system features 6.8.1
path specification 6.8.5
requirements 6.2
restrictions 6.6
RM COBOL 6.6
RM file status 6.6
ROLLBACK statement 6.8.11
screen I/O 6.8.3
$SET statement 6.8.10
source code 6.9
Undefined results 6.8.8
USAGE COMP-5 6.8.9
user attribute byte 6.8.2
Portability routines 16.1.7
Precompilers Ch15
PREPROCESS Compiler directive 15.2
Preprocessor
See Integrated Preprocessor
Printer channels 14.5
PRINTER function-name 14.5
Program
cancelling non-COBOL programs 10.1.2
codecomp 7.9.5
information 16.3
maximum size 4.1.1 , 4.1.1
mixed language Ch10
Program calling conventions 2.5
Program management in the run-time system 2.6
Program names
in the run-time system 2.5.1
resolving 2.5.1
PROGRAM-ID paragraph 2.7.1
Programming
mixed language Ch10
restrictions 1.4 , 4.2.2
Programs
maximum animated 4.1.2
maximum loaded 4.1.2
Protection violation Ch5
behavior 5.3
COBOL 5.2.2
correcting 5.4
correcting illegal pointer values 5.4.5
correcting illegal reference modification 5.4.4
correcting in non-COBOL code 5.4.1
correcting linker errors 5.4.7
correcting out-of-range subscripts 5.4.6
correcting parameter mismatches in CALLs 5.4.2
correcting stack overflow 5.4.3
debugging techniques 5.5
described 5.2
effects 5.3
error handling 5.3
general 5.2.1
Public symbols, PROGRAM-ID 2.1.1.1

Q

No entries

R

Read named value 16.3
Record, maximum size 4.1.1
Recursion 3.1
entry point 3.1.1
instance 3.1.1
writing routines 3.1.1
Recursive routines, writing 3.1.1
REF Compiler directive 1.1.1
Reference modification
as source of protection violations 5.4.4
versus STRING statement 3.2
REMAINDER phrase 1.1.2.1
REPLACE verb and Integrated Preprocessor 15.3.3
Representation of data types 9.2.3
Requirements, CALL 2.1.1
Restrictions, programming 4.2
RETRYLOCK Compiler directive 6.6
Return code 9.2.5
RETURN-CODE 9.2.1 , 9.2.1 , 9.2.5
efficiency 1.1.2.7
RETURNING phrase 9.2.1 , 9.2.5
RM file status portability 6.6
ROLLBACK statement portability 6.8.11
ROUNDED phrase 1.1.2.1 , 1.1.2.1
Routines
See Library routines
RTNCODE-SIZE Compiler directive 9.2.5
Run-time, errors 2.2.2.1
Run-time system, program management in the run-time system 2.6
Run-unit
child 13.2
coru 13.2
library routines 13.3 , 16.1.3
management 13.2
originator 13.2
parent 13.2
Run-unit routines
allocate dynamic memory 16.3 , 16.3 , 16.3
clear 16.3
create run-unit 16.3
create/update named value 16.3
free dynamic memory 16.3
read named value 16.3
yield time-slice 16.3
Run-units
See multiple run-units
intercommunication 13.2.1

S

Sample programs, intrins.cbl 3.3
Screen handling portability 6.8.3
Searching, multiple directories 2.7.1
Segmentation 1.4
Segmented program 4.2.2
SET ADDRESS statement 9.2.3
$SET statement portability 6.8.10
Setting environment variables using Mfextmap 3.4
Sort, efficiency 1.1.2.9
SORT statement collating considerations 7.9.3
Source code portability 6.9
Stack, ordering parameters on 9.1.1.1
Stack overflow, as source of protection violations 5.4.3
Storage representation of data types 9.2.3
Stride 1.1.1 , 1.1.2.3
String
CBL_TOLOWER 16.3
CBL_TOUPPER 16.3
STRING statement, versus reference modification 3.2
Subscript
as source of protection violations 5.4.6
maximum number 4.1.1
Subsystem routines, declare/deallocate 16.3
System
attributes 12.3.2.1.1
limits Ch4
specifications 4.1
SYSTEM routine 10.3.7

T

TAB function-name 14.5
Table handling efficiency 1.1.2.3
TERM environment variable 10.3.6
Terminal
mode changes 10.3.6
reinitialization for Animator 10.3.6
Territory environment and National Language Support 7.5
Text routines 16.1.9
convert to lower case 16.3
convert to upper case 16.3
tools.lbr 12.4
Trickle 1.1.2.6
TRUNC Compiler directive 1.1.1 , 1.1.3.1

U

Undefined results, portability 6.8.8
Unpack byte 16.3
Update named values 16.3
Upper case, convert a string to 16.3
USAGE COMP-5, portability 6.8.9
USE GLOBAL AFTER, maximum number in program 4.1.1
User attribute byte portability 6.8.2
USING, maximum number of parameters 4.1.1
USING phrase 2.1
Utility, Codecomp 7.9.5