Pro*COBOL®

Getting Started

Releases 9.2 and 1.8.77 for Microsoft Windows (32-Bit)

A96113-04

February 2010

Pro*COBOL® Getting Started, Releases 9.2 and 1.8.77 for Microsoft Windows (32-Bit)

A96113-04

Copyright © 1996, 2010, Oracle and/or its affiliates. All rights reserved.

Primary Author:

Contributing Author:

Contributor:

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

If this software or related documentation is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:

U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007). Oracle USA, Inc., 500 Oracle Parkway, Redwood City, CA 94065.

This software is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications which may create a risk of personal injury. If you use this software in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure the safe use of this software. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software in dangerous applications.

Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

This software and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services.

Contents

List of Tables

Preface

- Intended Audience

- Documentation Accessibility

- Related Documents

- Conventions

What's New in Pro*COBOL?

- Oracle9i Release 2 (9.2) New Features in Pro*COBOL

- Oracle9i Release 1 (9.0.1) New Features in Pro*COBOL

1 Introducing Pro*COBOL

- What is Pro*COBOL?

- Release 1.8.77

- Supported Compilers

- Features

- Restrictions

- Directory Structure

- Header Files

- Library File

- Known Problems, Restrictions, and Workarounds

2 Building Pro*COBOL Applications

- Precompiling Pro*COBOL Applications

- The Pro*COBOL Commands

- Precompiler Options

- Viewing the Available Options

- Configuration Files

- Embedding PL/SQL

- Compiling and Linking Pro*COBOL Applications

- MERANT Micro Focus Compiler

- How to Use the IDE

- How to Use the Animator

- The COBOL and CBLLINK Commands

- The COBSQL Command

- Sample Programs

- Building the Demonstration Tables

- Building the Sample Programs

- makeit.bat

- Sample Files

3 Pro*COBOL for Windows

- Introduction to Pro*COBOL for Windows

- Release 1.8.77

- Supported Compilers

- Features

- Restrictions

- Directory Structure

- Header Files

- Library File

- Known Problems, Restrictions, and Workarounds

- Building Pro*COBOL Applications

- Precompiling Pro*COBOL Applications

- The Pro*COBOL Commands

- Precompiler Options

- Embedding PL/SQL

- Compiling and Linking Pro*COBOL Applications

- MERANT Micro Focus Compiler

- Sample Programs

- Building the Demonstration Tables

- Building the Sample Programs

- Sample Files

Index

List of Tables

- 1-1 Directories

- 1-2 Header Files

- 2-1 Pro*COBOL Sample Programs

- 3-1 Directories

- 3-2 Header Files

- 3-3 Pro*COBOL Sample Programs

Preface

This document describes the features of the Pro*COBOL precompiler that apply to the Windows NT, Windows 2000, Windows XP, and Windows Server 2003 operating systems.]

This Preface contains these topics:

- Intended Audience

- Documentation Accessibility

- Related Documents

- Conventions

Intended Audience

Pro*COBOL® Getting Started is intended for anyone who wants to use Pro*COBOL to perform the following tasks:

- Embed SQL statements in a COBOL program

- Build Oracle database applications with Pro*COBOL

To use this document, you need to:

- Know how to use a COBOL compiler in the Windows environment

- Be familiar with Windows commands such as deleting and copying files

- Understand the concepts of the search path, configuration files, and directory structure

- Be able to use a text editor to make changes to an ASCII text file

Documentation Accessibility

Our goal is to make Oracle products, services, and supporting documentation accessible to all users, including users that are disabled. To that end, our documentation includes features that make information available to users of assistive technology. This documentation is available in HTML format, and contains markup to facilitate access by the disabled community. Accessibility standards will continue to evolve over time, and Oracle is actively engaged with other market-leading technology vendors to address technical obstacles so that our documentation can be accessible to all of our customers. For more information, visit the Oracle Accessibility Program Web site at

http://www.oracle.com/accessibility/

Accessibility of Code Examples in Documentation

Screen readers may not always correctly read the code examples in this document. The conventions for writing code require that closing braces should appear on an otherwise empty line; however, some screen readers may not always read a line of text that consists solely of a bracket or brace.

Accessibility of Links to External Web Sites in Documentation

This documentation may contain links to Web sites of other companies or organizations that Oracle does not own or control. Oracle neither evaluates nor makes any representations regarding the accessibility of these Web sites.

TTY Access to Oracle Support Services

To reach Oracle Support Services, use a telecommunications relay service (TRS) to call Oracle Support at 1.800.223.1711.

Related Documents

For more information, see these Oracle resources:

- Oracle Database Installation Guide for Windows

- Oracle Database Release Notes for Windows

- Oracle Database Platform Guide for Windows

- Oracle Enterprise Manager Administrator's Guide

- Oracle Net Services Administrator's Guide

- Oracle Real Application Clusters Quick Start

- Oracle Database New Features

- Oracle Database Reference

- Oracle Database Error Messages

- Pro*COBOL Programmer's Guide

Many books in the documentation set use the sample schemas of the seed database, which is installed by default when you install Oracle. Refer to Oracle Database Sample Schemas for information on how these schemas were created and how you can use them yourself.

Conventions

The following text conventions are used in this document:

Convention

Meaning

boldface

Boldface type indicates graphical user interface elements associated with an action, or terms defined in text or the glossary.

italic

Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values.

monospace

Monospace type indicates commands within a paragraph, URLs, code in examples, text that appears on the screen, or text that you enter.

What's New in Pro*COBOL?

New features information from previous releases is also retained to help those users migrating to the current release.

The following sections describe the new features in Oracle Pro*COBOL:

- Oracle9i Release 2 (9.2) New Features in Pro*COBOL

- Oracle9i Release 1 (9.0.1) New Features in Pro*COBOL

Oracle9i Release 2 (9.2) New Features in Pro*COBOL

There is no new Windows-specific feature added in Pro*COBOL for this release.

Oracle9i Release 1 (9.0.1) New Features in Pro*COBOL

The Oracle9i Release 1 (9.0.1) feature described in this section highlights the support for Windows 2000.

This section contains these topics:

- Using Oracle9i on Windows 2000
Pro*COBOL is now supported on Windows 2000. There are some differences between using Oracle9i on Windows 2000 and Windows NT 4.0.

See Also:
Oracle Database Platform Guide for Windows

1 Introducing Pro*COBOL

This chapter describes the Oracle programmatic interface for the COBOL language running on Windows operating systems.

This chapter contains these topics:

- What is Pro*COBOL?

- Release 1.8.77

- Supported Compilers

- Features

- Restrictions

- Directory Structure

See Also:
Pro*COBOL Programmer's Guide for more information

What is Pro*COBOL?

To access an Oracle database, you use a high-level query language called Structured Query Language (SQL). You often use SQL through an interactive interface, such as SQL*Plus.

Pro*COBOL is a programming tool that enables you to embed SQL statements in a COBOL program. The Pro*COBOL precompiler converts the SQL statements in the COBOL program into standard Oracle run-time library calls. The generated output file can then be compiled, linked, and run in the usual manner.

Use the Pro*COBOL precompiler when rapid development and compatibility with other systems are your priorities.

Release 1.8.77

Oracle Corporation expects that any application written for Pro*COBOL release 1.8.x should precompile successfully with Pro*COBOL release 9.2.0. However, some vendor extensions may not be accepted and the application may not precompile successfully when migrating from release 1.8.x to release 9.2.0.

Note:
Pro*COBOL Precompiler for Windows release 1.8.77 is now automatically installed with the Programmer installation type of the Oracle9i Client top-level component. You do not need to use the Custom installation type of the Oracle9i Client top-level component.

If you simply want to migrate a release 1.8.x application to release 9.2.0 without using any of the new features of Pro*COBOL release 9.2.0, but the application does not precompile successfully, then report the problem to Oracle Support Services.

Note:
Oracle Corporation recommends that you use release 9.2.0 to develop new applications.

Supported Compilers

Pro*COBOL supports the MERANT Micro Focus NetExpress version 3.1 for 32-bit Windows NT, Windows 2000, and Windows 98.

Note:
Pro*COBOL does not support Object Oriented COBOL (OOCOBOL) specifications.

Features

Pro*COBOL supports the following:

- Oracle databases release 8.1.x and higher

- Embedded PL/SQL blocks

- Bundled database calls, which can provide better performance in client/server environments

- Full ANSI compliance for embedded SQL programming

- Calls to PL/SQL stored procedures

Restrictions

Pro*COBOL does not support the following:

- User exits

- Access to the Oracle Call Interface

- Oracle object types

- Graphical user interface

- 16-bit code generation

Directory Structure

When you install Pro*COBOL, Oracle Universal Installer creates a directory called \precomp in your ORACLE_BASE\ORACLE_HOME directory.

Note:
The \precomp directory can contain files for other products, such as Pro*C/C++.

The \precomp directory contains the directories listed in Table 1-1.

Table 1-1 Directories

Directory Name

Contents

\admin

Configuration files

\demo\procob2

Sample programs for Pro*COBOL® release 9.2.0

\demo\procob

Sample programs for Pro*COBOL® release 1.8.77

\demo\sql

SQL scripts for sample programs

\doc\procob2

Readme files for Pro*COBOL® 9.2.0

\doc\procob

Readme files for Pro*COBOL® 1.8.77

\lib

Library files

\mesg

Message files

\public

Header files

Header Files

The ORACLE_BASE\ORACLE_HOME\precomp\public directory contains the Pro*COBOL® header files listed in Table 1-2.

Table 1-2 Header Files

Header File

Description

oraca.cob

Contains the Oracle Communications Area (ORACA), which helps you to diagnose runtime errors and to monitor your program's use of various Oracle resources.

oraca5.cob

ORACA5 is the COMP-5 version of ORACA.

sqlca.cob

Contains the SQL Communications Area (SQLCA), which helps you to diagnose runtime errors. The SQLCA is updated after every executable SQL statement.

sqlca5.cob

SQLCA5 is the COMP-5 version of SQLCA.

sqlda.cob

Contains the SQL Descriptor Area (SQLDA), which is a data structure required for programs that use dynamic SQL Method 4.

sqlda5.cob

This is the COMP-5 version of SQLDA.

Library File

The ORACLE_BASE\ORACLE_HOME \precomp\lib directory contains the library file that you use when linking Pro*COBOL applications. The library file is called orasql9.lib.

Known Problems, Restrictions, and Workarounds

1. Although all Windows operating systems allow spaces in filenames and directory names, the Oracle Pro*C/C++ and Oracle Pro*COBOL precompilers will not precompile files that include spaces in the file name or directory name. For example, do not use the following formats:

- proc iname=test one.pc

- proc iname=d:\dir1\second dir\sample1.pc

2. Users running PROCOB application that are not linked using /LITLINK option and failing at runtime with the error,

Load error: file 'ORASQL8'

need to copy orasql9.dll to orasql8.dll in the same directory where orasql9.dll exists.

2 Building Pro*COBOL Applications

This chapter provides an overview of building Oracle database applications with Pro*COBOL Releases 9.2 and 1.8.77 for Windows operating systems.

This chapter contains these topics:

- Precompiling Pro*COBOL Applications

- Compiling and Linking Pro*COBOL Applications

- Sample Programs

Note:
Build and execute Pro*COBOL applications in a command prompt session with the default settings for the screen buffer size and the windows size. These settings ensure successful execution of the Pro*COBOL applications.

Precompiling Pro*COBOL Applications

This section describes the basics of precompiling a Pro*COBOL application.

See Also:
Pro*COBOL Programmer's Guide for more information about Pro*COBOL commands, precompiler options, and configuration files

The Pro*COBOL Commands

Use one of the following commands to precompile a file:

- For Pro*COBOL Release 9.2, use:

procob filename

- For Pro*COBOL Release 1.8.77, use:

procob18 filename

By default, if no extension is provided, Pro*COBOL tries to open filename.pco. If the ONAME option is not specified, Pro*COBOL generates a file named filename.cbl.

Precompiler Options

Many useful options are available at precompile time. Included are options that allow you to determine how:

- Resources are used

- Errors are reported

- Input and output are formatted

- Cursors are managed

Viewing the Available Options

To see a list of available options and their default values, enter the following at the command prompt:

C:\> procob

To see the option, defaults, and the restrictions (if any) on values, enter the following at the command prompt:

C:\> procob /?

Configuration Files

Pro*COBOL reads the configuration file for options before processing options supplied at the command line.

- For release 9.2.0, the configuration file is called pcbcfg.cfg. This file is located in the ORACLE_BASE\ORACLE_HOME \precomp\admin directory.

- For release 1.8.77, the configuration file is called pcccob.cfg. This file is located in the ORACLE_BASE\ORACLE_HOME\precomp\admin directory.

The configuration file has the following two options:

- COMP–5= yes | no

- include=ORACLE_BASE\ORACLE_HOME\precomp\public

COMP-5 Option

Check the following to determine whether you should change the value of COMP-5:

If you are using MERANT Micro Focus COBOL, COMP-5 can be set to yes (COMP-5=yes) or no (COMP-5=no).

- If COMP-5=yes:

- All COMP data items (if they are potential host variables) are converted to COMP–5.

- All data items generated by the precompiler will be declared as COMP–5.

- If COMP-5=no:

- The precompiler ignores COMP–5 host variables.

- Precompiled files generally do not run on Intel platforms.

For a workaround during the compilation stage, use the MERANT Micro Focus COBOL compiler directive:

MAKESYN "COMP–5" = "COMP"

This statement directs the compiler to treat COMP items as if they are COMP–5 items.

INCLUDE Option

The INCLUDE option enables the provided .cob files in the ORACLE_BASE\ORACLE_HOME\precomp\public directory to be included without an explicit INCLUDE= option at the command line.

Embedding PL/SQL

If you are using embedded PL/SQL blocks, do the following:

1. Enter the SQLCHECK option and the USERID string to connect at the precompiling command line.

2. Specify the SQLCHECK=FULL option to check the syntax or semantics of embedded SQL statements and PL/SQL blocks.

See Also:
Pro*COBOL Programmer's Guide for an example of a command line string or review the PL/SQL MAKE file

Compiling and Linking Pro*COBOL Applications

This section describes how to compile and link Pro*COBOL applications using the MERANT Micro Focus compiler.

MERANT Micro Focus Compiler

You can build and execute a MERANT Micro Focus COBOL application in two ways:

- How to Use the IDE (using NetExpress only)

- How to Use the Animator (products other than NetExpress)

- The COBOL and CBLLINK Commands (all products)

- The COBSQL Command

In each of these the COBSQL utility may be used with the following advantages:

- Pro*COBOL is run by the MERANT Micro Focus compiler and does not need to be run as a separate step.

- Animation is done using the .pco source file rather than the .cbl file produced by Pro*COBOL.

- The MAKEYSYN directive is provided automatically and need not be specified manually.

How to Use the IDE

A program generated by Pro*COBOL can be compiled and executed from within the MERANT Micro Focus NetExpress IDE. Simply add the .cbl file generated by Pro*COBOL to a Net Express project. To avoid potential inconsistencies when calling routines in the Oracle libraries the program should be compiled using the directive:

MAKESYN "COMP-5" = "COMP"

This directive can be specified in the build setting for the source file, the project settings or through a $SET line at the start of the source file. When you select Rebuild or Rebuild All the IDE generates an executable ready to Run or Animate.

How to Use the Animator

Programs can be compiled and executed from within the MERANT Micro Focus COBOL debugger, Animator V2.

To avoid potential inconsistencies when calling routines in the Oracle libraries, select the menu option Compiler Directives, and enter:

MAKESYN "COMP-5" = "COMP"

This step is required because MERANT Micro Focus COBOL stores binary numbers in Big Endian format. Oracle libraries expect binary numbers to be stored in Little Endian format (machine format).

The COBOL and CBLLINK Commands

COBOL and CBLLINK can be used to build programs in two ways, depending on whether the Pro*COBOL runtime is to be statically linked or accessed through a DLL at runtime.

For dynamic linking, the commands are:

COBOL sample1 /MAKESYN"COMP-5"="COMP";
CBLLINK sample1

For static linking, the commands are:

COBOL sample1 /LITLINK /MAKESYN"COMP-5"="COMP";
CBLLINK sample1 ORACLE_BASE\ORACLE_HOME\precomp\lib\orasql9.lib

The previous commands produce sample1.exe, which can be executed like any other Windows NT, Windows 2000, or Windows 98 program.

Note:
MERANT Micro Focus COBOL must be installed on the same system as Pro*COBOL to successfully execute the file.

The COBSQL Command

COBSQL can be used to simplify preprocessing and debugging. To use COBSQL, specify the following directive to the COBOL compiler:

PREPROCESS(COBSQL) COBSQLTYPE=ORACLE8 ENDP

or the short form:

P(COBSQL) CSQLT=ORA8 ENDP

COBSQLTYPE should be set to ORACLE or ORA for versions of Pro*COBOL prior to release 8.0. The directive may be set with a $SET line at the start of the source file, on the COBOL command line, in program build settings or project settings for NetExpress, or with SQL compiler directives settings for Animator. At compile time, COBSQL runs Pro*COBOL as a background task and passes its output to the COBOL compiler together with additional information required to enable Animator to track execution using the .pco file rather than .cbl file.

When using COBSQL there is no need to deal directly with the .cbl file. Instead, add the .pco file to a NetExpress project, or open it with Animator.

Sample Programs

Oracle provides sample programs to demonstrate the use of Pro*COBOL with Oracle database features. See "Sample Files" for a listing of these programs.

This section describes how to use the basic precompiling, compiling, and linking commands to build the sample programs. This section also describes the preparations required for running the Pro*COBOL sample programs.

Building the Demonstration Tables

To run the Pro*COBOL sample programs, you must have a database account with the username scott and the password tiger. If this account does not exist on your database, create one before running the sample programs.

The scott account must contain the emp and dept tables. If the account does not contain these tables, use the demobld.sql script to create them.

To run the demobld.sql script:

1. Start SQL*Plus.

2. Connect to the database as username scott with password tiger.

3. Run the demobld.sql script. For example:

SQL> @ORACLE_BASE\ORACLE_HOME\sqlplus\demo\demobld.sql

Building the Sample Programs

Pro*COBOL supplies the makeit.bat file which is listed in the next section, for building a MERANT Micro Focus COBOL sample file:

For release 9.2.0, the batch files are located in ORACLE_BASE\ORACLE_HOME \precomp\demo\procob2. For release 1.8.77, the files are located in ORACLE_BASE\ORACLE_HOME \precomp\demo\procob.

To build the sample programs:

1. Run the batch files with any sample file. Do not include the file extension. For example:

C:\ORACLE\ORA90\PRECOMP\DEMO\PROCOB2> makeit sample1

2. Ensure that all paths and file names reflect the configuration of your system, if you encounter errors when building a sample program.

The commands to run the sample programs assume that the following are the current working directories:

- ORACLE_BASE\ORACLE_HOME \precomp\demo\procob2 directory for release 9.2.0

- ORACLE_BASE\ORACLE_HOME\precomp\demo\procob directory for release 1.8.77

You may need to modify the sample link script to reflect the configuration of your system. See "Compiling and Linking Pro*COBOL Applications" for more information.

makeit.bat

The makeit.bat for release 9.2.0 contains the following:

procob iname=%1.pco ireclen=132
cobol %1 /anim /litlink makesyn "COMP-5" = "COMP";
cbllink %1 /M%1 ORACLE_BASE\ORACLE_HOME\precomp\lib\orasql9.lib

For release 1.8.77, this batch file contains the following:

procob18 iname=%1.pco ireclen=132
cobol %1 /anim /litlink makesyn "COMP-5" = "COMP";
cbllink %1 /M%1 ORACLE_BASE\ORACLE_HOME\precomp\lib\orasql9.lib

Sample Files

The Pro*COBOL sample files listed in Table 2-1, "Pro*COBOL Sample Programs" are located in the ORACLE_BASE\ORACLE_HOME\precomp\demo\procob2 (release 9.2.0) and/or ORACLE_BASE\ORACLE_HOME\precomp\demo\procob (release 1.8.77) directories. The SQL scripts are located in the ORACLE_BASE\ORACLE_HOME\precomp\demo\sql directory.

Table 2-1 Pro*COBOL Sample Programs

Sample Program

Description

sample1.pco

Simple query

sample2.pco

Cursor operations

sample3.pco

Host tables

sample4.pco

Datatype equivalence

sample6.pco

Dynamic SQL Method 1

sample7.pco

Dynamic SQL Method 2

sample8.pco

Dynamic SQL Method 3

sample9.pco

Stored procedure call

calldemo.sql

Stored procedure call

sample10.pco

Dynamic SQL Method 4

sample11.pco

Cursor variable operations

sample11.sql

Cursor variable operations

sample12.pco

Dynamic SQL Method 4 using ANSI dynamic SQL

sample13.pco

Nested program

sampleco.pco

Simple query and insert

sample14.pco

Host table x (release 8.1.6 and on)

lobdemo1.pco

LOB datatypes (release 8.1.6 and on)

lobdemo1.sql

LOB datatypes (release 8.1.6 and on)

3 Pro*COBOL for Windows

This chapter provides information for the Pro*COBOL precompiler specific to the Windows NT, Windows 98, and Windows 2000 operating systems.

This chapter describes only the features of Oracle9i for Microsoft Windows (32-Bit) software that apply to the Windows NT, Windows 2000, Windows XP, and Windows 98 operating systems. Information on Oracle9i Personal Edition software on Windows 98 is not covered in this chapter.

This chapter contains the following sections:

- Introduction to Pro*COBOL for Windows

- Building Pro*COBOL Applications

Introduction to Pro*COBOL for Windows

This section describes the Oracle programmatic interface for the COBOL language running on Windows operating systems.

This section contains these topics:

- Release 1.8.77

- Supported Compilers

- Features

- Restrictions

- Directory Structure

Release 1.8.77

Oracle Corporation expects that any application written for Pro*COBOL release 1.8.x should precompile successfully with Pro*COBOL release 9.2.0. However, some vendor extensions may not be accepted and the application may not precompile successfully when migrating from release 1.8.x to release 9.2.0.

Note:
Pro*COBOL Precompiler for Windows release 1.8.77 is now automatically installed with the Programmer installation type of the Oracle9i Client top-level component. You do not need to use the Custom installation type of the Oracle9i Client top-level component.

If you simply want to migrate a release 1.8.x application to release 9.2.0 without using any of the new features of Pro*COBOL release 9.2.0, but the application does not precompile successfully, then report the problem to Oracle Support Services.

Note:
Oracle Corporation recommends that you use release 9.2.0 to develop new applications.

Supported Compilers

Pro*COBOL supports the MERANT Micro Focus NetExpress version 3.1 for 32-bit Windows NT, Windows 2000, and Windows 98.

Note:
Pro*COBOL does not support Object Oriented COBOL (OOCOBOL) specifications.

Features

Pro*COBOL for Windows supports the following:

- Oracle databases release 8.1.x and higher

- Embedded PL/SQL blocks

- Bundled database calls, which can provide better performance in client/server environments

- Full ANSI compliance for embedded SQL programming

- Calls to PL/SQL stored procedures

Restrictions

Pro*COBOL for Windows does not support the following:

- User exits

- Access to the Oracle Call Interface

- Oracle object types

- Graphical user interface

- 16-bit code generation

Directory Structure

When you install Pro*COBOL, Oracle Universal Installer creates a directory called \precomp in your ORACLE_BASE\ORACLE_HOME directory.

Note:
The \precomp directory can contain files for other products, such as Pro*C/C++.

The \precomp directory contains the directories listed in Table 3-1.

Table 3-1 Directories

Directory Name

Contents

\admin

Configuration files

\demo\procob2

Sample programs for Pro*COBOL® release 9.2.0

\demo\procob

Sample programs for Pro*COBOL® release 1.8.77

\demo\sql

SQL scripts for sample programs

\doc\procob2

Readme files for Pro*COBOL® 9.2.0

\doc\procob

Readme files for Pro*COBOL® 1.8.77

\lib

Library files

\mesg

Message files

\public

Header files

Header Files

The ORACLE_BASE\ORACLE_HOME\precomp\public directory contains the Pro*COBOL® header files listed in Table 3-2.

Table 3-2 Header Files

Header File

Description

oraca.cob

Contains the Oracle Communications Area (ORACA), which helps you to diagnose runtime errors and to monitor your program's use of various Oracle resources.

oraca5.cob

ORACA5 is the COMP-5 version of ORACA.

sqlca.cob

Contains the SQL Communications Area (SQLCA), which helps you to diagnose runtime errors. The SQLCA is updated after every executable SQL statement.

sqlca5.cob

SQLCA5 is the COMP-5 version of SQLCA.

sqlda.cob

Contains the SQL Descriptor Area (SQLDA), which is a data structure required for programs that use dynamic SQL Method 4.

sqlda5.cob

This is the COMP-5 version of SQLDA.

Library File

The ORACLE_BASE\ORACLE_HOME \precomp\lib directory contains the library file that you use when linking Pro*COBOL applications. The library file is called orasql9.lib.

Known Problems, Restrictions, and Workarounds

1. Although all Windows operating systems allow spaces in filenames and directory names, the Oracle Pro*C/C++ and Oracle Pro*COBOL precompilers will not precompile files that include spaces in the file name or directory name. For example, do not use the following formats:

- proc iname=test one.pc

- proc iname=d:\dir1\second dir\sample1.pc

2. Users running PROCOB application that are not linked using /LITLINK option and failing at runtime with the error,

Load error: file 'ORASQL8'

need to copy orasql9.dll to orasql8.dll in the same directory where orasql9.dll exists.

Building Pro*COBOL Applications

This section provides an overview of building Oracle database applications with Pro*COBOL Releases 9.2 and 1.8.77 for Windows operating systems.

This section contains these topics:

- Precompiling Pro*COBOL Applications

- Compiling and Linking Pro*COBOL Applications

- Sample Programs

Note:
Build and execute Pro*COBOL applications in a command prompt session with the default settings for the screen buffer size and the windows size. These settings ensure successful execution of the Pro*COBOL applications.

Precompiling Pro*COBOL Applications

This section describes the basics of precompiling a Pro*COBOL application.

The Pro*COBOL Commands

Use one of the following commands to precompile a file:

- For Pro*COBOL Release 9.2, use:

procob filename

- For Pro*COBOL Release 1.8.77, use:

procob18 filename

By default, if no extension is provided, Pro*COBOL tries to open filename.pco. If the ONAME option is not specified, Pro*COBOL generates a file named filename.cbl.

Precompiler Options

Many useful options are available at precompile time. Included are options that allow you to determine how:

- Resources are used

- Errors are reported

- Input and output are formatted

- Cursors are managed

Viewing the Available Options

To see a list of available options and their default values, enter the following at the command prompt:

C:\> procob

To see the option, defaults, and the restrictions (if any) on values, enter the following at the command prompt:

C:\> procob /?

Configuration Files

Pro*COBOL reads the configuration file for options before processing options supplied at the command line.

- For release 9.2.0, the configuration file is called pcbcfg.cfg. This file is located in the ORACLE_BASE\ORACLE_HOME \precomp\admin directory.

- For release 1.8.77, the configuration file is called pcccob.cfg. This file is located in the ORACLE_BASE\ORACLE_HOME\precomp\admin directory.

The configuration file has the following two options:

- COMP–5= yes | no

- include=ORACLE_BASE\ORACLE_HOME\precomp\public

COMP-5 Option

Check the following to determine whether you should change the value of COMP-5:

If you are using MERANT Micro Focus COBOL, COMP-5 can be set to yes (COMP-5=yes) or no (COMP-5=no).

- If COMP-5=yes:

- All COMP data items (if they are potential host variables) are converted to COMP–5.

- All data items generated by the precompiler will be declared as COMP–5.

- If COMP-5=no:

- The precompiler ignores COMP–5 host variables.

- Precompiled files generally do not run on Intel platforms.

For a workaround during the compilation stage, use the MERANT Micro Focus COBOL compiler directive:

MAKESYN "COMP–5" = "COMP"

This statement directs the compiler to treat COMP items as if they are COMP–5 items.

INCLUDE Option

The INCLUDE option enables the provided .cob files in the ORACLE_BASE\ORACLE_HOME\precomp\public directory to be included without an explicit INCLUDE= option at the command line.

Embedding PL/SQL

If you are using embedded PL/SQL blocks, do the following:

1. Enter the SQLCHECK option and the USERID string to connect at the precompiling command line.

2. Specify the SQLCHECK=FULL option to check the syntax or semantics of embedded SQL statements and PL/SQL blocks.

See Also:
Pro*COBOL Programmer's Guide for an example of a command line string or review the PL/SQL MAKE file

Compiling and Linking Pro*COBOL Applications

This section describes how to compile and link Pro*COBOL applications using the MERANT Micro Focus compiler.

MERANT Micro Focus Compiler

You can build and execute a MERANT Micro Focus COBOL application in two ways:

- How to Use the IDE (using NetExpress only)

- How to Use the Animator (products other than NetExpress)

- The COBOL and CBLLINK Commands (all products)

- the COBSQL Command

In each of these the COBSQL utility may be used with the following advantages:

- Pro*COBOL is run by the MERANT Micro Focus compiler and does not need to be run as a separate step.

- Animation is done using the .pco source file rather than the .cbl file produced by Pro*COBOL.

- The MAKEYSYN directive is provided automatically and need not be specified manually.

How to Use the IDE

A program generated by Pro*COBOL can be compiled and executed from within the MERANT Micro Focus NetExpress IDE. Simply add the .cbl file generated by Pro*COBOL to a Net Express project. To avoid potential inconsistencies when calling routines in the Oracle libraries the program should be compiled using the directive:

MAKESYN "COMP-5" = "COMP"

This directive can be specified in the build setting for the source file, the project settings or through a $SET line at the start of the source file. When you select Rebuild or Rebuild All the IDE generates an executable ready to Run or Animate.

How to Use the Animator

Programs can be compiled and executed from within the MERANT Micro Focus COBOL debugger, Animator V2.

To avoid potential inconsistencies when calling routines in the Oracle libraries, select the menu option Compiler Directives, and enter:

MAKESYN "COMP-5" = "COMP"

This step is required because MERANT Micro Focus COBOL stores binary numbers in Big Endian format. Oracle libraries expect binary numbers to be stored in Little Endian format (machine format).

The COBOL and CBLLINK Commands

COBOL and CBLLINK can be used to build programs in two ways, depending on whether the Pro*COBOL runtime is to be statically linked or accessed through a DLL at runtime.

For dynamic linking, the commands are:

COBOL sample1 /MAKESYN"COMP-5"="COMP";
CBLLINK sample1

For static linking, the commands are:

COBOL sample1 /LITLINK /MAKESYN"COMP-5"="COMP";
CBLLINK sample1 ORACLE_BASE\ORACLE_HOME\precomp\lib\orasql9.lib

The previous commands produce sample1.exe, which can be executed like any other Windows NT, Windows 2000, or Windows 98 program.

Note:
MERANT Micro Focus COBOL must be installed on the same system as Pro*COBOL to successfully execute the file.

the COBSQL Command

COBSQL can be used to simplify preprocessing and debugging. To use COBSQL, specify the following directive to the COBOL compiler:

PREPROCESS(COBSQL) COBSQLTYPE=ORACLE8 ENDP

or the short form:

P(COBSQL) CSQLT=ORA8 ENDP

COBSQLTYPE should be set to ORACLE or ORA for versions of Pro*COBOL prior to release 8.0. The directive may be set with a $SET line at the start of the source file, on the COBOL command line, in program build settings or project settings for NetExpress, or with SQL compiler directives settings for Animator. At compile time, COBSQL runs Pro*COBOL as a background task and passes its output to the COBOL compiler together with additional information required to enable Animator to track execution using the .pco file rather than .cbl file.

When using COBSQL there is no need to deal directly with the .cbl file. Instead, add the .pco file to a NetExpress project, or open it with Animator.

Sample Programs

Oracle provides sample programs to demonstrate the use of Pro*COBOL with Oracle database features. See "Sample Files" for a listing of these programs.

This section describes how to use the basic precompiling, compiling, and linking commands to build the sample programs. This section also describes the preparations required for running the Pro*COBOL sample programs.

Building the Demonstration Tables

To run the Pro*COBOL sample programs, you must have a database account with the username scott and the password tiger. If this account does not exist on your database, create one before running the sample programs.

The scott account must contain the emp and dept tables. If the account does not contain these tables, use the demobld.sql script to create them.

To run the demobld.sql script:

1. Start SQL*Plus.

2. Connect to the database as username scott with password tiger.

3. Run the demobld.sql script. For example:

SQL> @ORACLE_BASE\ORACLE_HOME\sqlplus\demo\demobld.sql

Building the Sample Programs

Pro*COBOL supplies the makeit.bat file which is listed in the next section, for building a MERANT Micro Focus COBOL sample file:

For release 9.2.0, the batch files are located in ORACLE_BASE\ORACLE_HOME \precomp\demo\procob2. For release 1.8.77, the files are located in ORACLE_BASE\ORACLE_HOME \precomp\demo\procob.

To build the sample programs:

1. Run the batch files with any sample file. Do not include the file extension. For example:

C:\ORACLE\ORA90\PRECOMP\DEMO\PROCOB2> makeit sample1

2. Ensure that all paths and file names reflect the configuration of your system, if you encounter errors when building a sample program.

The commands to run the sample programs assume that the following are the current working directories:

- ORACLE_BASE\ORACLE_HOME \precomp\demo\procob2 directory for release 9.2.0

- ORACLE_BASE\ORACLE_HOME\precomp\demo\procob directory for release 1.8.77

You may need to modify the sample link script to reflect the configuration of your system. See "Compiling and Linking Pro*COBOL Applications" for more information.

The makeit.bat for release 9.2.0 contains the following:

procob iname=%1.pco ireclen=132
cobol %1 /anim /litlink makesyn "COMP-5" = "COMP";
cbllink %1 /M%1 ORACLE_BASE\ORACLE_HOME\precomp\lib\orasql9.lib

For release 1.8.77, this batch file contains the following:

procob18 iname=%1.pco ireclen=132
cobol %1 /anim /litlink makesyn "COMP-5" = "COMP";
cbllink %1 /M%1 ORACLE_BASE\ORACLE_HOME\precomp\lib\orasql9.lib

Sample Files

The Pro*COBOL sample files listed in Table 3-3 are located in the ORACLE_BASE\ORACLE_HOME\precomp\demo\procob2 (release 9.2.0) and/or ORACLE_BASE\ORACLE_HOME\precomp\demo\procob (release 1.8.77) directories. The SQL scripts are located in the ORACLE_BASE\ORACLE_HOME\precomp\demo\sql directory.

Table 3-3 Pro*COBOL Sample Programs

Sample Program

Description

sample1.pco

Simple query

sample2.pco

Cursor operations

sample3.pco

Host tables

sample4.pco

Datatype equivalence

sample6.pco

Dynamic SQL Method 1

sample7.pco

Dynamic SQL Method 2

sample8.pco

Dynamic SQL Method 3

sample9.pco

Stored procedure call

calldemo.sql

Stored procedure call

sample10.pco

Dynamic SQL Method 4

sample11.pco

Cursor variable operations

sample11.sql

Cursor variable operations

sample12.pco

Dynamic SQL Method 4 using ANSI dynamic SQL

sample13.pco

Nested program

sampleco.pco

Simple query and insert

sample14.pco

Host table x (release 8.1.6 and on)

lobdemo1.pco

LOB datatypes (release 8.1.6 and on)

lobdemo1.sql

LOB datatypes (release 8.1.6 and on)

Index
A  B  C  D  E  F  G  H  I  L  M  N  O  P  R  S  U

A

Animator, 2.2.1.2

ANSI compliance, 1.4, 3.1.3

ANSI dynamic SQL, 2.3.3, 3.2.3.3

B

batch files, for sample programs, 2.3.2, 3.2.3.2

C

CBLLINK command, 2.2.1.3

COBSQL, 2.2.1.4, 3.2.2.1

comp5, 2.1.2.2, 3.2.1.2

compiling, 2.2, 3.2.2

configuration files, 2.1.2.2

location, 2.1.2.2

D

default file extension, 2.1.1, 3.2.1.1

demobld.sql script, 2.3.1, 3.2.3.1

demonstration tables, building, 2.3.1, 3.2.3.1

DEPT table, 2.3.1, 3.2.3.1

directory structures, 1.6, 3.1.5

dynamic SQL (ANSI), 2.3.3, 3.2.3.3

E

embedded PL/SQL, 2.1.3, 3.2.1.3

EMP table, 2.3.1, 3.2.3.1

F

features

new, Preface

file extension, default, 2.1.1, 3.2.1.1

G

generic documentation references

comp5, 2.1.2.2, 3.2.1.2

compiling and linking, 2.2, 3.2.2

sample programs, 2.3, 3.2.3

user exits, not supported, 1.5, 3.1.4

H

header files, 1.6.1, 3.1.5.1

I

IDE, 2.2.1.1, 3.2.2.1

INCLUDE option, 2.1.2.2, 3.2.1.2

installation

Pro*COBOL release 1.8.x, 1.2, 3.1.1

L

library file, 1.6.2, 3.1.5.2

linking, 2.2, 3.2.2

M

makeit.bat, 2.3.2.1, 3.2.3.2

MERANT Micro Focus COBOL

Animator, 2.2.1.2

building sample programs, 2.3.2.1

COBSQL, 2.2.1.4, 3.2.2.1

comp5, 2.1.2.2, 3.2.1.2

compiling and linking, 2.2.1, 3.2.2.1

IDE, 2.2.1.1, 3.2.2.1

NetExpress, 2.2.1.1, 3.2.2.1

version supported, 1.3, 3.1.2

N

NetExpress, 2.2.1.1, 3.2.2.1

O

ONAME option, 2.1.1, 3.2.1.1

options, 2.1.2, 3.2.1.2

ORACA, 1.6.1, 3.1.5.1

orasql9.lib library file, 1.6.2, 3.1.5.2

P

pcbcfg.cfg, 2.1.2.2

pcccob.cfg, 2.1.2.2

PL/SQL, 2.1.3, 3.2.1.3

precompiling, 2.1, 3.2.1

commands, 2.1.1, 3.2.1.1

Pro*COBOL

building applications, 2, 3.2

compilers supported, 1.3, 3.1.2

compiling and linking, 2.2, 3.2.2

configuration files, 2.1.2.2

directory structures, 1.6, 3.1.5

features, 1.4, 3.1.3

options, 2.1.2, 3.2.1.2

overview, 1.1

release 1.8.x

described, 1.2, 3.1.1

installation, 1.2, 3.1.1

restrictions, 1.5, 3.1.4

R

release 1.8.x

described, 1.2, 3.1.1

installation, 1.2, 3.1.1

restrictions

Pro*COBOL, 1.5, 3.1.4

S

sample programs

batch files, 2.3.2, 3.2.3.2

building, 2.3, 3.2.3

file names, 2.3.3, 3.2.3.3

location of, 1.6, 1.6, 3.1.5, 3.1.5

SCOTT/TIGER account, 2.3.1, 2.3.1, 2.3.1, 3.2.3.1, 3.2.3.1, 3.2.3.1 SQL (Structured Query Language), 1.1 SQL*Plus, 1.1, 2.3.1, 3.2.3.1 SQLCA, 1.6.1, 3.1.5.1 SQLCHECK option, 2.1.3, 3.2.1.3 SQLDA, 1.6.1, 3.1.5.1 Structured Query Language (SQL), 1.1

U

user exits, not supported, 1.5, 3.1.4

Oracle Legal Notices

Copyright Notice

Copyright © 1994-2016, Oracle and/or its affiliates. All rights reserved.

License Restrictions Warranty/Consequential Damages Disclaimer

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

Warranty Disclaimer

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

Restricted Rights Notice

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.

Hazardous Applications Notice

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Trademark Notice

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

Third-Party Content, Products, and Services Disclaimer

This software or hardware and documentation may provide access to or information about content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.

Alpha and Beta Draft Documentation Notice

If this document is in preproduction status:

This documentation is in preproduction status and is intended for demonstration and preliminary use only. It may not be specific to the hardware on which you are using the software. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to this documentation and will not be responsible for any loss, costs, or damages incurred due to the use of this documentation.

Private Alpha and Beta Draft Documentation Notice

If this document is in private preproduction status:

The information contained in this document is for informational sharing purposes only and should be considered in your capacity as a customer advisory board member or pursuant to your beta trial agreement only. It is not a commitment to deliver any material, code, or functionality, and should not be relied upon in making purchasing decisions. The development, release, and timing of any features or functionality described in this document remains at the sole discretion of Oracle.

This document in any form, software or printed matter, contains proprietary information that is the exclusive property of Oracle. Your access to and use of this confidential material is subject to the terms and conditions of your Oracle Master Agreement, Oracle License and Services Agreement, Oracle PartnerNetwork Agreement, Oracle distribution agreement, or other license agreement which has been executed by you and Oracle and with which you agree to comply. This document and information contained herein may not be disclosed, copied, reproduced, or distributed to anyone outside Oracle without prior written consent of Oracle. This document is not part of your license agreement nor can it be incorporated into any contractual agreement with Oracle or its subsidiaries or affiliates.

Documentation Accessibility

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.

Access to Oracle Support

Oracle customers that have purchased support have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.