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 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 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 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.
The SDK and Open Server Installation Guide for Microsoft Windows and SDK and Open Server Installation Guide for UNIX explain 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 sample programs that are included with Open Client and Open 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
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 Certification Report.
In the Certification Report filter select a product, platform, and timeframe and then click Go.
Click a Certification Report title to display the report.
Finding the latest information on component certifications
Point your Web browser to Availability and Certification Reports.
Either select the product family and product under Search by Base Product; or select the platform and product under Search by Platform.
Select Search to display the availability and certification report for the selection.
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. |
Open Server version 15.0 includes a number of sample Open Server application programs. They are located in $SYBASE/$SYBASE_OCS/sample/srvlibrary for UNIX, and %SYBASE%\%SYBASE_OCS%\sample\srvlib for Microsoft Windows. 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 for your platform. For information on how to run sp-syntax, see its reference page in the Adaptive Server Enterprise Reference Manual.
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.
