Returns the error string associated with the specified error number.
GxPioGetErrorString (nError, pszMsg, nErrorMaxLen, pnStatus)
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. |
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
-26 Parameter is out of the allowed range
Parameter Errors
-40 Invalid port
-41 Invalid word
-42 Invalid byte
-43 Invalid bit
-44 Invalid counter
-45 Invalid input load control
-46 Invalid counter or all terminal counts and clocks
-47 Invalid terminal count mode
-48 Invalid clock source
-49 Invalid clock internal number
-50 Invalid clock internal source
-51 Invalid gate source
-52 Invalid clock divider value
The following example initializes the board. If the initialization failed, the following error string is printed:
CHAR sz[256];
SHORT nStatus, nHandle;
..
Gx5641Initialize (3, &Handle, &Status);
if (nStatus<0)
{ GxPioGetErrorString(nStatus, sz, sizeof sz, &nStatus);
printf(sz); // prints the error string returns
}