The following files are required to use the C API. They are all shipped with the API programming package. Note that a Windows 32-bit version of a C API demo program (Demo.exe), and its source code, is also included. This program demonstrates most of the basic actions client applications require, such as starting Imagenation, using external windows, and using advises. For UNIX, $IMHOME/CAPIClient/sample-makefile is a small sample UNIX makefile showing the compile and link of a typical client application.
|
File |
Purpose |
|
in_api.h |
contains the defined functions, arranged by category. It also contains the portable data types that are used to define the parameters, and the structures that are used as parameters by some of the functions. |
|
inapidef.h |
contains all of the defined constants |
|
inapierr.h |
contains all of the defined error and warning messages. See Error and warning codes. |
|
inapiobj.h |
contains all of the defined structures for the IN_PlaceVectorObject and IN_GetVectorObjectDescription functions. These functions have not been tested in Imagenation for UNIX. |
|
Inapid32.dll |
Windows only. It contains the executable code for the 32-bit client DLL. The required file must be either in the directory where the client application is or in the PATH environment variable. |
|
Inapid32.lib |
Windows only. A library module that allows you to link the 32-bit C API into your client application. |
|
libcapi.so * |
UNIX only. A shared object library for the C API client application. |
|
libcapi.a |
UNIX only. An archive library for the C API client application to link with. |
* On HP UNIX boxes using a C compiler, XMotif applications will not work if linking to libcapi.so. They do work with libcapi.a, or when compiling with C++.
Back to: Setting up a C API integration
See also