CompuScope SDK Manua.. - Egmont Instruments

Return Value
1 if no error and a negative number if an error occurs.
The following is a list of return codes including possible errors.
Constant in GAGE_DRV.H
Value, description
============================================================================
GAGE_AA_SUCCESSFUL
1L The routine completed correctly and the average
buffer, "avg_buffer", contains the averaged of
summed data.
GAGE_AA_ROUTINE_UNAVAILABLE
GAGE_AA_INVALID_TRIGGER_SOURCE
GAGE_AA_INVALID_TRIGGER_DEPTH
GAGE_AA_INVALID_BUFFER_SIZES
GAGE_AA_INVALID_CHANNEL
GAGE_AA_UNAVAILABLE_CHANNEL
GAGE_AA_INVALID_AVERAGE_NUM
0L The routine is not implemented and the task
could not be performed. This is temporary return
value until all cards have had this routine
implemented.
-1L This routine will not function with a software
controlled trigger. Only a valid hardware trigger
source is allowed. This can be channel A, channel B
or the external trigger input.
-2L Board returned a different number of points than
requested, the acquisition depth is less than the
requested average number of samples.
-3L The "data_buffer_size" parameter is not at least
as large as the number of samples required for each
average.
-4L The channel specified does not currently exist.
Example: channel 3 (board 2 channel A) was
specified and the current CompuScope installed
system has only one board.
-5L The channel specified is not currently available
or enabled, therefore it does not have any valid data
to be averaged. Example: channel 2 (board 1 channel
B)was specified and the current acquisition mode is
single channel mode.
-6L This value is returned when the number of
averages (naverages) is greater than the maximum
32-bit integer (0x7fffffff hex or 2,147,483,647
decimal) divided by the size of the sample resolution
(256 for 8-bit cards and 4096 for 12-bit cards). This
is calculated by using 0x7fffffff and shifting it to the
right by the number of bits of sample resolution
(8 or 12).
CompuScope API Reference Manual
61