The GX6315 driver functions is organized in alphabetical order. Each function description contains the function name, purpose, syntax, a short description, parameters and types, comments, an example (written in C), and a "See Also" section.
All function parameters syntax 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 is returned by the Gx6315Initialize or the Gx6315InitializeVisa functions. The nHandle is used to identify the board when calling a function for programming and controlling the operation of that board.
All functions have last parameter named pnStatus that returns a value indicating the status of the called function. The pnStatus is zero if the function was successful or a number different from zero if an error occurred. See GxSWGetErrorString functions for more information regarding the available error numbers and their description. In addition, the provided C header file contains predefined constants for each one of the errors listed.
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. 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 Name Prefixes