About this book

The Mainframe Connect Server Option Programmer’s Reference for PL/1 contains reference information for the PL/1 version of Open ServerConnect™ Gateway-Library™.

The Open ServerConnect Gateway-Library is a subset of the generic Sybase® Gateway-Library.

This chapter includes the following topics:

Audience

The Mainframe Connect Server Option Programmer’s Reference for PL/1 is a reference book for application programmers who write PL/1 programs that call Open ServerConnect Gateway-Library functions, as well as for system programmers who want to use its tracing and accounting features.

This book assumes that you are familiar with the PL/1 programming language and know how to write PL/1 programs under either CICS, MVS or IMS TM. It does not contain instructions for writing PL/1 programs. Rather, it describes the functions that can be called within your PL/1 programs to perform communication, conversion, tracing, and accounting functions.

Product name changes

The following table describes new names for products in the 12.6 release of the Mainframe Connect Integrated Product Set.

Old product name	New product name
Open ClientConnect for CICS	Mainframe Connect Client Option for CICS
Open Client Connect for IMS and MVS	Mainframe Connect Client Option for IMS and MVS
Open ServerConnect for CICS	Mainframe Connect Server Option for CICS
Open ServerConnect for IMS and MVS	Mainframe Connect Server Option for IMS and MVS
MainframeConnect for DB2 UDB	Mainframe Connect DB2 UDB Option for CICS
DirectConnect for OS/390	DirectConnect for z/OS

The old product names are used throughout this book, except on the title page.

This book also uses the terms MVS and OS/390 where the newer term z/OS would otherwise be used.

How to use this book

Table 1 shows how this book is organized.

**Table 1: Chapter descriptions**
Chapter	Contents
Chapter 1, “Introduction”	An overview of Open ServerConnect including discussion of different kinds of client requests and explanations of how Open ServerConnect programs process them. Everyone who writes programs using Open ServerConnect should read this chapter.
Chapter 2, “Topics”	Descriptions of Gateway-Library concepts, and information on how to accomplish specific programming tasks. This chapter discusses tasks, resources, and other topics that the application programmer needs to understand to write Gateway-Library applications. It includes a detailed discussion of the Gateway-Library cursor, dynamic SQL and Japanese language support, and a list of supported datatypes and models for structures used to store data.
Chapter 3, “Functions”	Reference pages for each Gateway-Library function. Each function description contains sections on functionality, syntax, explanatory comments and related functions, as well as an example.
Appendix A, “Gateway-Library Quick Reference”	A table of all Gateway-Library functions, their arguments and where they exist, and the symbolic constants used with each argument.
Appendix B, “Sample RPC Application for CICS”	A sample PL/1 application program that processes client RPC requests under CICS.
Appendix C, “Sample Language Application for CICS”	A sample PL/1 application program that processes client language requests under CICS.
Appendix D, “Sample RPC Application for IMS TM (Explicit)”	A sample PL/1 application program that processes client RPC requests under the IMS TM implicit API.
Appendix E, “Sample RPC Application for IMS TM (Implicit)”	A sample PL/1 application program that processes client RPC requests under the IMS TM explicit API.
Appendix F, “Sample Mixed-Mode Application”	A sample PL/1 application program that includes both Gateway-Library and Client-Library™ function calls (a mixed-mode application).
Appendix G, “Sample Tracing and Accounting Program”	A sample PL/1 program that demonstrates the use of all Gateway-Library tracing and accounting functions.

Other sources of information

Use the Sybase Getting Started CD, the Sybase Technical Library CD, and the Technical Library Product Manuals Web site to learn more about your product:

The Getting Started CD contains release bulletins and installation guides in PDF format, and may also contain other documents or updated information not included on the Technical Library CD. It is included with your software. To read or print documents on the Getting Started CD, you need Adobe Acrobat Reader (downloadable at no charge from the Adobe Web site, using a link provided on the CD).
The Technical Library CD contains product manuals and is included with your software. The DynaText reader (included on the Technical Library CD) allows you to access technical information about your product in an easy-to-use format.

Refer to the Technical Library Installation Guide in your documentation package for instructions on installing and starting the Technical Library.
The Technical Library Product Manuals Web site is an HTML version of the Technical Library CD that you can access using a standard Web browser. In addition to product manuals, you will find links to EBFs/Maintenance, Technical Documents, Case Management, Solved Cases, newsgroups, and the Sybase Developer Network.

To access the Technical Library Product Manuals Web site, go to Product Manuals.

Sybase certifications on the Web

Technical documentation at the Sybase Web site is updated frequently.

Finding the latest information on product certifications

Point your Web browser to Technical Documents.
Select Products from the navigation bar on the left.
Select a product name from the product list and click Go.
Select the Certification Report filter, specify a time frame, and click Go.
Click a Certification Report title to display the report.

Creating a personalized view of the Sybase Web site (including support pages)

Set up a MySybase profile. MySybase is a free service that allows you to create a personalized view of Sybase Web pages.

Point your Web browser to Technical Documents.
Click MySybase and create a MySybase profile.

Sybase EBFs and software maintenance

Finding the latest information on EBFs and software maintenance

Point your Web browser to the Sybase Support Page.
Select EBFs/Maintenance. Enter user name and password information, if prompted (for existing Web accounts) or create a new account (a free service).
Select a product.
Specify a time frame and click Go.
Click the Info icon to display the EBF/Maintenance report, or click the product description to download the software.

Conventions

This section describes the syntax and style conventions used in this book.

Throughout this book, all references to MVS refer to native MVS programs, and all references to Adaptive Server® Enterprise also apply to its predecessor, SQL Server®.

Open ServerConnect uses eight-character function names; other versions of Server-Library use longer names. This book uses the long version of Server-Library names with this exception: the eight-character version is used in syntax statements. For example, CTBCMDPROPS has 11 letters. In the syntax statement, it is written:

CTBCMDPR

You can use either version in your code.

Table 2 describes the syntax conventions used in this book.

**Table 2: Syntax conventions**
Symbol	Explanation
( )	Parentheses indicate that parentheses are included as part of the command.
{ }	Braces indicate that you must choose at least one of the enclosed options. Do not type the braces when you type the option.
[ ]	Brackets indicate that you can choose one or more of the enclosed options, or none. Do not type the brackets when you type the options.
\|	The vertical bar indicates that you can select only one of the options shown. Do not type the bar in your command.
,	The comma indicates that you can choose one or more of the options shown. Separate each choice by using a comma as part of the command.

Table 3 describes the style conventions used in this book.

**Table 3: Style conventions**
This type of information	Looks like this
Gateway-Library function names	TDINIT, TDRESULT
Client-Library function names	CTBINIT, CTBRESULTS
Other executables (DB-Library routines, SQL commands) in text	the dbrpcparam routine, a select statement
Directory names, path names, and file names	/usr/bin directory, interfaces file
Variables	n bytes
Adaptive Server datatypes	datetime, float
Sample code	01 BUFFER PIC S9(9) COMP SYNC. 01 BUFFER PIC X(n).
User input	01 BUFFER PIC X(n)
Client-Library and Gateway-Library function argument names	BUFFER, RETCODE
Client-Library function arguments that are input (I) or output (O)	COMMAND – (I) RETCODE – (O)
Names of objects stored on the mainframe	SYCTSAA5
Symbolic values used with function arguments, properties, and structure fields	CS_UNUSED
Client-Library property names	CS_PASSWORD
Client-Library and Gateway-Library datatypes	CS_CHAR, TDSCHAR

All other names and terms are in regular typeface.

If you need help

Each Sybase installation that has purchased a support contract has one or more designated people who are authorized to contact Sybase Technical Support. If you cannot resolve a problem using the manuals or online help, please have the designated person contact Sybase Technical Support or the Sybase subsidiary in your area.

View this book as PDF