About this book

This book, the Open Client Client-Library Migration Guide, contains information on how to migrate Open Client™ DB-Library™ applications to Open Client Client-Library™.

Audience

This book has a dual audience:

How to use this book

The following table describes the chapters in this book:

Table 1: Chapters in this book

Chapter

Contents

Chapter 1, “Understanding Client-Library”

Introduces Client-Library and explains what is unique about Client-Library

Chapter 2, “Evaluating an Application for Migration”

Provides guidelines to help you decide whether to migrate a DB-Library application to Client-Library

Chapter 3, “Planning for Migration”

Contains practical information on planning for migration

Chapter 4, “Comparing DB-Library and Client-Library Infrastructures”

Compares the DB-Library and Client-Library infrastructures

Chapter 5, “Converting DB-Library Application Code”

Explains how to accomplish basic DB-Library tasks using Client-Library

Chapter 6, “Advanced Topics”

Contains information on more advanced Client-Library features

Appendix A, “Mapping DB-Library Routines to Client-Library Routines”

Maps DB-Library routines to Client-Library

Return code error checking in code fragments

This book contains a number of code fragments taken from the set of migration example programs that Sybase provides on the World Wide Web.

The example fragments in this book use the EXIT_ON_FAIL() example macro, which is as follows. Macros similar to this can simplify return code error checking. However, this macro is not appropriate for every situation.

/*
** Define a macro that exits if a function return code indicates
** failure. Accepts a CS_CONTEXT pointer, a Client-Library
** or CS-Library return code, and an error string. If the
** return code is not CS_SUCCEED, the context will be 
** cleaned up (if it is non-NULL), the error message is
** printed, and we exit to the operating system.
*/
#define EXIT_ON_FAIL(context, ret, str) \
  { if (ret != CS_SUCCEED) \
  { \
    fprintf(stderr, \
            "Fatal error: %s\n", str); \
    if (context != (CS_CONTEXT *) NULL) \
    { \
      (CS_VOID) ct_exit(context, CS_FORCE_EXIT); \
      (CS_VOID) cs_ctx_drop(context); \
    } \
    exit(ERROR_EXIT); \
  } }

Conventions

DB-Library and Client-Library routine syntax is shown in a bold, monospace font:

CS_RETCODE ct_init(context, version)

     CS_CONTEXT  *context;
     CS_INT      version;

Program text and computer output are shown in a monospace font:

ct_init(mycontext, CS_VERSION_100);

Routine names and Transact-SQL® keywords are written in a narrow, bold font:

ct_init, the select statement.

World Wide Web access

The migration example programs can be found on the Sybase World Wide Web page (http://www.sybase.com).

The README file provided with the migration examples contains a descriptive list of the example files.

Related documents

Sybase documents Client-Library and DB-Library in a variety of references and guides. Table 2 lists Client-Library and DB-Library manuals.

Table 2: Client-Library and DB-Library documentation

Document name

Description

Open Client Client-Library/C Reference Manual

Reference manual for Client-Library.

Open Client Client-Library/C Programmer’s Guide

Basic information on programming with Client-Library.

Open Client and Open Server Common Libraries Reference Manual

Reference manual for CS-Library and Bulk-Library.

Open Client DB-Library/C Reference Manual

Reference manual for DB-Library.

Open Client/Server Programmer’s Supplement

Platform-specific information for coding Open Client/Server applications. Includes:

  • Compile and link instructions for Client-Library applications

  • Information on compiler certifications

  • Information on how to configure your environment to run applications

Open Client/Server Configuration Guide

Information on configuring your environment to run Open Client or Open Server applications.

Other sources of information

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:

Sybase certifications on the Web

Technical documentation at the Sybase Web site is updated frequently.

StepsFinding the latest information on product certifications

  1. Point your Web browser to Technical Documents.

  2. Select Products from the navigation bar on the left.

  3. Select a product name from the product list and click Go.

  4. Select the Certification Report filter, specify a time frame, and click Go.

  5. Click a Certification Report title to display the report.

StepsCreating 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.

  1. Point your Web browser to Technical Documents.

  2. Click MySybase and create a MySybase profile.

Sybase EBFs and software maintenance

StepsFinding the latest information on EBFs and software maintenance

  1. Point your Web browser to the Sybase Support Page.

  2. Select EBFs/Maintenance. Enter user name and password information, if prompted (for existing Web accounts) or create a new account (a free service).

  3. Select a product.

  4. Specify a time frame and click Go.

  5. Click the Info icon to display the EBF/Maintenance report, or click the product description to download the software.

If you need help

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.