Home

	Expand Search

Sybase dbQueue Reference Guide

About This Book

About This Book

This book, Sybase dbQueue Reference Guide, contains information about the dbQueue Application Programming Interfaces (APIs).

The Sybase dbQueue Reference Guide is for application developers writing distributed messaging applications.

How to Use This Book

This book contains the following:

• "Chapter 1, "Using the dbQueue Objects Library," describes how to use the dbQueue C++ object library.
• "Chapter 2, "dbQueue Objects Class Reference," contains reference pages for the C++ object classes and methods.
• "Chapter 3, "Using the ActiveX Interface," describes how to use the ActiveX objects.
• "Chapter 4, "ActiveX Objects and Interfaces," contains reference pages for the ActiveX objects and methods.
• "Chapter 5, "dbQueue Queue Schema," describes the queue schema columns and datatypes.
• "Chapter 6, "Queue Stored Procedure Interface," describes how to use stored procedures to access the dbQueue queues.
• "Appendix A, "Datatypes," describes the dbQueue datatypes.

Related Documents

• Sybase dbQueue User's Guide introduces dbQueue and its components. It also describes how to use Sybase Central to configure the system.
• dbQueue Installation Guide/Release Bulletin contains installation instructions for your platform. It also contains up-to-date information about the current release.

Other Sources of Information

Use the SyBooks(TM) and SyBooks-on-the-Web online resources to learn more about your product:

• SyBooks documentation is on the CD that comes with your software. The DynaText browser, also included on the CD, allows you to access technical information about your product in an easy-to-use format.

  Refer to Installing SyBooks in your documentation package for instructions on installing and starting SyBooks.

• SyBooks-on-the-Web is an HTML version of SyBooks that you can access using a standard Web browser.

  To use SyBooks-on-the-Web, go to http://www.sybase.com, and choose Documentation.

Sybase Certifications on the Web

The Technical Support information on the Sybase Web site is updated frequently.

For the latest information on product certifications and/or the EBF Rollups:

1. Point your Web browser to the Technical Information Library at the following URL:

   http://techinfo.sybase.com

2. In the Browse section, click on the Hot entry.

3. Explore your area of interest: Hot Docs covering various topics, or Hot Links to Technical News, Certification Reports, Partner Certifications, and so on.

If you are a registered SupportPlus user:

1. Point your Web browser to the Technical Information Library at the following URL.

   http://techinfo.sybase.com

2. In the Browse section, click on the Hot entry.

3. Click on the EBF Rollups entry.

   You can research EBFs using the Technical Information Library, and you can download EBFs using Electronic Software Distribution (ESD).

4. Follow the instructions associated with the SupportPlus^SM Online Services entries.

If you are not a registered SupportPlus user, and you want to become one:

You can register by following the instructions on the Web.

To use SupportPlus, you need:

• A Web browser that supports the Secure Sockets Layer (SSL), such as Netscape Navigator 1.2 or later
• An active support license
• A named technical support contact
• Your user ID and password

Whether or not you are a registered SupportPlus user:

You may use Sybase's Technical Information Library. Certification Reports are among the features documented at this site.

1. Point your Web browser to the Technical Information Library at the following URL:

   http://techinfo.sybase.com

2. In the Browse section, click on the Hot entry.

3. Click on the topic that interests you.

Conventions

This section describes style and syntax conventions, command formatting conventions, and graphic icons used in this book.

Style Conventions

Syntax statements (displaying the syntax and options for a command) are printed as follows:

deq_<Q> ['header_field','value']

See "Syntax Conventions" for more information.

Examples that show the use of dbQueue methods and stored procedures are printed as follows:

deq_orders

Command names, command option names, program names, program flags, keywords, configuration parameters, functions, and stored procedures are printed as follows:

Use qtm to start the queue transfer manager.

Variables, parameters to functions and stored procedures, and user-supplied words are in italics in syntax and in paragraph text, as follows:

The rst_<Q> command reset the queue <Q>.

Names of database objects, such as databases, tables, columns, and datatypes, are in italics in paragraph text, as follows:

The base_price column in the Items table is a money datatype.

Syntax Conventions

Syntax formatting conventions are summarized in the following table. Examples combining these elements follow.

Key	Definition
variable	Variables (words standing for values that you fill in) are in italics.
{ }	Curly braces mean you must choose at least one of the enclosed options. Do not include braces in the command.
[ ]	Brackets mean you may choose or omit enclosed options. Do not include brackets in the command.
|	Vertical bars mean you may choose no more than one option (enclosed in braces or brackets).
,	Commas mean you may choose as many options as you need (enclosed in braces or brackets). Separate your choices with commas, to be typed as part of the command. Commas may also be required in other syntax contexts.
( )	Parentheses are to be typed as part of the command.
...	An ellipsis (three dots) means you may repeat the last unit as many times as you need. Do not include ellipses in the command.

Obligatory Choices

• Curly braces and vertical bars - choose only one option.

  {red | yellow | blue}

• Curly braces and commas - choose one or more options. If you choose more than one, separate your choices with commas.

  {cash, check, credit}

Optional Choices

• One item in square brackets - you can choose it or omit it.

  [anchovies]

• Square brackets and vertical bars - choose none or only one.

  [beans | rice | sweet_potatoes]

• Square brackets and commas - choose none, one, or more options. If you choose more than one, separate your choices with commas.

  [extra_cheese, avocados, sour_cream]

Repeating Elements

An ellipsis (...) means that you may repeat the last unit as many times as you need. In this syntax statement, buy is a required keyword:

buy thing = price [cash | check | credit]
[, thing = price [cash | check | credit]]...

Graphic Icons

Illustrations in this book use the following graphic icons to represent the components of a messaging system.

This icon represents a data source. Data sources manage databases containing queues.

This icon represents a client application. A client application is a user process or application connected to a data source. It may be a front-end application program executed by a user or a program that executes as an extension of the system.

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.