This manual, the Open Server Server-Library/C Reference Manual, contains reference information for the C version of Open Server™ Server-Library.
The Open Server Server-Library/C Reference Manual is designed as a reference manual for programmers who are writing Open Server applications. It is written for application programmers who are familiar with the C programming language.
When writing an Open Server application, use the Open Server Server-Library/C Reference Manual as a source of reference information.
Chapter 1, “Introducing Open Server” contains a brief introduction to Open Server.
Chapter 2, “Topics” contains information on how to accomplish specific programming tasks, such as using Server-Library routines to read a text or image value from the server. This chapter also contains information on Open Server structures, programming techniques, and error handling.
Chapter 3, “Routines” contains specific information about each Server-Library routine, such as what parameters the routine accepts and what values it returns.
Chapter 4, “System Registered Procedures” contains information on the registered procedures that Server-Library automatically provides. It includes a description of parameters, results, and messages.
Glossary words appear in bold the first time they are used in the text of this manual.
The Open Client and Open Server Installation Guide for your platform explains how to install Open Server.
The Open Client and Open Server Common Libraries Reference Manual contains reference information for:
CS-Library
Bulk-Library
The Open Client and Open Server Programmer’s Supplement for your platform contains platform-specific programming information, including information about:
Compiling and linking an application
The example programs that are included online with Open Client/Server products
Routines that have platform-specific behaviors
The Open Client and Open Server Configuration Guide for your platform contains platform-specific configuration information, including information about:
The interfaces file
Localization
The Sybase document set includes a wide range of user guides and reference manuals that describe all aspects of the Sybase relational database management system. Because application development can draw on a number of different parts of the Sybase system, you may encounter most of the Sybase document set at some time or another. A few manuals that will prove to be particularly useful:
The Open Client Client-Library/C Reference Manual contains reference information for Client-Library™, a collection of routines for use in writing client applications.
The Open Client DB-Library/C Reference Manual describes DB-Library™. Like Client-Library, DB-Library is a collection of routines for use in writing client applications.
The Sybase Adaptive Server Enterprise Reference Manual describes Transact-SQL®, the database language an application uses to create and manipulate Sybase Adaptive Server Enterprise™ database objects.
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.
Server-Library routine syntax is shown like this:
CS-RETCODE srv-getmsgq(msgqid, msgp, getflags, infop) SRV-OBJID msgqid; CS-VOID *msgp; CS-INT getflags; CS-INT *infop;
Program text and computer output are shown like this:
srv_getmsgq(myqid, msgbuf, SRV_M_NOWAIT, &info);
Open Server version 12.5 includes a number of sample Open Server application programs. They are located in $SYBASE/sample/srvlibrary. The Open Client and Open Server Programmer’s Supplement for your platform summarizes each sample program and describes the requirements for running each.
If you have access to a SQL Server version 10.0 or later, you can use sp-syntax, a Sybase system procedure, to retrieve the syntax of Server-Library routines. For information on how to install sp-syntax, see the System Administration Guide Supplement for your platform. For information on how to run sp-syntax, see its reference page in the Adaptive Server Enterprise Reference Manual.
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.