4 Software Library Reference Manual for VME 429
Section 1 - Introduction
1.3.2 Parameter Naming Conventions
Naming conventions have been used for naming constants, structures, functions
calls and data types throughout the API S/W Library. All constants, structures and
Data Types used in the API S/W Library are defined in the Api429.h header file
which is contained in Section 2. Function prototypes used in the API S/W Library are
defined in Api429fnc.h, also defined in Section 2. Naming conventions used include
the following
• Constants - For every function call, a list of constants have been defined to
better describe the numerical value of the function input or output (located in
Api429.h)
• Structures - Named as ty_api_name where name is unique to the structure
(located in Api429.h)
• Functions - Named as either Api429name or Api429Cmdname -
Api429name functions do not involve driver commands to the target
hardware
Api429Cmdname functions involve driver commands to the target hardware
(prototypes are located in Api429fnc.h)
• Data Types - all variables are assigned an AIM equated data type as shown
in Table 1.3.2-I below (defined in Api429.h):
Table 1.3.2-I API S/W Library Data type Naming Conventions
API S/W Library Data Type
Size
(in bytes)
AiInt integer 4
AiUInt unsigned integer 4
AiInt8 character 1
AiInt16 short integer 2
AiInt32 long integer 4
AiUInt32 unsigned long integer 4
AiUnt16 unsigned short integer 2
AiUInt8 unsigned character 1
AiChar character 1
AiUChar unsigned character 1
AiDouble double floating point 8
AiFloat single floating point 4