This book, the Open Client and Open Server Common Libraries Reference Manual, contains reference information regarding:
The C version of CS-Library, which contains utility routines that are useful to both Open Client™ Client-Library™ and Open Server™ Server-Library applications.
The C version of Bulk-Library, which provides bulk copy routines for Client-Library and Server-Library applications. Bulk copy allows high-speed transfer of data between a database table and program variables.
In previous Open Client/Server™ releases,
Bulk-Library was referred to as “the Bulk Copy routines.”
This manual is designed to serve as a reference manual for programmers who are writing Client-Library or Open Server applications. It is written for application programmers who are familiar with the C programming language.
When writing an Open Client or Open Server application, use the Common Libraries Reference Manual as a source of reference information for CS-Library and Bulk-Library routines.
Chapter 1, “Introducing CS-Library,” contains a brief introduction to CS-Library.
Chapter 2, “CS-Library Routines,” contains specific information about each CS-Library routine, such as what parameters the routine takes and what it returns.
Chapter 3, “Bulk-Library,” contains a brief introduction to Bulk-Library.
Chapter 4, “Bulk-Library Routines,” contains specific information on each Bulk-Library routine.
The Open Client Client-Library Programmer’s Guide contains information on how to design and implement Client-Library programs.
The Open Client Client-Library Reference Manual contains reference information for Client-Library.
The Open Server Server-Library Reference Manual contains reference information for Server-Library.
The Open Client/Server Programmer’s Supplement contains platform-specific material needed by developers who use the Open Client/Server products. This document includes information about:
Compiling and linking an application
The example programs that are included online with Open Client/Server products
Routines that have platform-specific behavior
The Open Client/Server Configuration Guide contains information needed by system administrators who configure the Open Client/Server installation environment. This document includes information about:
Platform-specific localization mechanisms
Configuring Sybase drivers for network services
The interfaces file and other configuration files
The Open Client/Server International Developer’s Guide contains information needed by programmer’s who develop international applications with Client-Library. This document includes:
A description of the localization mechanism used by the Open Client and Open Server libraries
Guidelines for developing international applications with the Open Client and Open Server libraries
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/Updates, 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
updates
Point your Web browser to the Sybase Support Page.
Select EBFs/Updates. 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/Update report, or click the product description to download the software.
CS-Library routine syntax is show in a bold, monospace font:
CS_RETCODE cs_ctx_alloc(version, ctx_pointer)
Program text and computer output are shown in a monospace font:
cs_ctx_alloc(CS_VERSION_100, &context);
Structure names and symbolic constants appear in capital letters (to match their definitions in the csstypes.h header file):
CS_CONTEXT, CS_EXTRA_INF
Routine names and Transact_SQL® keywords are written in a narrow, bold font:
cs_ctx_alloc, the select statement
Code fragments in this book are taken from the online example programs that are included with Client-Library and Server-Library.
The example programs and the code fragments in this book use EX_*, Ex_*, and ex_* #defines, variables, and routines. These #defines, variables, and routines are part of the example programs, but are not a part of CS-Library, Client-Library, or Server-Library.
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.
