Programmer's Guide

RaDeKL Radar API Programmer’s Guide 5
© Multispectral Solutions, Inc. 2006
Part II: Status Formatting Functions
RaDeKL_GetStatusText
Get the text associated with a status code. Most functions in this API return a numeric status code.
RaDeKL_OK (0) indicates successful completion. Other codes (see below) indicate error conditions.
Format:
char *RaDeKL_GetStatusText (ULONG ftStatus);
Parameters:
ftStatus Numeric status code as returned by most RaDeKL API functions.
Return Value:
Pointer to a null-terminated character string containing the status description.
Possible Status Codes:
Symbol Value Description Text
FTDI specific status codes
RaDeKL_OK 0 Operation completed successfully
RaDeKL_INVALID_HANDLE 1 Invalid handle passed to function
RaDeKL_DEVICE_NOT_FOUND 2 Requested device not found
RaDeKL_DEVICE_NOT_OPENED 3 Specified device not open
RaDeKL_IO_ERROR 4 Input/output error
RaDeKL_INSUFFICIENT_RESOURCES 5 Insufficient resources to complete operation
RaDeKL_INVALID_PARAMETER 6 Invalid parameter passed to function
RaDeKL_INVALID_BAUD_RATE 7 Invalid baud rate specified
RaDeKL_DEVICE_NOT_OPENED_FOR_ERASE 8 Specified device not open for erase
RaDeKL_DEVICE_NOT_OPENED_FOR_WRITE 9 Specified device not open for write
RaDeKL_FAILED_TO_WRITE_DEVICE 10 Failed to write to specified device
RaDeKL_EEPROM_READ_FAILED 11 EEPROM read failed
RaDeKL_EEPROM_WRITE_FAILED 12 EEPROM write failed
RaDeKL_EEPROM_ERASE_FAILED 13 EEPROM erase failed
RaDeKL_EEPROM_NOT_PRESENT 14 EEPROM not present
RaDeKL_EEPROM_NOT_PROGRAMMED 15 EEPROM not programmed
RaDeKL_INVALID_ARGS 16 Invalid arguments passed to function
RaDeKL_NOT_SUPPORTED 17 Operation not supported
RaDeKL_OTHER_ERROR 18 USB unknown error
RaDeKL API specific status codes
RaDeKL_READ_TIMEOUT 201 Read from radar has timed out
RaDeKL_WRITE_TIMEOUT 202 Write to radar has timed out
RaDeKL_INCORRECT_SERIAL_NUMBER 203 Serial number opened does not match request
RaDeKL_WRITE_REGISTER_FAILED 204 Register write failed
RaDeKL_READ_REGISTER_FAILED 205 Register read failed
RaDeKL_READ_DETECTION_FAILED 206 Detection data read failed
RaDeKL_BAD_THRESHOLD 207 Invalid threshold(s) specified
RaDeKL_BAD_TX_ATTEN 208 Invalid transmit attenuation specified
RaDeKL_BAD_RX_ATTEN 209 Invalid receive attenuation specified
RaDeKL_BAD_RANGE_DELAY 210 Invalid range delay specified
RaDeKL_BAD_INTERVAL 211 Invalid interval specified
RaDeKL_UNKNOWN_RESOLUTION 212 Radar has an unknown resolution