iWay API Reference V7.1

This documentation describes the iWay Application Programming Interface for Structured Query Language (API). It is intended for application programmers who use the API to design and build programs for accessing relational and non-relational data stored in remote data sources using SQL.

How This Manual Is Organized

This manual includes the following chapters:

Chapter/Appendix		Contents
1	Introducing the API	Provides an overview of the API.
2	API Data Structures	Discusses the API data structures and the API state table.
3	Interface Overview	Describes administrative, communications, and data access method calls.
4	Method Reference	Lists and describes the API method calls.
5	Environment Variables	Lists and discusses API environment variables.
6	Usage Considerations	Explains API usage considerations.
7	Advanced Usage Considerations	Discusses advanced usage considerations, such as multiplexing and enhanced result set management with controlled data transfer.
8	Platform-Specific Considerations	Describes platform-specific considerations for using the API in the supported operating system environments.
9	Tracing	Describes how to set up and execute tracing features for troubleshooting applications.
10	Messaging and Queuing	Describes asynchronous messaging and queuing concepts.
A	Sample Include, Copybook and Global Files	Presents a sample API C Header File, a Cobol Copybook, and Globals for Visual Basic.
B	Programming Examples	Provides programming examples written in C, Visual Basic, and Cobol.
C	Status Codes	Lists and describes API status codes.

Documentation Conventions

The following conventions apply throughout this manual:

Convention	Description
THIS TYPEFACE or this typeface	Denotes syntax that you must enter exactly as shown.
this typeface	Represents a placeholder (or variable) in syntax for a value that you or the system must supply.
underscore	Indicates a default setting.
this typeface	Represents a placeholder (or variable), a cross-reference, or an important term. It may also indicate a button, menu item, or dialog box option you can click or select.
this typeface	Highlights a file name or command.
Key + Key	Indicates keys that you must press simultaneously.
{ }	Indicates two or three choices; type one of them, not the braces.
[ ]	Indicates a group of optional parameters. None are required, but you may select one of them. Type only the parameter in the brackets, not the brackets.
|	Separates mutually exclusive choices in syntax. Type one of them, not the symbol.
...	Indicates that you can enter a parameter multiple times. Type only the parameter, not the ellipsis points (...).
. . .	Indicates that there are (or could be) intervening or additional commands.

Related Publications

To view a current listing of our publications and to place an order, visit our World Wide Web site, http://www.iwaysoftware.com. You can also contact the Publications Order Department at (800) 969-4636.

Customer Support

Do you have questions about iWay API?

Call Information Builders Customer Support Service (CSS) at (800) 736-6130 or (212) 736-6130. Customer Support Consultants are available Monday through Friday between 8:00 a.m. and 8:00 p.m. EST to address all your iWay API questions. Information Builders consultants can also give you general guidance regarding product capabilities and documentation. Please be ready to provide your six-digit site code (xxxx.xx) when you call.

You can also access support services electronically, 24 hours a day, with InfoResponse Online. InfoResponse Online is accessible through our World Wide Web site, http:// www.informationbuilders.com. It connects you to the tracking system and known-problem database at the Information Builders support center. Registered users can open, update, and view the status of cases in the tracking system and read descriptions of reported software issues. New users can register immediately for this service. The technical support section of www.informationbuilders.com also provides usage techniques, diagnostic tips, and answers to frequently asked questions.

To learn about the full range of available support services, ask your Information Builders representative about InfoResponse Online, or call (800) 969-INFO.

Information You Should Have

To help our consultants answer your questions most effectively, be ready to provide the following information when you call:

• Your six-digit site code (xxxx.xx).
• Your iWay Software configuration:
• The iWay Software version and release.
• The communications protocol (for example, TCP/IP or LU6.2), including vendor and release.

• The stored procedure (preferably with line numbers) or SQL statements being used in server access.
• The database server release level.
• The database name and release level.
• The Master File and Access File.
• The exact nature of the problem:
• Are the results or the format incorrect? Are the text or calculations missing or misplaced?
• The error message and return code, if applicable.
• Is this related to any other problem?

• Has the procedure or query ever worked in its present form? Has it been changed recently? How often does the problem occur?
• What release of the operating system are you using? Has it, your security system, communications protocol, or front-end software changed?
• Is this problem reproducible? If so, how?
• Have you tried to reproduce your problem in the simplest form possible? For example, if you are having problems joining two data sources, have you tried executing a query containing just the code to access the data source?
• Do you have a trace file?
• How is the problem affecting your business? Is it halting development or production? Do you just have questions about functionality or documentation?

User Feedback

In an effort to produce effective documentation, the Documentation Services staff welcomes your opinions regarding this manual. Please use the Reader Comments form at the end of this manual to relay suggestions for improving the publication or to alert us to corrections. You can also use the Documentation Feedback form on our Web site, http:// www.informationbuilders.com/bookstore/derf.html.

Thank you, in advance, for your comments.

iWay Software Training and Professional Services

Interested in training? Our Education Department offers a wide variety of training courses for iWay Software and other Information Builders products.

For information on course descriptions, locations, and dates, or to register for classes, visit our World Wide Web site (http://www.iwaysoftware.com) or call (800) 969-INFO to speak to an Education Representative.

Interested in technical assistance for your implementation? Our Professional Services department provides expert design, systems architecture, implementation, and project management services for all your business integration projects. For information, visit our World Wide Web site (http://www.iwaysoftware.com).