CompuScope SDK Manua.. - Egmont Instruments

gage_get_records
Syntax
C:
int16 GAGEAPI gage_get_records (uInt16 far *records, int16 record, uInt16 far *segment,
uInt16 far *index, uInt16 far *typename, uInt16 far *status);
Visual BASIC:
Function gage_get_records (records As Integer, ByVal record As Integer, segment As Integer,
index As Integer, typename As Integer, status As Integer) As Integer
Remarks
gage_get_records can be used to read the gage_board_location array. The array must be allocated by the
calling program. The array is initialized by using a call to either gage_set_records or
gage_read_config_file.
The record parameter is the board number of the record to be read, beginning with 0.
The segment, index, typename and status parameters are the values in the gage_board_location array for
that particular board.
segment and index are the values that were set by the GSINST.EXE or GAGECFG.EXE configuration
program.
The typename and status parameters return the board type and the initialization status of the board as one
of the predefined constants (GAGE_ASSUME_XXXXX, where XXXXX is a board type, etc.) declared in
the file GAGE_DRV.H.
The status parameter will hold any errors that occurred during board initialization.
Return Value
The return value is one if the record parameter is in the range (0 to GAGE_B_L_MAX_CARDS - 1) and
zero otherwise. If the return value is one, the segment, index, typename and status parameters will
contain valid values for the specified record.
See also
gage_set_records, gage_driver_initialize and gage_read_config_file
Examples
C:
gage_get_records ((uInt16 far *)gage_board_location), 0, (uInt16 far *)(&segment),
(uInt16 far *)(&index), (uInt16 far *)(&typename), (uInt16 far *)(status));
Note: the typecasts may not be necessary, depending on the memory model used.
Visual BASIC:
ret = gage_get_records (gage_board_location (0), 0, segment, index, typename, status)
CompuScope API Reference Manual 66