Using the C API

## Using the Understand C API

The C API provides read-only access to the Understand database. The analyzed database cannot be changed by API functions. The C Interface to the database is described in this chapter.

This API can be used with Understand for Ada, Understand for C/C++, and Understand for Fortran. A quick overview of using the C API is provided in the next section. Some code samples utilizing basic API functions are also provided.

The API Reference Section contains detailed descriptions on each API function. Some functions are specific to certain languages. Understand product-specific functions are noted in their descriptions.

### Licensing

Use of the C API requires an Understand license be available for use. You do not need to do anything extra to request the license - it is handled for you by the API.

### API Memory Allocation

The API never requires the user to pass in an allocated item. Any API function that does allocation has a corresponding API function which must be called to free that item. The user must never call the system `free()' to free an item allocated by the API.

### Other API Interfaces

A Perl interface is also provided with Understand. See http://www.scitools.com/perl for details on the Perl interface.

Scientific Toolworks, Inc. http://www.scitools.com Voice: (802) 763-2995 Fax: (802) 763-3066 support@scitools.com sales@scitools.com