This GXSW driver functions reference chapter is organized in alphabetical order. Each function description contains the function name, purpose, syntax, parameters description and type followed by a Comments, an Example (written in C), and a See Also sections.
All function parameters follow the same rules:
Strings are ASCIIZ (null or zero character terminated).
The first parameter of most functions is nHandle (16-bit integer). This parameter is required for operating the board and it returned by the specific GxXXXXInitialize or GxSWInitializeVisa functions. The nHandle is used to identify the board when calling other driver functions.
All functions return a status with the last parameter named pnStatus. The pnStatus is zero if the function was successful, or less than a zero on error. The description of the error is available using the GxSWGetErrorString function or by using a predefined constant, defined in the driver interface files: GXSW.H, GXSW.BAS, GXSW.PAS or the driver specific ATEasy driver (e.g. GX6338.DRV).
Parameters name are prefixed as follows:
Prefix |
Type |
Example |
a |
Array, prefix this before the simple type. |
anArray (Array of short) |
n |
Short (signed 16-bit) |
nMode |
d |
Double - 8 bytes floating point |
dReading |
dw |
Double word (unsigned 32-bit) |
dwTimeout |
hwnd |
Window handle (32-bit - unsigned, DWORD). |
hwndPanel |
l |
Long (signed 32-bit) |
lBits |
p |
32-bit pointer for and. Usually used to return a value. Prefix this before the simple type. |
pnStatus |
sz |
Zero terminated string |
szMsg |
w |
Unsigned short (unsigned 16-bit) |
nMode |
Parameter Prefixes