These are the functions most applications will use. They perform useful tasks such as retrieving and updating user records through one function call. They also handle memory management for RSI_RESPONSE members.
rsiGetUserRecord
RSI_RESULT rsiGetUserRecord (RSI_CHANNEL chnl, RSI_ID id, RSI_USER_RECORD FAR* ur);
RSI_CHANNEL chnl
The handle returned by rsiInstallChannel.
RSI_ID id
The ID of the user to retrieve.
RSI_USER_RECORD FAR* ur
A pointer to the structure for the user record.
Retrieves a user record from the hand reader.
RSI_SUCCESS if successful.
Any error value returned by rsiSendUserRecord, rsiGetResponse, and/or rsiParseResponse if unsuccessful.
Returns value other than RSI_SUCCESS only if there is a communication problem.
If the record given by "id" does
not exist, then the reader sends a record with all-zero User ID field.
rsiGetLastUserRecord
RSI_RESULT rsiGetLastUserRecord (RSI_CHANNEL chnl, RSI_USER_RECORD FAR* ur);
Chapter
6
P R O T O T Y P E
A R G U M E N T S
D E S C R I P T I O N R E T U R N S
P R O T O T Y P E
RSI_CHANNEL chnl
The handle returned by rsiInstallChannel.
RSI_USER_RECORD FAR* ur
A pointer to the structure for the user record.
Retrieves the user record for the most recent hand reading.
RSI_SUCCESS if successful.
Any error value returned by rsiSendLastUserRecord, rsiGetResponse, and/or rsiParseResponse if unsuccessful.
rsiGetStatus
RSI_RESULT rsiGetStatus (RSI_CHANNEL chnl, RSI_STATUS FAR* status);
RSI_CHANNEL chnl
The handle returned by rsiInstallChannel.
RSI_STATUS FAR* status
A pointer to the structure for the status.
Retrieves the status of the hand reader.
RSI_SUCCESS if successful.
Any error value returned by rsiSendStatusCRC, rsiGetResponse, and/or rsiParseResponse if unsuccessful.
rsiSetBellSchedule
RSI_RESULT rsiSetBellSchedule (RSI_CHANNEL chnl, RSI_BELL_SCHEDULE FAR* schedule);
RSI_CHANNEL chnl
The handle returned by rsiInstallChannel.
RSI_BELL SCHEDULE FAR* schedule
A pointer to the structure with the bell schedule for the hand reader.
Sets the bell schedule for the hand reader.
RSI_SUCCESS if successful.
Any error value returned by rsiNextMessageIsBellScheduleTable, and/or rsiHereIsBellScheduleTable if unsuccessful.
rsiSetTimeZoneTable
RSI_RESULT rsiSetTimeZoneTable (RSI_CHANNEL chnl, RSI_TIME_ZONE_TABLE FAR* tz);
RSI_CHANNEL chnl
The handle returned by rsiInstallChannel.
RSI_TIME_ZONE_TABLE FAR* tz
A pointer to the structure with the time zone table for the reader.
Sets the time zone table for the hand reader.
RSI_SUCCESS if successful.
Any error value returned by rsiNextMessageIsTimeZone, and/or rsiHereAreTimeZones if unsuccessful.
rsiGetSetupData
RSI_RESULT rsiGetSetupData (RSI_CHANNEL chnl, RSI_SETUP_DATA FAR* setup);
RSI_CHANNEL chnl
The handle returned by rsiInstallChannel.
RSI_SETUP_DATA FAR* setup
A pointer to the structure for the setup data.
Retrieves the current setup data for the hand reader.
RSI_SUCCESS if successful.
Any error value returned by rsiSendSetupData, rsiGetResponse, and/or rsiParseResponse if unsuccessful.
rsiGetDataLogElement
RSI_RESULT rsiGetDataLogElement (RSI_CHANNEL chnl, RSI_DATA_LOG_ELEMENT FAR* dl, BOOL bPrev);
P R O T O T Y P E
A R G U M E N T S
D E S C R I P T I O N R E T U R N S
P R O T O T Y P E
A R G U M E N T S
D E S C R I P T I O N R E T U R N S
P R O T O T Y P E
RSI_CHANNEL chnl
The handle returned by rsiInstallChannel.
RSI_DATA_LOG_ELEMENT FAR* dl
A pointer to the structure for the data log.
BOOL bPrev
TRUE to retrieve the previous data log or FALSE to retrieve the next data log.
Retrieves a data log element from the hand reader.
RSI_SUCCESS if successful.
Any error value returned by rsiSendDataLog, rsiSendPreviousDataLog, rsiGetResponse, and/or rsiParseResponse if unsuccessful.
rsiGetCalibrationData
RSI_RESULT rsiGetCalibrationData (RSI_CHANNEL chnl, RSI_CALIBRATION_DATA FAR* calib);
RSI_CHANNEL chnl
The handle returned by rsiInstallChannel.
RSI_CALIBRATION_DATA FAR* calib
A pointer to the structure for the calibration data.
Retrieves the calibration data for the hand reader.
RSI_SUCCESS if successful.
Any error value returned by rsiSendCalibrationData, rsiGetResponse, and/or rsiParseResponse if unsuccessful.
rsiGetLastTemplate
RSI_RESULT rsiGetLastTemplate (RSI_CHANNEL chnl, RSI_LAST_TEMPLATE FAR* tmpl);
RSI_CHANNEL chnl
The handle returned by rsiInstallChannel.
RSI_LAST_TEMPLATE FAR* tmpl
A R G U M E N T S
D E S C R I P T I O N R E T U R N S
P R O T O T Y P E
A R G U M E N T S
D E S C R I P T I O N R E T U R N S
P R O T O T Y P E
A R G U M E N T S
A pointer to the structure for the last template and score.
Retrieves the template vector and score for the most recent hand reading.
(But ignore score immediately after an enrollment.) RSI_SUCCESS if successful.
Any error value returned by rsiSendTemplate, rsiGetResponse, and/or rsiParseResponse if unsuccessful.
rsiGetResults
RSI_RESULT rsiGetResults (RSI_CHANNEL chnl, RSI_RESULTS FAR* results);
RSI_CHANNEL chnl
The handle returned by rsiInstallChannel.
RSI_RESULTS FAR* results
A pointer to the structure for the results.
Retrieves the results for the most recent hand reading.
RSI_SUCCESS if successful.
Any error value returned by rsiSendResults, rsiGetResponse, and/or rsiParseResponse if unsuccessful.
rsiGetDataBank
RSI_RESULT rsiGetDataBank (RSI_CHANNEL chnl, RSI_BANK_NUMBER bnk, RSI_DATA_BANK FAR* dbnk);
RSI_CHANNEL chnl
The handle returned by rsiInstallChannel.
RSI_BANK_NUMBER bnk
Number of the data bank to retrieve.
RSI_DATA_BANK_FAR* dbnk
A pointer to the structure for the data bank.
Retrieves a data bank from the hand reader
D E S C R I P T I O N
R E T U R N S
P R O T O T Y P E
A R G U M E N T S
D E S C R I P T I O N R E T U R N S
P R O T O T Y P E
A R G U M E N T S
D E S C R I P T I O N
RSI_SUCCESS if successful.
Any error value returned by rsiEnterIdleMode, rsiSendDataBank, rsiGetResponse, and/or rsiParseResponse if unsuccessful.
rsiSetDataBank
RSI_RESULT rsiSetDataBank (RSI_CHANNEL chnl, RSI_BANK_NUMBER bnk, RSI_DATA_BANK FAR* dbnk);
RSI_CHANNEL chnl
The handle returned by rsiInstallChannel.
RSI_BANK_NUMBER bnk
Number of the data bank to set.
RSI_DATA_BANK_FAR* dbnk
A pointer to the structure with the data bank to set.
Sets a data bank in the hand reader.
RSI_SUCCESS if successful.
Any error value returned by rsiEnterIdleMode, rsiHereIsBankNumber, and/or rsiHereIsDataBank if unsuccessful.
R E T U R N S
P R O T O T Y P E
A R G U M E N T S
D E S C R I P T I O N R E T U R N S