The Mainframe Connect Client Option Programmer’s Reference for C contains reference information for the C version of Open ClientConnect™ Client-Library.
The Open ClientConnect Client-Library™ is a subset of the
generic Sybase® Client-Library.
This chapter includes the following topics:
The Mainframe Connect Client Option Programmer’s Reference for C is a reference manual for mainframe programmers who write client applications in the C programming language using Open ClientConnect Client-Library.
This manual assumes that the programmer is familiar with the C programming language and knows how to write programs under either CICS or IMS TM. This book does not contain instructions for writing C programs. Rather, it describes the functions that can be called within your C programs to enable them to communicate with remote servers.
The following table describes new names for products in the 12.6 release of the Mainframe Connect Integrated Product Set.
Old product names |
New product name |
|---|---|
|
Mainframe Connect Client Option for CICS |
|
Mainframe Connect Client Option for IMS and MVS |
|
Mainframe Connect Server Option for CICS |
|
Mainframe Connect Server Option for IMS and MVS |
|
Mainframe Connect DB2 UDB Option for CICS |
|
DirectConnect for z/OS |
The old product names are used throughout this book, except for on the title page.
This book also uses the terms MVS and OS/390
where the newer term z/OS would otherwise be used.
Table 1 shows where to find the information you need in this book.
Chapter |
Contents |
|---|---|
An overview of Open ClientConnect including discussion of different kinds of client requests and explanations of how Open ClientConnect programs process them.
|
|
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. |
|
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. |
|
A sample C application program that processes client language requests under CICS. |
|
A sample C application program that processes client RPC requests under CICS. |
|
A list and description of all relevant Sybase product documentation. |
For a complete list and description of all related documents, see Appendix C, “Sybase Product Documentation.”
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.
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.
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.
This section describes the syntax and style conventions used in this book.
Throughout this book, all references to Adaptive Server™ Enterprise also
apply to its predecessor, SQL Server®. Also, Adaptive Server
Enterprise (ASE) and Adaptive Server (AS) are used interchangeably.
Open ClientConnect uses eight-character function names, while other versions of Client-Library use longer names. This book uses the long version of Client-Library names with one exception: the eight-character version is used in syntax statements. For example, CTBCMDPROPS has eleven letters. In the syntax statement, it is written CTBCMDPR, using eight characters. You can use either version in your code.
Table 2 explains syntax conventions used in this book.
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 explains style conventions used in this book.
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, FMT-NAME, CS-SV-FATAL |
Client-Library property names |
CS-PASSWORD, CS-USERNAME |
Client-Library and Gateway-Library datatypes |
CS-CHAR, TDSCHAR |
All other names and terms appear in this typeface.
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.
| Copyright © 2005. Sybase Inc. All rights reserved. |
|
|
