GtWaveGetErrorString

Supported By

GX1110, GX1120

Purpose

Returns the error string associated with the specified error number.

Syntax

GtWaveGetErrorString (nError , pszMsg, nErrorMaxLen, pnStatus)

Parameters

Name
Type
Comments
nError
SHORT
Error Number.
pszMsg
PSTR
Buffer to the returned error string.
nErrorMaxLen
SHORT
The size of the error string buffer.
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Comments

The function returns the error string associated with the nError as returned from other driver functions.

The following table displays the possible error values; not all errors apply to this board type:

Resource Errors

0
No error has occurred
-1
Unable to open the HW driver. Check if HW is properly installed
-2
Board does not exist in this slot/base address
-3
Different board exist in the specified PCI slot/base address
-4
PCI slot not configured properly. You may configure using the PciExplorer from the Windows Control Panel
-5
Unable to register the PCI device
-6
Unable to allocate system resource for the device
-7
Unable to allocate memory
-8
Unable to create panel
-9
Unable to create Windows timer
-10
Bad or Wrong board EEPROM
-11
Not in calibration mode
-12
Board is not calibrated
-13
Function is not supported by the specified board
General Parameter Errors
-20
Invalid or unknown error number
-21
Invalid parameter
-22
Illegal slot number
-23
Illegal board handle
-24
Illegal string length
-25
Illegal operation mode
Execution errors
-40
Failed to program the board Firmware
-41
Unable to set the specified clock frequency value
-42
Error occurred when trying to program the specified clock frequency
-43
EEPROM gain value is out of range
-44
EEPROM offset value is out of range
-45
Unable to initialize the COM library
-46
Unable to create COM object
-47
Error reading the specified file data
General Execution errors
-50
Offset value is out of range, allowed range is -5.0V to +5.0V
-51
Amplitude value is out of range, allowed ouput voltage range is 0V to +8V peak-to-peak (including offset voltage)
-52
Clock source is out of range, clock source can be either internal or external
-53
Attenuation value is out of range, see user's guide for allowed values
-54
Illegal timeout or not enough time to finish the operation
-55
Board operating mode is out of range, operation mode can either be Function Generator mode or Arbitrary Wave Generator
Trigger
-60
Burst counter value is out of range, allowed range if from 1 to 1048576
-61
Trigger internal rate value is out of range, see user's guide for allowed values
-62
Trigger mode value is out of range, see user's guide for allowed values
-63
Trigger source value is out of range, see user's guide for allowed values
-64
Trigger edge value is out of range, slope value can be positive or negative
-65
PXI trigger line value is out of range, see user's guide for allowed values
-66
Sync source value is out of range, see user's guide for allowed values
Amplitude Modulation
-70
AM depth value is out of range, see user's guide for allowed values
-71
AM frequency value is out of range, see user's guide for allowed values
-72
AM waveform value is out of range, see user's guide for allowed values
-73
AM source value is out of range, AM source can be either internal or external
Function Generator
-80
Function Generator frequency value is out of range, see user's guide for allowed values
-81
Function Generator FM deviation value is out of range, see user's guide for allowed values
-82
Function Generator FM gain value is out of range, see user's guide for allowed values
-83
Function Generator FM frequency value is out of range, see user's guide for allowed values
-84
Function Generator FM waveform value is out of range, see user's guide for allowed values
-85
Function Generator FM source value is out of range, FM source can be either internal or external
-86
Function Generator FSK frequency value is out of range, see user's guide for allowed values
-87
Function Generator FSK rate value is out of range, see user's guide for allowed values
-88
Function Generator FSK source value is out of range, FSK source can be either internal or external
-89
Function Generator waveform value is out of range, see user's guide for allowed values
-90
Function Generator phase value is out of range, phase value can be between 0.0 to 360.0 degrees
-91
Function Generator waveform start address value is out of range, see user's guide for allowed values
-92
Function Generator waveform length value is out of range, see user's guide for allowed values
-93
Function Generator sync mode value is out of range, see user's guide for allowed values
Arbitrary Wave Generator
-100
Arbitrary Waveform Generator sample rate value is out of range, see user's guide for allowed values
-101
Arbitrary Waveform Generator waveform value is out of range, see user's guide for allowed values
-102
Arbitrary Waveform Generator waveform address range value is out of range, see user's guide for allowed values
-103
Arbitrary Waveform Generator wave min num steps value is out of range, see user's guide for allowed values
-103
Arbitrary Waveform Generator memory test failed

 

Example

The following example initializes the board. If the initialization failed, the following error string is printed:

 

CHAR   sz[256];

SHORT  nStatus, nHandle;

..

GtWaveInitialize (3, &Handle, &Status);

if (nStatus<0)

{  GtWaveGetErrorString(nStatus, sz, sizeof sz, &nStatus);

   printf(sz); // prints the error string returns