GxCalGetErrorString

Purpose

Returns the error string associated with the specified error number.

Syntax

GxCalGetErrorString (nError, pszMsg, nErrorMaxLen, pnStatus)

Parameters

Name
Type
Description
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

Parameter Errors

-40
Standard value not supported
-41
Unable to enable interrupt or event
-42
Unable to disable interrupt or event
-43
Event or interrupt timeout
-44
Event or interrupt wait error
-45
Invalid measure voltagerange.

In-System Calibration Errors

-50
Error: In-System Calibration was not stated.
-51
Error: In-System Calibration invalid device.
-52
Error: In-System Calibrationinvalid device data index.
-53
Error: In-System Calibration device not in calibration mode.
-54
Error: In-System Calibrationinvalid device data.
-55
Error: In-System Calibration10MHz  time base.

Built In Test error/warning

-60
Error: In-System Calibration was not stated.
-61
Error: In-System Calibration invalid device.

Example

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

 

CHAR    sz[256];

SHORT   nStatus, nHandle;

..

GxCalInitialize (3, &Handle, &Status);

if (nStatus<0)

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

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

}

 

See Also