In this section:
How to use the library reference .............................................. 2-1
Categorized subroutine lists ..................................................... 2-2
How to use the library reference
The subroutines in the
Test subroutine library reference
(on page 3-1) are in the C programming
language. Each subroutine is presented in a standard format that follows the pattern below:
Purpose statement:
The first line of text under the subroutine heading contains a brief
explanation of what the subroutine does.
Figure 1: Example purpose statement
Usage:
A line of code representing the prototype of the subroutine, followed by a table listing the
input and output parameters for the subroutine. Parameters that you specify are shown in
monospace italic
font; parameters preceded by an asterisk (
*
) are pointers to information
that is returned. Each parameter is preceded by one of the following declarations that specifies
the data type for the parameter:
int
(integer),
double
(double-precision floating-point), and
char
(a single character value).
Figure 2: Example syntax and parameter definition
Section 2
Using the test subroutine library
