iSeries Access for Windows Serviceability APIs

The iSeries™ Access for Windows^® Serviceability application programming interfaces (APIs) allow you to log service file messages and events within your program.

A set of APIs allows you to read the records from the service files that are created. These APIs allow you to write a customized service-file browser.

The following general categories of iSeries Access for Windows Serviceability API functions are provided:

Writing message text to the History log
Writing Trace entries to the Trace file
Reading service files
Retrieving message text that is associated with error handles

Why you should use iSeries Access for Windows Serviceability APIs:

The iSeries Access for Windows Serviceability APIs provide an efficient means of adding message logging and trace points to your code. Incorporate these functions into programs that are shipped as part of your product, and use them to help debug programs that are under development. The file structure supports multiple programs (that are identified by unique product and component strings) logging to the same files simultaneously. This provides a complete picture of logging activity on the client workstation.

iSeries Access for Windows Serviceability APIs required files:

Header file	Import library	Dynamic Link Library
cwbsv.h	cwbapi.lib	cwbsv.dll

Programmer's Toolkit:

The Programmer's Toolkit provides Serviceability documentation, access to the cwbsv.h header file, and links to sample programs. To access this information, open the Programmer's Toolkit and select Error Handling > C/C++ APIs.

Note: By using the code examples, you agree to the terms of the Code license and disclaimer information.

History log and trace files
History logs and trace files allow you to log information about your programs.
Error handles
The error handle functions allow you to create an error handle (cwbSV_CreateErrHandle) to use on iSeries Access for Windows APIs that support it.
Typical use of Serviceability APIs
Typical uses of serviceability APIs include history logs and error handles.
Serviceability APIs list: Writing to history log
Use these APIs to write message text to a history log
Serviceability APIs list: Writing trace data
Use these APIs to write trace data to a detail trace file
Serviceability API list: Writing trace points
Use these APIs to write trace points to an entry/exit trace file
Serviceability API list: Reading service files
Use these APIs to read service files, service file records, and service file header information. Additionally, you can read history log service records, detail trace file service records, and entry/exit trace file service records.
Serviceability API list: Retrieving message text
Use these APIs to retrieve message text associated with error handles
Example: Using iSeries Access for Windows Serviceability APIs
The following example uses the iSeries Access for Windows Serviceability APIs to log a message string to theiSeries Access for Windows History Log.

Parent topic: iSeries Access for Windows C/C++ APIs

Related reference

Serviceability APIs return codes