The GxSmu driver functions reference chapter is organized in alphabetical order. Each function description contains the function name; purpose, syntax, parameters description and type followed by Comments, an Example (written in C), and a See Also sections.
All function parameters syntax follows 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 is returned by the GxSmuInitialize function. The nHandle is used to identify the board when calling a function for programming and controlling the operation of that board.
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 GxSmuGetErrorString function or by using a predefined constant, defined in the driver interface files: GxSmu.h, GxSmu.vb, or GxSmu.llb.
Parameter name are prefixed as follows:
Prefix |
Type |
Example |
a |
Array, prefix this before the simple type. |
anArray (Array of Short) |
b |
BOOL – Boolean, 0 for FALSE; <>0 for TRUE |
bUpdate |
d |
DOUBLE - 8 bytes floating point |
dReading |
dw |
DWORD - double word (unsigned 32-bit) |
dwTimeout |
hwnd |
Window handle (32-bit integer). |
hwndPanel |
l |
LONG (signed 32-bit) |
lBits |
n |
SHORT - (signed 16-bit) |
nMode |
p |
Pointer. Usually used to return a value. Prefix this before the simple type. |
pnStatus |
sz |
Null - (zero value character) terminated string |
szMsg |
uc |
BYTE - (8 bits) unsigned. |
ucValue |
w |
WORD - Unsigned short (unsigned 16-bit) |
wParam |
Parameter Name Prefixes