RFID API Documentation  1.0
Reference guide for RFID API
rfidapiErrors.h File Reference

Error codes More...

Go to the source code of this file.

Enumerations

enum  RFID_STATUS {
  RFID_API_SUCCESS = 0, RFID_API_COMMAND_TIMEOUT = 1, RFID_API_PARAM_ERROR = 2, RFID_API_PARAM_OUT_OF_RANGE = 3,
  RFID_API_CANNOT_ALLOC_MEM = 4, RFID_API_UNKNOWN_ERROR = 5, RFID_API_INVALID_HANDLE = 6, RFID_API_BUFFER_TOO_SMALL = 7,
  RFID_READER_FUNCTION_UNSUPPORTED = 8, RFID_RECONNECT_FAILED = 9, RFID_API_DATA_NOT_INITIALISED = 10, RFID_API_ZONE_ID_ALREADY_EXITS = 11,
  RFID_API_ZONE_ID_NOT_FOUND = 12, RFID_COMM_OPEN_ERROR = 100, RFID_COMM_CONNECTION_ALREADY_EXISTS = 101, RFID_COMM_RESOLVE_ERROR = 102,
  RFID_COMM_SEND_ERROR = 103, RFID_COMM_RECV_ERROR = 104, RFID_COMM_NO_CONNECTION = 105, RFID_INVALID_SOCKET = 106,
  RFID_READER_REGION_NOT_CONFIGURED = 107, RFID_READER_REINITIALIZING = 108, RFID_SECURE_CONNECTION_ERROR = 109, RFID_ROOT_SECURITY_CERTIFICATE_ERROR = 110,
  RFID_HOST_SECURITY_CERTIFICATE_ERROR = 111, RFID_HOST_SECURITY_KEY_ERROR = 112, RFID_CONFIG_GET_FAILED = 200, RFID_CONFIG_SET_FAILED = 201,
  RFID_CAP_NOT_SUPPORTED = 300, RFID_CAP_GET_FAILED = 301, RFID_FILTER_NO_FILTER = 400, RFID_FILTER_INVALID_INDEX = 401,
  RFID_FILTER_MAX_FILTERS_EXCEEDED = 402, RFID_NO_READ_TAGS = 403, RFID_NO_REPORTED_EVENTS = 404, RFID_INVENTORY_MAX_TAGS_EXCEEDED = 405,
  RFID_INVENTORY_IN_PROGRESS = 406, RFID_NO_INVENTORY_IN_PROGRESS = 407, RFID_TAG_LOCATING_IN_PROGRESS = 420, RFID_NO_TAG_LOCATING_IN_PROGRESS = 421,
  RFID_NXP_EAS_SCAN_IN_PROGRESS = 422, RFID_NO_NXP_EAS_SCAN_IN_PROGRESS = 423, RFID_ACCESS_IN_PROGRESS = 500, RFID_NO_ACCESS_IN_PROGRESS = 501,
  RFID_ACCESS_TAG_READ_FAILED = 502, RFID_ACCESS_TAG_WRITE_FAILED = 503, RFID_ACCESS_TAG_LOCK_FAILED = 504, RFID_ACCESS_TAG_KILL_FAILED = 505,
  RFID_ACCESS_TAG_BLOCK_ERASE_FAILED = 506, RFID_ACCESS_TAG_BLOCK_WRITE_FAILED = 507, RFID_ACCESS_TAG_NOT_FOUND = 508, RFID_ACCESS_SEQUENCE_NOT_INITIALIZED = 510,
  RFID_ACCESS_SEQUENCE_EMPTY = 511, RFID_ACCESS_SEQUENCE_IN_USE = 512, RFID_ACCESS_SEQUENCE_MAX_OP_EXCEEDED = 513, RFID_ACCESS_TAG_RECOMMISSION_FAILED = 514,
  RFID_ACCESS_TAG_BLOCK_PERMALOCK_FAILED = 515, RFID_ACCESS_NXP_TAG_SET_EAS_FAILED = 516, RFID_ACCESS_NXP_TAG_READ_PROTECT_FAILED = 517, RFID_ACCESS_FUJITSU_CHANGE_WORDLOCK_FAILED = 518,
  RFID_ACCESS_FUJITSU_CHANGE_BLOCKLOCK_FAILED = 519, RFID_ACCESS_FUJITSU_READ_BLOCKLOCK_FAILED = 520, RFID_ACCESS_FUJITSU_BURST_WRITE_FAILED = 521, RFID_ACCESS_FUJITSU_BURST_ERASE_FAILED = 522,
  RFID_ACCESS_FUJITSU_CHANGE_BLOCK_OR_AREA_GROUPPASSWORD_FAILED = 523, RFID_ACCESS_FUJITSU_AREA_READLOCK_FAILED = 524, RFID_ACCESS_FUJITSU_AREA_WRITELOCK_FAILED = 525, RFID_ACCESS_FUJITSU_AREA_WRITELOCK_WOPASSWORD_FAILED = 526,
  RFID_ACCESS_NXP_CHANGE_CONFIG_FAILED = 527, RFID_ACCESS_IMPINJ_QT_READ_FAILED = 528, RFID_ACCESS_IMPINJ_QT_WRITE_FAILED = 529, RFID_RM_INVALID_USERNAME_PASSWORD = 601,
  RFID_RM_NO_UPDATION_IN_PROGRESS = 602, RFID_RM_UPDATION_IN_PROGRESS = 603, RFID_RM_COMMAND_FAILED = 604, RFID_NXP_BRANDID_CHECK_IN_PROGRESS = 605,
  RFID_NO_RF_SURVEY_OPERATION_IN_PROGRESS = 701, RFID_RFSURVEY_IN_PROGRESS =702, RFID_NO_COM_PORT_AVAILABLE = 703, RFID_GPIO_PORT_DISABLED = 704,
  RFID_COMM_START_ERROR = 705, RFID_COMM_STOP_ERROR = 706, RFID_INVALID_ERROR_CODE = 720
}
 
enum  ACCESS_OPERATION_STATUS {
  ACCESS_SUCCESS = 0, ACCESS_TAG_NON_SPECIFIC_ERROR = 1, ACCESS_READER_NON_SPECIFIC_ERROR = 2, ACCESS_NO_RESPONSE_FROM_TAG = 3,
  ACCESS_INSUFFIFICENT_POWER = 4, ACCESS_INSUFFICENT_POWER = 4, ACCESS_TAG_MEMORY_LOCKED_ERROR = 5, ACCESS_TAG_MEMORY_OVERRUN_ERROR = 6,
  ACCESS_ZERO_KILL_PASSWORD_ERROR = 7, ACCESS_TAG_ACCESS_PASSWORD_ERROR = 8
}
 

Detailed Description

Error codes

Enumeration Type Documentation

◆ RFID_STATUS

Enumerator
RFID_API_SUCCESS 

Function succeeded

RFID_API_COMMAND_TIMEOUT 

Command timeout

RFID_API_PARAM_ERROR 

Invalid parameter given

RFID_API_PARAM_OUT_OF_RANGE 

Parameter out of range

RFID_API_CANNOT_ALLOC_MEM 

Cannot allocate memory

RFID_API_UNKNOWN_ERROR 

Unable to determine error

RFID_API_INVALID_HANDLE 

Invalid Handle is provided

RFID_API_BUFFER_TOO_SMALL 

Assigned memory buffer is small

RFID_READER_FUNCTION_UNSUPPORTED 

Functionality Not Supported by Reader

RFID_RECONNECT_FAILED 

Unable to Reconnect to reader. The Reader state might have changed. Attempt Connect API instead of Reconnect API.

RFID_API_DATA_NOT_INITIALISED 

DATA should be initalised before using the structure

RFID_API_ZONE_ID_ALREADY_EXITS 

Zone ID already exists

RFID_API_ZONE_ID_NOT_FOUND 

Zone ID not found

RFID_COMM_OPEN_ERROR 

Unable to open connection to the reader

RFID_COMM_CONNECTION_ALREADY_EXISTS 

Connection Already exists

RFID_COMM_RESOLVE_ERROR 

Unable to resolve IP or Host Name

RFID_COMM_SEND_ERROR 

Error writing to transport interface

RFID_COMM_RECV_ERROR 

Error reading from transport interface

RFID_COMM_NO_CONNECTION 

No Connection exists to the Host

RFID_INVALID_SOCKET 

Invalid Socket Handle passed

RFID_READER_REGION_NOT_CONFIGURED 

Region of the Reader is not configured

RFID_READER_REINITIALIZING 

Reader is reinitializing after a Firmware/OEM update

RFID_SECURE_CONNECTION_ERROR 

Secure connection error. Process connStatus in SEC_CONNECTION_INFO for additional info

RFID_ROOT_SECURITY_CERTIFICATE_ERROR 

Root CA Security certificate missing or invalid

RFID_HOST_SECURITY_CERTIFICATE_ERROR 

Host Security certificate missing or invalid

RFID_HOST_SECURITY_KEY_ERROR 

Host private key missing or invalid

RFID_CONFIG_GET_FAILED 

Unable to get the configuration

RFID_CONFIG_SET_FAILED 

Unable to set the configuration

RFID_CAP_NOT_SUPPORTED 

The specified capability is not supported

RFID_CAP_GET_FAILED 

Unable to get the capability

RFID_FILTER_NO_FILTER 

No Filter criteria specified

RFID_FILTER_INVALID_INDEX 

Invalid index specified

RFID_FILTER_MAX_FILTERS_EXCEEDED 

Reached limit for maximum number of filters that can be added

RFID_NO_READ_TAGS 

No read Tags

RFID_NO_REPORTED_EVENTS 

No Events have been reported from the Reader

RFID_INVENTORY_MAX_TAGS_EXCEEDED 

Tag List is full, tag cannot be stored

RFID_INVENTORY_IN_PROGRESS 

Inventory in progress, cannot perform requested operation

RFID_NO_INVENTORY_IN_PROGRESS 

There is no Inventory in progress

RFID_TAG_LOCATING_IN_PROGRESS 

Tag Locating in progress, cannot perform requested operation

RFID_NO_TAG_LOCATING_IN_PROGRESS 

There is no Tag locating operation in progress

RFID_NXP_EAS_SCAN_IN_PROGRESS 

NXP EAS SCAN Operation in progress, cannot perform requested operation

RFID_NO_NXP_EAS_SCAN_IN_PROGRESS 

There is no NXP EAS SCAN operation in progress

RFID_ACCESS_IN_PROGRESS 

Access Operation in progress, cannot perform requested operation

RFID_NO_ACCESS_IN_PROGRESS 

There is no Access operation in progress

RFID_ACCESS_TAG_READ_FAILED 

Tag read failed

RFID_ACCESS_TAG_WRITE_FAILED 

Tag write failed

RFID_ACCESS_TAG_LOCK_FAILED 

Tag Lock failed

RFID_ACCESS_TAG_KILL_FAILED 

Tag Kill failed

RFID_ACCESS_TAG_BLOCK_ERASE_FAILED 

Tag Block Erase failed

RFID_ACCESS_TAG_BLOCK_WRITE_FAILED 

Tag Block Write failed

RFID_ACCESS_TAG_NOT_FOUND 

Tag(s) not found in the field which matches the set Filter(s)

RFID_ACCESS_SEQUENCE_NOT_INITIALIZED 

Access Sequence is not initialized

RFID_ACCESS_SEQUENCE_EMPTY 

Access Sequence is Empty

RFID_ACCESS_SEQUENCE_IN_USE 

Access Sequence is already in use

RFID_ACCESS_SEQUENCE_MAX_OP_EXCEEDED 

Reached limit for maximum number of operations that can be added into Access-Sequence

RFID_ACCESS_TAG_RECOMMISSION_FAILED 

Tag Recommission failed

RFID_ACCESS_TAG_BLOCK_PERMALOCK_FAILED 

Tag Block Permalock failed

RFID_ACCESS_NXP_TAG_SET_EAS_FAILED 

Tag Set EAS failed

RFID_ACCESS_NXP_TAG_READ_PROTECT_FAILED 

Tag ReadProtect failed

RFID_ACCESS_FUJITSU_CHANGE_WORDLOCK_FAILED 

Tag Change WordLock failed

RFID_ACCESS_FUJITSU_CHANGE_BLOCKLOCK_FAILED 

Tag Change BlockLock failed

RFID_ACCESS_FUJITSU_READ_BLOCKLOCK_FAILED 

Tag Read BlockLock failed

RFID_ACCESS_FUJITSU_BURST_WRITE_FAILED 

Tag Burst Write failed

RFID_ACCESS_FUJITSU_BURST_ERASE_FAILED 

Tag Burst Erase failed

RFID_ACCESS_FUJITSU_CHANGE_BLOCK_OR_AREA_GROUPPASSWORD_FAILED 

Tag Change BlockOrAreaGroup Passowrd failed

RFID_ACCESS_FUJITSU_AREA_READLOCK_FAILED 

Tag Area ReadLock failed

RFID_ACCESS_FUJITSU_AREA_WRITELOCK_FAILED 

Tag Area WriteLock failed

RFID_ACCESS_FUJITSU_AREA_WRITELOCK_WOPASSWORD_FAILED 

Tag Area WriteLockWOPassword failed

RFID_ACCESS_NXP_CHANGE_CONFIG_FAILED 

NXP Change Config failed

RFID_ACCESS_IMPINJ_QT_READ_FAILED 

Impinj QT Read failed

RFID_ACCESS_IMPINJ_QT_WRITE_FAILED 

Impinj QT Write failed

RFID_RM_INVALID_USERNAME_PASSWORD 

Invalid Username or password

RFID_RM_NO_UPDATION_IN_PROGRESS 

No Updation going on at present

RFID_RM_UPDATION_IN_PROGRESS 

Updation already in progress

RFID_RM_COMMAND_FAILED 

RM Command processing failed

RFID_NXP_BRANDID_CHECK_IN_PROGRESS 

BrandID Checking Inprogress

RFID_NO_RF_SURVEY_OPERATION_IN_PROGRESS 

There is no RF Survey in progress

RFID_RFSURVEY_IN_PROGRESS 

There is RF Survey in progress

RFID_NO_COM_PORT_AVAILABLE 

Readers are not connected to any COM Ports

RFID_GPIO_PORT_DISABLED 

GPIO port is disabled

RFID_COMM_START_ERROR 

Radio start error or unable to communicate with the host

RFID_COMM_STOP_ERROR 

Radio stop error or unable to communicate with the host

RFID_INVALID_ERROR_CODE 

Invalid Error-Code

◆ ACCESS_OPERATION_STATUS

Enumerator
ACCESS_SUCCESS 

Tag Operation succeeded

ACCESS_TAG_NON_SPECIFIC_ERROR 

Non-Specific Tag Error

ACCESS_READER_NON_SPECIFIC_ERROR 

Non-Specific Reader Error

ACCESS_NO_RESPONSE_FROM_TAG 

No response from Tag

ACCESS_INSUFFIFICENT_POWER 

Operation Failed due to insufficient Power

ACCESS_INSUFFICENT_POWER 

Operation Failed due to insufficient Power

ACCESS_TAG_MEMORY_LOCKED_ERROR 

Operation Failed as Tag memory was locked

ACCESS_TAG_MEMORY_OVERRUN_ERROR 

Operation Failed due to memory overrun

ACCESS_ZERO_KILL_PASSWORD_ERROR 

Operation Failed as Kill password provided was zero

ACCESS_TAG_ACCESS_PASSWORD_ERROR 

Operation failed due to wrong access password