 |
RFID API Documentation
1.0
Reference guide for RFID API
|
◆ RFID_PerformTagLocationing()
This function performs the Tag locationing operation.
- Parameters
-
| [in] | readerHandle |
Handle to the RFID device. |
| [in] | pTagID |
Tag locationing operation will be performed on Tag with mentioned TagID. |
| [in] | tagIDLength |
Tag Length. |
| [in] | lpAntennaInfo |
Antenna List on which the Tag locationing operation is to be performed. |
| [in] | rsvd | Reserved for future use. |
| [in] | rsvd1 | Reserved for future use. |
- 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_API_PARAM_ERROR Invalid parameter given
- RFID_API_PARAM_OUT_OF_RANGE Parameter out of range [Antenna ID/GPI]
- RFID_INVENTORY_IN_PROGRESS Inventory in progress, cannot perform requested operation
- RFID_ACCESS_IN_PROGRESS Access Operation in progress, cannot perform requested operation
- RFID_TAG_LOCATING_IN_PROGRESS Tag Locating in progress, cannot perform requested operation
- RFID_NXP_EAS_SCAN_IN_PROGRESS NXP EAS SCAN in progress, cannot perform requested operation
- See also
- RFID_StopTagLocationing
◆ RFID_StopTagLocationing()
This function stops the Tag Locationing operation.
- Parameters
-
| [in] | readerHandle | Handle to the RFID device. |
- 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_NO_TAG_LOCATING_IN_PROGRESS There is no Tag locationing operation in progress
- See also
- RFID_PerformTagLocationing
LPLOCATION_INFO lpLocation
location information.
Definition: rfidapiStructs.h:962
#define RFID_GetReaderCaps
Definition: rfidapi.h:88
RFID_STATUS WINAPI RFID_DeallocateTag(RFID_HANDLE32 readerHandle, TAG_DATA *pTagData)
This function de-allocates the TAG_DATA structure previously created using RFID_AllocateTag.
Definition: rfidapi.cpp:3537
RFID_STATUS WINAPI RFID_StopTagLocationing(RFID_HANDLE32 readerHandle)
This function stops the Tag Locationing operation.
Definition: rfidapi.cpp:6770
Provides information on Reader Capabilities as reported by the Reader.
Definition: rfidapiStructs.h:531
RFID_STATUS WINAPI RFID_Disconnect(RFID_HANDLE32 readerHandle)
This function closes connection to the Reader.
Definition: rfidapi.cpp:1061
UINT32 length
Number of elements in array pAntennaList .
Definition: rfidapiStructs.h:82
void * RFID_HANDLE32
Definition: rfidapiTypes.h:76
unsigned char UINT8
Definition: rfidapiTypes.h:26
Contains Antenna Information to be used for Inventory or Access Operations.
Definition: rfidapiStructs.h:79
@ RFID_API_SUCCESS
Definition: rfidapiErrors.h:27
unsigned int UINT32
Definition: rfidapiTypes.h:30
OPERATION_QUALIFIER * pAntennaOpList
Definition: rfidapiStructs.h:84
Contains Tag related information.
Definition: rfidapiStructs.h:920
#define RFID_Connect
Definition: rfidapi.h:51
RFID_STATUS WINAPI RFID_PerformTagLocationing(RFID_HANDLE32 readerHandle, UINT8 *pTagID, UINT32 tagIDLength, LPANTENNA_INFO lpAntennaInfo, LPVOID rsvd, LPVOID rsvd1)
This function performs the Tag locationing operation.
Definition: rfidapi.cpp:6715
BOOLEAN tagLocationingSupported
Indicates the reader’s ability to locate a tag.
Definition: rfidapiStructs.h:583
unsigned short UINT16
Definition: rfidapiTypes.h:28
RFID_STATUS
Definition: rfidapiErrors.h:26
INT16 relativeDistance
Locationing result when using LOCATE_TAG mechanism.
Definition: rfidapiStructs.h:101
LPTAG_DATA WINAPI RFID_AllocateTag(RFID_HANDLE32 readerHandle)
This function allocates and initializes the TAG_DATA structure for the application.
Definition: rfidapi.cpp:3438
RFID_STATUS WINAPI RFID_GetReadTag(RFID_HANDLE32 readerHandle, LPTAG_DATA lpTagData)
This function returns a Tag if available.
Definition: rfidapi.cpp:3651
UINT16 * pAntennaList
Array for holding the Antennas to be used for the operation: Range: 1 - N (N = Max.
Definition: rfidapiStructs.h:80