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 and Open 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 Open Client and Open Server 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 Server and SDK New Features for Microsoft Windows, Linux, and UNIX, which describes new features available for Open Server and the Software Developer’s Kit. This document is revised to include new features as they become available.
The Open Client Client-Library/C Programmers Guide contains information on how to design and implement Client-Library programs.
The Open Client Client-Library/C Reference Manual contains reference information for Client-Library.
The Open Server Server-Library/C Reference Manual contains reference information for Server-Library.
The Open Client and Open Server Programmers Supplement for Microsoft Windows and the Open Client and Open Server Programmers Supplement for UNIX contain platform-specific material needed by developers who use the Open Client and Open Server products. These documents include information about:
Compiling and linking an application
The sample programs that are included with Open Client and Open Server products
Routines that have platform-specific behavior
The Open Client and Open Server Configuration Guide for Microsoft Windows and Open Client and Open Server Configuration Guide for UNIX contain information needed by system administrators who configure the Open Client and Open Server installation environment. These documents includes information about:
Platform-specific localization mechanisms
Configuring Sybase® drivers for network services
The interfaces file and other configuration files
The Open Client and Open 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 SyBooks™ CD, and the Sybase 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 SyBooks CD. It is included with your software. To read or print documents on the Getting Started CD, you need Adobe Acrobat Reader, which you can download at no charge from the Adobe Web site using a link provided on the CD.
The SyBooks CD contains product manuals and is included with your software. The Eclipse-based SyBooks browser allows you to access the manuals in an easy-to-use, HTML-based format.
Some documentation may be provided in PDF format, which you can access through the PDF directory on the SyBooks CD. To read or print the PDF files, you need Adobe Acrobat Reader.
Refer to the SyBooks Installation Guide on the Getting Started CD, or the README.txt file on the SyBooks CD for instructions on installing and starting SyBooks.
The Sybase Product Manuals Web site is an online version of the SyBooks 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 Sybase 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.
Click Document Types under Technical Documents from the navigation bar on the left. Then, click Certification Report.
In the Certification Report filter, select Product, Platform, and Timeframe. Then, 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. If prompted, enter your MySybase user name and password.
Select a product.
Specify a time frame and click Go. A list of EBF/Maintenance releases is displayed.
Padlock icons indicate that you do not have download authorization for certain EBF/Maintenance releases because you are not registered as a Technical Support Contact. If you have not registered, but have valid information provided by your Sybase representative or through your support contract, click Edit Roles to add the “Technical Support Contact” role to your MySybase profile.
Click the Info icon to display the EBF/Maintenance report, or click the product description to download the software.
Key |
Definition |
|---|---|
command |
Command names, command option names, utility names, utility flags, and other keywords are in sans serif font. |
variable |
Variables, or words that stand for values that you fill in, are in italics. |
{ }
|
Curly braces indicate that you choose at least one of the enclosed options. Do not include braces in your option. |
[ ] |
Brackets mean choosing one or more of the enclosed items is optional. Do not include brackets in your option. |
( ) |
Parentheses are to be typed as part of the command. |
| |
The vertical bar means you can select only one of the options shown. |
, |
The comma means you can choose as many of the options shown as you like, separating your choices with commas to be typed as part of the command. |
This document is available in an HTML version that is specialized for accessibility. You can navigate the HTML with an adaptive technology such as a screen reader, or view it with a screen enlarger.
Open Client and Open Server documentation has been tested for compliance with U.S. government Section 508 Accessibility requirements. Documents that comply with Section 508 generally also meet non-U.S. accessibility guidelines, such as the World Wide Web Consortium (W3C) guidelines for Web sites.
You might need to configure your accessibility tool
for optimal use. Some screen readers pronounce text based on its
case; for example, they pronounce ALL UPPERCASE TEXT as initials,
and MixedCase Text as words. You might find it helpful to configure
your tool to announce syntax conventions. Consult the documentation
for your tool.
For information about how Sybase supports accessibility, see Sybase Accessibility. The Sybase Accessibility site includes links to information on Section 508 and W3C standards.
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.
