Home

Getting Started

Utilities

Indexing

Omnidex

Development

Tutorials

Quick Links

 

OmniAccess API

Functions

Syntax

Options

Example

 

OmniAccess API

Programming Basics

Managing Data

Functions

 

OADEBUG

oadebug lets you enable and disable debugging from within an application. In addition, it lets you specify how much or how little debugging information you want and the name of the file to which you want debugging information saved.

To enable debugging, from within an application, call oadebug with the options you want. Additionally, if you are calling oadebug from within a client-based application, you must supply in node the server name as it is declared in the Data Source file on the client machine.

Limiting the Scope of an Option

You can restrict the options CLOCKS, EXCEPTIONS and PARMS to certain specified intrinsics by creating an equation. For example, the following equation limits oadebug to reporting parameters only for oaconnect:

PARMS=OACONNECT

You can specify several OmniAccess calls:

EXCEPTIONS='OACONNECT,OASELECT,OAFETCH'

If the data strings contain embedded spaces or commas, you must enclose the string in single quotes.

You can exclude all but certain OmniAccess calls:

CLOCKS='NOT OASELECT,OAOPENCURSOR'

 

Syntax

oadebug (instance, options, status, node)

instance -- Is a 32-bit signed integer passed by value. This is the value returned by a successful call to oaconnect.

options -- options is a 256-byte character string, passed by reference, that indicates the action(s) for oadebug to take. Separate multiple options with commas and terminate the option list with a semicolon or a null character.

status -- Indicates the success or failure of the oacopyfile routine. A zero status.error means a successful call to oacopyfile. The status structure is passed by reference and contains fourteen 32-bit signed integers, followed by a 36-character buffer.

node -- Is reserved when oadebug is used in a server-based application and must contain only a semicolon or null terminator. However, when a client application calls oadebug, node must contain the server name as declared in the Client Data Source file (terminated by a semicolon or null). In both cases, oadebug executes debugging on the server.

 

 

Options

CLOCKS[= routines] -- displays enter and exit times for each parameter where routines are the specific routines to report for this option.

EXCEPTIONS[= routines] -- displays messages only when an exceptional condition occurs where routines are the specific routines to report for this option.

FILE=" filespec" -- redirects output to a specified file, where filespec contains the file name and any path information.

FLUSH -- opens and closes the DEBUG file as it writes each call. This is useful when debugging an application that ends abnormally because it writes each call as it occurs.

OFF -- stops writing debug messages to the screen or file.

PARMS[=routines] -- displays parameter values passed to and returned from each OmniAccess call where routines are the specific routines to report for this option.

 

 

Example

 

Top