RFID API Documentation  1.0
Reference guide for RFID API
Capabilities

Functions

RFID_STATUS WINAPI RFID_GetDllVersionInfoW (LPVERSION_INFO lpVersionInfo)
 This function gets the version information of the RFIDAPI3 C-Dll. More...
 
RFID_STATUS WINAPI RFID_GetDllVersionInfoA (LPVERSION_INFOA lpVersionInfo)
 
RFID_STATUS WINAPI RFID_GetReaderCapsW (RFID_HANDLE32 readerHandle, LPREADER_CAPSW lpReaderCaps)
 This function gets the Reader Capabilities. More...
 
RFID_STATUS WINAPI RFID_GetReaderCapsA (RFID_HANDLE32 readerHandle, LPREADER_CAPSA lpReaderCaps)
 
RFID_STATUS WINAPI RFID_GetSledBatteryStatus (RFID_HANDLE32 readerHandle, LPSLED_BATTERY_STATUS lpSledBatteryStatus)
 This function gets the battery status of the RFID Sled battery. More...
 

Detailed Description

Function Documentation

◆ RFID_GetDllVersionInfoW()

RFID_STATUS WINAPI RFID_GetDllVersionInfoW ( LPVERSION_INFO  lpVersionInfo)

This function gets the version information of the RFIDAPI3 C-Dll.

Parameters
[out]lpVersionInfo
Pointer to the structure VERSION_INFO.
Returns
If the function succeeds the return value is RFID_API_SUCCESS. If the function fails the return value is one of the following:
  • RFID_API_INVALID_HANDLE Invalid handle is provided
  • RFID_API_PARAM_ERROR Invalid parameter given
Remarks
See also
Remarks
Example: See

◆ RFID_GetDllVersionInfoA()

RFID_STATUS WINAPI RFID_GetDllVersionInfoA ( LPVERSION_INFOA  lpVersionInfo)

◆ RFID_GetReaderCapsW()

RFID_STATUS WINAPI RFID_GetReaderCapsW ( RFID_HANDLE32  readerHandle,
LPREADER_CAPSW  lpReaderCaps 
)

This function gets the Reader Capabilities.

Parameters
[in]readerHandle
Handle to the RFID device.
[out]lpReaderCaps
Pointer to READER_CAPS.
Returns
If the function succeeds the return value is RFID_API_SUCCESS. If the function fails the return value is one of the following:
  • RFID_API_INVALID_HANDLE Invalid handle is provided
  • RFID_API_PARAM_ERROR Invalid parameter given
Remarks
See also
Remarks
Example: See

◆ RFID_GetReaderCapsA()

RFID_STATUS WINAPI RFID_GetReaderCapsA ( RFID_HANDLE32  readerHandle,
LPREADER_CAPSA  lpReaderCaps 
)

◆ RFID_GetSledBatteryStatus()

RFID_STATUS WINAPI RFID_GetSledBatteryStatus ( RFID_HANDLE32  readerHandle,
LPSLED_BATTERY_STATUS  lpSledBatteryStatus 
)

This function gets the battery status of the RFID Sled battery.

Parameters
[in]readerHandle
Handle returned by RFID_Connect.
[out]lpSledBatteryStatus
Sled battery status structure .
Returns
If the function succeeds the return value is RFID_API_SUCCESS. If the function fails the return value is one of the following:
  • RFID_API_INVALID_HANDLE Handle provided is invalid
  • RFID_READER_FUNCTION_UNSUPPORTED Unsupported on host-based readers like XR and FX
Remarks
This function is used, to get the battery related status of the RFID Sled battery in the Hand held device with sled.
See also
Remarks
Example:
RFID_GetAntennaConfig
RFID_STATUS WINAPI RFID_GetAntennaConfig(RFID_HANDLE32 readerHandle, UINT16 antennaID, UINT16 *pReceiveSensitivityIndex, UINT16 *pTransmitPowerIndex, UINT16 *pTransmitFrequencyIndex)
This function gets the antenna configuration from the reader.
Definition: rfidapi.cpp:1160
RFID_Connect
#define RFID_Connect
Definition: rfidapi.h:51