Teledyne Princeton Instruments PICam 5.x, Programmer'S Manual

Page: 23 / 357

23
Chapter 3: General Library APIs
The first section of
picam.h
includes functions to:
• Determine if the PICam library has been initialized;
• Initialize the library;
• Uninitialize the library;
• Retrieve the version.
This section also includes error codes that may be returned from any PICam function.
The first step in using the PICam library is library initialization. This is typically done at
the start of the program. Once the library has been initialized, PICam function can then
be called. The success of every function call is determined by the error code that is
returned. It is paramount this error code be checked as most results are invalidated if a
function fails. To facilitate debugging, PICam can convert an error code into a string. In
fact, any PICam enum can be converted into a string. Once the program is finished with
the library, it should clean up and uninitialized the library. This often occurs during
program shutdown.
3.1 Data Type Definitions
Refer to Table 3-1 for information about data definitions.
Table 3-1: Data Enumeration Definitions for General Library APIs
Name Type Description
PicamError enum The set of error codes returned from all APIs
declared as
PICAM_API
.
PicamEnumeratedType enum The set of all PICam enumeration types.