Access

Functions
RFID_STATUS WINAPI	RFID_Read (RFID_HANDLE32 readerHandle, UINT8 *pTagID, UINT32 tagIDLength, LPREAD_ACCESS_PARAMS lpReadAccessParams, LPACCESS_FILTER lpAccessFilter, LPANTENNA_INFO lpAntennaInfo, LPTAG_DATA lpTagData, LPVOID rsvd)
	This function reads a specified memory bank of tag(s). More...
RFID_STATUS WINAPI	RFID_Write (RFID_HANDLE32 readerHandle, UINT8 *pTagID, UINT32 tagIDLength, LPWRITE_ACCESS_PARAMS lpWriteAccessParams, LPACCESS_FILTER lpAccessFilter, LPANTENNA_INFO lpAntennaInfo, LPVOID rsvd)
	This function writes to a specified memory bank of tag(s). More...
RFID_STATUS WINAPI	RFID_WriteTagID (RFID_HANDLE32 readerHandle, UINT8 *pTagID, UINT32 tagIDLength, LPWRITE_SPECIFIC_FIELD_ACCESS_PARAMS lpWriteSpecificFieldAccessParams, LPANTENNA_INFO lpAntennaInfo, LPVOID rsvd)
	This function writes to TagID of a specific tag and adjusts the PC bits according to the length of the TagID. More...
RFID_STATUS WINAPI	RFID_WriteKillPassword (RFID_HANDLE32 readerHandle, UINT8 *pTagID, UINT32 tagIDLength, LPWRITE_SPECIFIC_FIELD_ACCESS_PARAMS lpWriteSpecificFieldAccessParams, LPANTENNA_INFO lpAntennaInfo, LPVOID rsvd)
	This function writes Kill password of a specific tag. More...
RFID_STATUS WINAPI	RFID_WriteAccessPassword (RFID_HANDLE32 readerHandle, UINT8 *pTagID, UINT32 tagIDLength, LPWRITE_SPECIFIC_FIELD_ACCESS_PARAMS lpWriteSpecificFieldAccessParams, LPANTENNA_INFO lpAntennaInfo, LPVOID rsvd)
	This function writes to access password of a specific tag. More...
RFID_STATUS WINAPI	RFID_Kill (RFID_HANDLE32 readerHandle, UINT8 *pTagID, UINT32 tagIDLength, LPKILL_ACCESS_PARAMS lpKillParams, LPACCESS_FILTER lpAccessFilter, LPANTENNA_INFO lpAntennaInfo, LPVOID rsvd)
	This function kills tag(s). More...
RFID_STATUS WINAPI	RFID_Lock (RFID_HANDLE32 readerHandle, UINT8 *pTagID, UINT32 tagIDLength, LPLOCK_ACCESS_PARAMS lpLockParams, LPACCESS_FILTER lpAccessFilter, LPANTENNA_INFO lpAntennaInfo, LPVOID rsvd)
	This function locks tag(s). More...
RFID_STATUS WINAPI	RFID_BlockWrite (RFID_HANDLE32 readerHandle, UINT8 *pTagID, UINT32 tagIDLength, LPWRITE_ACCESS_PARAMS lpWriteAccessParams, LPACCESS_FILTER lpAccessFilter, LPANTENNA_INFO lpAntennaInfo, LPVOID rsvd)
	This function allows to write multiple words in a Tag’s Reserved, EPC, TID, or User memory using a single command. More...
RFID_STATUS WINAPI	RFID_BlockErase (RFID_HANDLE32 readerHandle, UINT8 *pTagID, UINT32 tagIDLength, LPBLOCK_ERASE_ACCESS_PARAMS lpBlkEraseAccessParams, LPACCESS_FILTER lpAccessFilter, LPANTENNA_INFO lpAntennaInfo, LPVOID rsvd)
	This function erases tag(s). More...
RFID_STATUS WINAPI	RFID_BlockPermalock (RFID_HANDLE32 readerHandle, UINT8 *pTagID, UINT32 tagIDLength, LPBLOCK_PERMALOCK_ACCESS_PARAMS lpBlkPermalockAccessParams, LPACCESS_FILTER lpAccessFilter, LPANTENNA_INFO lpAntennaInfo, LPTAG_DATA lpTagData, LPVOID rsvd)
	This function allows to permalock multiple words in a Tag’s Reserved, EPC, TID, or User memory with a single command, or read the permalock satus of the memory blocks in a Tag's User memory. More...
RFID_STATUS WINAPI	RFID_Recommission (RFID_HANDLE32 readerHandle, UINT8 *pTagID, UINT32 tagIDLength, LPRECOMMISSION_ACCESS_PARAMS lpRecommissionParams, LPACCESS_FILTER lpAccessFilter, LPANTENNA_INFO lpAntennaInfo, LPVOID rsvd)
	This function is used for recommissioning tag(s). More...

Detailed Description

Function Documentation

RFID_Read()

RFID_STATUS WINAPI RFID_Read	(	RFID_HANDLE32	readerHandle,
		UINT8 *	pTagID,
		UINT32	tagIDLength,
		LPREAD_ACCESS_PARAMS	lpReadAccessParams,
		LPACCESS_FILTER	lpAccessFilter,
		LPANTENNA_INFO	lpAntennaInfo,
		LPTAG_DATA	lpTagData,
		LPVOID	rsvd
	)

This function reads a specified memory bank of tag(s).

Parameters

[in]	readerHandle	Handle to the RFID device
[in]	pTagID	Access-Operation will be performed on Tag with mentioned TagID. If this is NULL, lpAccessFilter will be considered as Filter Criteria for the Access operation.
[in]	tagIDLength	Tag Length(Ignored if pTagID is NULL)
[in]	lpReadAccessParams	Pointer to READ_ACCESS_PARAMS
[in]	lpAccessFilter	Filter Criteria for the Access operation. If this is NULL, there wont be any access filters used for the operation.
[in]	lpAntennaInfo	Antenna List on which the access operation is to be performed. If this is NULL, access is performed on ALL antennas.
[out]	lpTagData	Returns the Tag that was read if the API was called with a valid pTagID. If pTagID is NULL, tags reported from Reader can be fetched using RFID_GetReadTag or RFID_GetEventData optionally waiting for by waiting for the TAG_READ_EVENT.
[in]	rsvd	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 Parameter is invalid
• RFID_API_COMMAND_TIMEOUT Timeout and no responses from the reader
• RFID_COMM_NO_CONNECTION No Connection exists to the Host
• RFID_INVENTORY_IN_PROGRESS Inventory in progress, cannot perform requested operation
• RFID_ACCESS_IN_PROGRESS Access Operation in progress, cannot perform requested operation
• RFID_ACCESS_TAG_READ_FAILED Tag Read failed

Remarks

This function behaves synchronously when performing operation on single Tag i.e When specifying pTagID, the function waits for the operation to complete and returns with the result of the operation. If pTagID is NULL, the function behaves asynchronously and will return immediately. The completion of the operation will be signaled using ACCESS_STOP_EVENT, after which RFID_GetLastAccessResult can be called to know the result of the operation.

See also

RFID_Write, RFID_Kill, RFID_Lock, RFID_GetReadTag RFID_BlockWrite, RFID_BlockErase, RFID_GetLastAccessResult

Remarks

Example:

//Sample Code that prints TagID and Memory Bank
void printTagMemoryBankData(UINT8* pTagIDData, UINT32 tagIDLength,
UINT8* pMBData, UINT32 mbLength, char* memoryBankInfo)
{
char  MBBuffer[MAX_PATH] = {0, };
char  tagIDBuffer[MAX_PATH] = {0, };
char* pTagReportData = NULL;
 
pTagReportData = tagIDBuffer;
for(UINT32 index = 0; index < tagIDLength; index++)
{
if(0 < index && index%2 == 0)
{
 *pTagReportData++ = '-';
}
 
sprintf(pTagReportData, "%02X", pTagIDData[index]);
while(*pTagReportData) pTagReportData++;
}
 
pTagReportData = MBBuffer;
for(UINT32 index = 0; index < mbLength; index++)
{
if(0 < index && index%2 == 0)
{
 *pTagReportData++ = '-';
}
sprintf(pTagReportData, "%02X", pMBData[index]);
while(*pTagReportData) pTagReportData++;
}
 
if (tagIDLength && mbLength)
{
printf("\n Tag ID: %s :\n %s: %s\n", tagIDBuffer, memoryBankInfo, MBBuffer);
}
}
// Code snippet for Read Access operation on multiple tags
RFID_HANDLE32 readerHandle;
RFID_STATUS rfidStatus = RFID_API_SUCCESS;
READ_ACCESS_PARAMS readAccessParams;
LPTAG_DATA pTagData;
UINT32 accessSuccessCount, accessFailureCount;
 
if(RFID_API_SUCCESS == RFID_Connect(&readerHandle, TEXT("157.235.207.190"), 0, 0, 0))
{
HANDLE accessComplete = CreateEvent(NULL, FALSE, FALSE, NULL);
pTagData = RFID_AllocateTag(readerHandle);
if(NULL == pTagData)
{
printf("\n Tag Allocation failed");
}
else
{
RFID_RegisterEventNotification(readerHandle, ACCESS_STOP_EVENT, accessComplete);
// Read User-Bank of multiple tags
readAccessParams.accessPassword = 0;
readAccessParams.memoryBank = MEMORY_BANK_USER;
readAccessParams.byteCount = 64;
readAccessParams.byteOffset = 0;
readAccessParams.accessPassword = 0;
 
rfidStatus = RFID_Read(readerHandle, NULL, 0, &readAccessParams, NULL, NULL, NULL, NULL);
if(RFID_API_SUCCESS != rfidStatus)
{
ERROR_INFO errorInfo;
RFID_GetLastErrorInfo(readerHandle, &errorInfo);
printf("\n Read Failed: %S", errorInfo.vendorMessage);
}
WaitForSingleObject(accessComplete, INFINITE);
accessSuccessCount = accessFailureCount = 0;
rfidStatus =  RFID_GetLastAccessResult(readerHandle,
&accessSuccessCount, &accessFailureCount);
printf("\n\n Reading User memory: Success = %d, Failed = %d", accessSuccessCount,
accessFailureCount);
// Fetch the tags
while(RFID_API_SUCCESS == RFID_GetReadTag(readerHandle, pTagData))
{
// Lets print the Tag ID and Memory Bank
printTagMemoryBankData(pTagData->pTagID, pTagData->tagIDLength,
pTagData->pMemoryBankData, pTagData->memoryBankDataLength, "User Memory");
}
}
rfidStatus = RFID_Disconnect(readerHandle);
CloseHandle(accessComplete);
}

RFID_Write()

RFID_STATUS WINAPI RFID_Write	(	RFID_HANDLE32	readerHandle,
		UINT8 *	pTagID,
		UINT32	tagIDLength,
		LPWRITE_ACCESS_PARAMS	lpWriteAccessParams,
		LPACCESS_FILTER	lpAccessFilter,
		LPANTENNA_INFO	lpAntennaInfo,
		LPVOID	rsvd
	)

This function writes to a specified memory bank of tag(s).

Parameters

[in]	readerHandle	Handle to the RFID device.
[in]	pTagID	Access-Operation will be performed on Tag with mentioned TagID. If this is NULL, lpAccessFilter will be considered as Filter Criteria for the Access operation.
[in]	tagIDLength	Tag Length(Ignored if pTagID is NULL).
[in]	lpWriteAccessParams	Pointer to WRITE_ACCESS_PARAMS.
[in]	lpAccessFilter	Filter Criteria for the Access operation. If this is NULL, there wont be any access filters used for the operation.
[in]	lpAntennaInfo	Antenna List on which the access operation is to be performed. If this is NULL, access is performed on ALL antennas.
[in]	rsvd	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 Parameter is invalid
• RFID_API_COMMAND_TIMEOUT Timeout and no responses from the reader
• RFID_COMM_NO_CONNECTION No Connection exists to the Host
• RFID_INVENTORY_IN_PROGRESS Inventory in progress, cannot perform requested operation
• RFID_ACCESS_IN_PROGRESS Access Operation in progress, cannot perform requested operation
• RFID_ACCESS_TAG_WRITE_FAILED Tag write failed

Remarks

This function behaves synchronously when performing operation on single Tag i.e When specifying pTagID, the function waits for the operation to complete and returns with the result of the operation. If pTagID is NULL, the function behaves asynchronously and will return immediately. The completion of the operation will be signaled using ACCESS_STOP_EVENT, after which RFID_GetLastAccessResult can be called to know the result of the operation.

See also

RFID_Read, RFID_Kill, RFID_Lock, RFID_BlockWrite, RFID_BlockErase, RFID_GetLastAccessResult

Remarks

Example:

//  Write Access operation on multiple tags
RFID_HANDLE32 readerHandle;
RFID_STATUS rfidStatus = RFID_API_SUCCESS;
WRITE_ACCESS_PARAMS writeAccessParams;
UINT8 writeUserData[64];
UINT32 accessSuccessCount, accessFailureCount;
 
if(RFID_API_SUCCESS == RFID_Connect(&readerHandle, TEXT("157.235.207.190"), 0, 0, 0))
{
HANDLE accessComplete = CreateEvent(NULL, FALSE, FALSE, NULL);
RFID_RegisterEventNotification(readerHandle, ACCESS_STOP_EVENT, accessComplete);
 
writeAccessParams.accessPassword = 0;
writeAccessParams.memoryBank = MEMORY_BANK_USER;
writeAccessParams.byteOffset = 0;
writeAccessParams.writeDataLength = 64;
writeAccessParams.pWriteData = writeUserData;
memset(writeAccessParams.pWriteData, 0xAA, writeAccessParams.writeDataLength);
rfidStatus = RFID_Write(readerHandle, NULL, 0, &writeAccessParams, NULL, NULL, NULL);
accessSuccessCount = accessFailureCount = 0;
WaitForSingleObject(accessComplete, INFINITE);
rfidStatus =  RFID_GetLastAccessResult(readerHandle,
&accessSuccessCount, &accessFailureCount);
printf("\n\n Writing to User memory: Success = %d, Failed = %d", accessSuccessCount,
accessFailureCount);
 
rfidStatus = RFID_Disconnect(readerHandle);
CloseHandle(accessComplete);
}

RFID_WriteTagID()

RFID_STATUS WINAPI RFID_WriteTagID	(	RFID_HANDLE32	readerHandle,
		UINT8 *	pTagID,
		UINT32	tagIDLength,
		LPWRITE_SPECIFIC_FIELD_ACCESS_PARAMS	lpWriteSpecificFieldAccessParams,
		LPANTENNA_INFO	lpAntennaInfo,
		LPVOID	rsvd
	)

This function writes to TagID of a specific tag and adjusts the PC bits according to the length of the TagID.

Parameters

[in]	readerHandle	Handle to the RFID device.
[in]	pTagID	Access-Operation will be performed on Tag with mentioned TagID.
[in]	tagIDLength	Tag Length.
[in]	lpWriteSpecificFieldAccessParams	Pointer to WRITE_SPECIFIC_FIELD_ACCESS_PARAMS.
[in]	lpAntennaInfo	Antenna List on which the access operation is to be performed. If this is NULL, access is performed on ALL antennas.
[in]	rsvd	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 Parameter is invalid
• RFID_API_COMMAND_TIMEOUT Timeout and no responses from the reader
• RFID_COMM_NO_CONNECTION No Connection exists to the Host
• RFID_INVENTORY_IN_PROGRESS Inventory in progress, cannot perform requested operation
• RFID_ACCESS_IN_PROGRESS Access Operation in progress, cannot perform requested operation
• RFID_ACCESS_TAG_WRITE_FAILED Tag write failed

Remarks

This function behaves synchronously i.e the function waits for the operation to complete and returns with the result of the operation.

See also

RFID_WriteKillPassword, RFID_WriteAccessPassword RFID_Read, RFID_Kill, RFID_Lock, RFID_BlockWrite, RFID_BlockErase, RFID_GetLastAccessResult

Remarks

Example:

RFID_HANDLE32 readerHandle;
RFID_STATUS rfidStatus = RFID_API_SUCCESS;
WRITE_SPECIFIC_FIELD_ACCESS_PARAMS writeSpecificFieldAccessParams;
UINT8 writeData[64] = {0x11, 0x22, 0x33, 0x44};
UINT8 passwordData[4] = {0,};// zero password
TAG_DATA* pTagData = NULL;
ERROR_INFO errorInfo;
if(RFID_API_SUCCESS == RFID_Connect(&readerHandle, TEXT("157.235.208.51"), 0, 0, 0))
{
    pTagData = RFID_AllocateTag(readerHandle);
    RFID_PerformInventory(readerHandle, NULL, NULL, NULL, NULL);
    Sleep(1000);
    RFID_StopInventory(readerHandle);
    while(RFID_GetReadTag(readerHandle, pTagData) == RFID_API_SUCCESS)
    {
        printf("\n ***********************************");
        printTagData(pTagData->pTagID, pTagData->tagIDLength);
        writeSpecificFieldAccessParams.accessPassword = 0;
        writeSpecificFieldAccessParams.writeDataLength = 4;
        writeSpecificFieldAccessParams.pWriteData = passwordData;
        if(RFID_API_SUCCESS == RFID_WriteKillPassword(readerHandle, pTagData->pTagID, pTagData->tagIDLength, &writeSpecificFieldAccessParams, NULL, NULL))
        {
           printf("\n WriteKillPassword - Success");
        }
        else
        {
           RFID_GetLastErrorInfo(readerHandle, &errorInfo);
           printf("\n WriteKillPassword - Failed - %S %S", errorInfo.statusDesc, errorInfo.vendorMessage);
        }
        if(RFID_API_SUCCESS == RFID_WriteAccessPassword(readerHandle, pTagData->pTagID, pTagData->tagIDLength, &writeSpecificFieldAccessParams, NULL, NULL))
        {
           printf("\n WriteAccessPassword - Success");
        }
        else
        {
           RFID_GetLastErrorInfo(readerHandle, &errorInfo);
           printf("\n WriteAccessPassword  - Failed - %S %S", errorInfo.statusDesc, errorInfo.vendorMessage);
        }
        UINT32 uniqueValue = GetTickCount();
        // Write Tag ID
        writeData[4] = (UINT8) uniqueValue & 0xFF;
        writeData[5] = (UINT8) ((uniqueValue >> 12 ) & 0xFF);
        writeSpecificFieldAccessParams.writeDataLength = 6;
        writeSpecificFieldAccessParams.pWriteData = writeData;
        
        if(RFID_API_SUCCESS == RFID_WriteTagID(readerHandle, pTagData->pTagID, pTagData->tagIDLength, &writeSpecificFieldAccessParams, NULL, NULL))
        {
           printf("\n WriteTagID - Success");
        }
        else
        {
           RFID_GetLastErrorInfo(readerHandle, &errorInfo);
           printf("\n WriteTagID  - Failed - %S %S", errorInfo.statusDesc, errorInfo.vendorMessage);
        }
    }      
    rfidStatus = RFID_Disconnect(readerHandle);
}

RFID_WriteKillPassword()

RFID_STATUS WINAPI RFID_WriteKillPassword	(	RFID_HANDLE32	readerHandle,
		UINT8 *	pTagID,
		UINT32	tagIDLength,
		LPWRITE_SPECIFIC_FIELD_ACCESS_PARAMS	lpWriteSpecificFieldAccessParams,
		LPANTENNA_INFO	lpAntennaInfo,
		LPVOID	rsvd
	)

This function writes Kill password of a specific tag.

Parameters

[in]	readerHandle	Handle to the RFID device.
[in]	pTagID	Access-Operation will be performed on Tag with mentioned TagID.
[in]	tagIDLength	Tag Length.
[in]	lpWriteSpecificFieldAccessParams	Pointer to WRITE_SPECIFIC_FIELD_ACCESS_PARAMS.
[in]	lpAntennaInfo	Antenna List on which the access operation is to be performed. If this is NULL, access is performed on ALL antennas.
[in]	rsvd	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 Parameter is invalid
• RFID_API_COMMAND_TIMEOUT Timeout and no responses from the reader
• RFID_COMM_NO_CONNECTION No Connection exists to the Host
• RFID_INVENTORY_IN_PROGRESS Inventory in progress, cannot perform requested operation
• RFID_ACCESS_IN_PROGRESS Access Operation in progress, cannot perform requested operation
• RFID_ACCESS_TAG_WRITE_FAILED Tag write failed

Remarks

This function behaves synchronously i.e the function waits for the operation to complete and returns with the result of the operation.

See also

RFID_WriteTagID, RFID_WriteAccessPassword RFID_Read, RFID_Kill, RFID_Lock, RFID_BlockWrite, RFID_BlockErase, RFID_GetLastAccessResult

Remarks

Example:

RFID_WriteTagID

RFID_WriteAccessPassword()

RFID_STATUS WINAPI RFID_WriteAccessPassword	(	RFID_HANDLE32	readerHandle,
		UINT8 *	pTagID,
		UINT32	tagIDLength,
		LPWRITE_SPECIFIC_FIELD_ACCESS_PARAMS	lpWriteSpecificFieldAccessParams,
		LPANTENNA_INFO	lpAntennaInfo,
		LPVOID	rsvd
	)

This function writes to access password of a specific tag.

Parameters

[in]	readerHandle	Handle to the RFID device.
[in]	pTagID	Access-Operation will be performed on Tag with mentioned TagID..
[in]	tagIDLength	Tag Length.
[in]	lpWriteSpecificFieldAccessParams	Pointer to WRITE_SPECIFIC_FIELD_ACCESS_PARAMS.
[in]	lpAntennaInfo	Antenna List on which the access operation is to be performed. If this is NULL, access is performed on ALL antennas.
[in]	rsvd	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 Parameter is invalid
• RFID_API_COMMAND_TIMEOUT Timeout and no responses from the reader
• RFID_COMM_NO_CONNECTION No Connection exists to the Host
• RFID_INVENTORY_IN_PROGRESS Inventory in progress, cannot perform requested operation
• RFID_ACCESS_IN_PROGRESS Access Operation in progress, cannot perform requested operation
• RFID_ACCESS_TAG_WRITE_FAILED Tag write failed

Remarks

This function behaves synchronously i.e the function waits for the operation to complete and returns with the result of the operation.

See also

RFID_WriteTagID, RFID_WriteKillPassword RFID_Read, RFID_Kill, RFID_Lock, RFID_BlockWrite, RFID_BlockErase, RFID_GetLastAccessResult

Remarks

Example:

RFID_WriteTagID

RFID_Kill()

RFID_STATUS WINAPI RFID_Kill	(	RFID_HANDLE32	readerHandle,
		UINT8 *	pTagID,
		UINT32	tagIDLength,
		LPKILL_ACCESS_PARAMS	lpKillParams,
		LPACCESS_FILTER	lpAccessFilter,
		LPANTENNA_INFO	lpAntennaInfo,
		LPVOID	rsvd
	)

This function kills tag(s).

Parameters

[in]	readerHandle	Handle to the RFID device.
[in]	pTagID	Access-Operation will be performed on Tag with mentioned TagID. If this is NULL, lpAccessFilter will be considered as Filter Criteria for the Access operation.
[in]	tagIDLength	Tag Length(Ignored if pTagID is NULL).
[in]	lpKillParams	Pointer to KILL_ACCESS_PARAMS.
[in]	lpAccessFilter	Filter Criteria for the Access operation. If this is NULL, there wont be any access filters used for the operation.
[in]	lpAntennaInfo	Antenna List on which the access operation is to be performed. If this is NULL, access is performed on ALL antennas.
[in]	rsvd	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 Parameter is invalid
• RFID_API_COMMAND_TIMEOUT Timeout and no responses from the reader
• RFID_COMM_NO_CONNECTION No Connection exists to the Host
• RFID_INVENTORY_IN_PROGRESS Inventory in progress, cannot perform requested operation
• RFID_ACCESS_IN_PROGRESS Access Operation in progress, cannot perform requested operation
• RFID_ACCESS_TAG_KILL_FAILED Tag kill failed

Remarks

This function behaves synchronously when performing operation on single Tag i.e When specifying pTagID, the function waits for the operation to complete and returns with the result of the operation. If pTagID is NULL, the function behaves asynchronously and will return immediately. The completion of the operation will be signaled using ACCESS_STOP_EVENT, after which RFID_GetLastAccessResult can be called to know the result of the operation.

See also

RFID_Read, RFID_Write, RFID_Lock RFID_BlockWrite, RFID_BlockErase, RFID_GetLastAccessResult

Remarks

Example:

// Kill Access Operation on a specific tag
RFID_HANDLE32 readerHandle;
RFID_STATUS rfidStatus = RFID_API_SUCCESS;
KILL_ACCESS_PARAMS killAccessParams;
UINT32 accessSuccessCount, accessFailureCount;
// Give the EPC-id of the tag which you have in Field of View
//FD02-FDFD-FDFD-FDFD-FDFD-237D
UINT8 specificTag[12] = {0xFD, 0x02, 0xFD, 0xFD, 0xFD, 0xFD, 0xFD, 0xFD, 0xFD, 0xFD, 0X23, 0X7D};
UINT32 specificTagIdLength = 12;
 
if(RFID_API_SUCCESS == RFID_Connect(&readerHandle, TEXT("157.235.207.190"), 0, 0, 0))
{
// Pre-program the Reserved Bank's Kill password with this password
killAccessParams.killPassword = 0xAAAAAAAA;
rfidStatus = RFID_Kill(readerHandle, specificTag, specificTagIdLength,
&killAccessParams, NULL, NULL, NULL);
accessSuccessCount = accessFailureCount = 0;
rfidStatus =  RFID_GetLastAccessResult(readerHandle,
&accessSuccessCount, &accessFailureCount);
printf("\n\n Kill Tag: Success = %d, Failed = %d", accessSuccessCount,
accessFailureCount);
 
rfidStatus = RFID_Disconnect(readerHandle);
}

RFID_Lock()

RFID_STATUS WINAPI RFID_Lock	(	RFID_HANDLE32	readerHandle,
		UINT8 *	pTagID,
		UINT32	tagIDLength,
		LPLOCK_ACCESS_PARAMS	lpLockParams,
		LPACCESS_FILTER	lpAccessFilter,
		LPANTENNA_INFO	lpAntennaInfo,
		LPVOID	rsvd
	)

This function locks tag(s).

Parameters

[in]	readerHandle	Handle to the RFID device.
[in]	pTagID	Access-Operation will be performed on Tag with mentioned TagID. If this is NULL, lpAccessFilter will be considered as Filter Criteria for the Access operation.
[in]	tagIDLength	Tag Length(Ignored if pTagID is NULL).
[in]	lpLockParams	Pointer to LOCK_ACCESS_PARAMS.
[in]	lpAccessFilter	Filter Criteria for the Access operation. If this is NULL, there wont be any access filters used for the operation.
[in]	lpAntennaInfo	Antenna List on which the access operation is to be performed. If this is NULL, access is performed on ALL antennas.
[in]	rsvd	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 Parameter is invalid
• RFID_API_COMMAND_TIMEOUT Timeout and no responses from the reader
• RFID_COMM_NO_CONNECTION No Connection exists to the Host
• RFID_INVENTORY_IN_PROGRESS Inventory in progress, cannot perform requested operation
• RFID_ACCESS_IN_PROGRESS Access Operation in progress, cannot perform requested operation
• RFID_ACCESS_TAG_LOCK_FAILED Tag lock failed

Remarks

This function behaves synchronously when performing operation on single Tag i.e When specifying pTagID, the function waits for the operation to complete and returns with the result of the operation. If pTagID is NULL, the function behaves asynchronously and will return immediately. The completion of the operation will be signalled using ACCESS_STOP_EVENT, after which RFID_GetLastAccessResult can be called to know the result of the operation.

See also

RFID_Read, RFID_Write, RFID_Kill RFID_BlockWrite, RFID_BlockErase, RFID_GetLastAccessResult

Remarks

Example:

// Lock Access Operation on a specific tag
RFID_HANDLE32 readerHandle;
RFID_STATUS rfidStatus = RFID_API_SUCCESS;
LOCK_ACCESS_PARAMS lockAccessParams;
TAG_PATTERN tagPatternA;
ACCESS_FILTER accessFilter;
UINT32 accessSuccessCount, accessFailureCount;
UINT8 tagData[64];
WRITE_ACCESS_PARAMS writeAccessParams;
UINT8 writeData[64];
// Give the EPC-id of the tag which you have in Field of View
//FD02-FDFD-FDFD-FDFD-FDFD-237D
UINT8 specificTag[12] = {0xFD, 0x02, 0xFD, 0xFD, 0xFD, 0xFD, 0xFD, 0xFD, 0xFD, 0xFD, 0X23, 0X7D};
UINT32 specificTagIdLength = 12;
UINT8 tagMask[64];
 
memset(tagMask, 0xFF, 64);
memset(tagData, 0, 64);
tagPatternA.memoryBank = MEMORY_BANK_RESERVED;
tagPatternA.bitOffset = 0;
tagPatternA.pTagPattern = tagData;
tagPatternA.tagPatternBitCount = tagPatternA.tagMaskBitCount = 8 * 8;
tagPatternA.pTagMask = tagMask;
accessFilter.lpTagPatternA = &tagPatternA;
accessFilter.lpTagPatternB = NULL;
 
if(RFID_API_SUCCESS == RFID_Connect(&readerHandle, TEXT("157.235.207.190"), 0, 0, 0))
{
 
writeAccessParams.accessPassword = 0;
writeAccessParams.memoryBank = MEMORY_BANK_RESERVED;
writeAccessParams.byteOffset = 4;//Access-Password is at word offset 2
writeAccessParams.writeDataLength = 4;//Access-Password is 2 words long
writeAccessParams.pWriteData = writeData;
memset(writeAccessParams.pWriteData, 0xAA, writeAccessParams.writeDataLength);
rfidStatus = RFID_Write(readerHandle, specificTag, specificTagIdLength,
&writeAccessParams, NULL, NULL, NULL);
accessSuccessCount = accessFailureCount = 0;
 
lockAccessParams.accessPassword = 0xAAAAAAAA;
lockAccessParams.privilege[LOCK_USER_MEMORY] = LOCK_PRIVILEGE_READ_WRITE;
lockAccessParams.privilege[LOCK_TID_MEMORY] = LOCK_PRIVILEGE_READ_WRITE;
// Lock a specific Tag, post filter to ensure that Reserved field is zero
// which means No password
rfidStatus = RFID_Lock(readerHandle, specificTag, specificTagIdLength,
&lockAccessParams, &accessFilter, NULL, NULL);
accessSuccessCount = accessFailureCount = 0;
rfidStatus =  RFID_GetLastAccessResult(readerHandle,
&accessSuccessCount, &accessFailureCount);
printf("\n\n Lock User memory: Success = %d, Failed = %d", accessSuccessCount,
accessFailureCount);
 
lockAccessParams.privilege[LOCK_USER_MEMORY] = LOCK_PRIVILEGE_UNLOCK;
// Unlock the specific Tag
rfidStatus = RFID_Lock(readerHandle, specificTag, specificTagIdLength,
&lockAccessParams, &accessFilter, NULL, NULL);
 
rfidStatus = RFID_Disconnect(readerHandle);
}

RFID_BlockWrite()

RFID_STATUS WINAPI RFID_BlockWrite	(	RFID_HANDLE32	readerHandle,
		UINT8 *	pTagID,
		UINT32	tagIDLength,
		LPWRITE_ACCESS_PARAMS	lpWriteAccessParams,
		LPACCESS_FILTER	lpAccessFilter,
		LPANTENNA_INFO	lpAntennaInfo,
		LPVOID	rsvd
	)

This function allows to write multiple words in a Tag’s Reserved, EPC, TID, or User memory using a single command.

Parameters

[in]	readerHandle	Handle to the RFID device.
[in]	pTagID	Access-Operation will be performed on Tag with mentioned TagID. If this is NULL, lpAccessFilter will be considered as Filter Criteria for the Access operation.
[in]	tagIDLength	Tag Length(Ignored if pTagID is NULL).
[in]	lpWriteAccessParams	Pointer to WRITE_ACCESS_PARAMS.
[in]	lpAccessFilter	Filter Criteria for the Access operation. If this is NULL, there wont be any access filters used for the operation.
[in]	lpAntennaInfo	Antenna List on which the access operation is to be performed. If this is NULL, access is performed on ALL antennas.
[in]	rsvd	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 Parameter is invalid
• RFID_API_COMMAND_TIMEOUT Timeout and no responses from the reader
• RFID_COMM_NO_CONNECTION No Connection exists to the Host
• RFID_INVENTORY_IN_PROGRESS Inventory in progress, cannot perform requested operation
• RFID_ACCESS_IN_PROGRESS Access Operation in progress, cannot perform requested operation
• RFID_ACCESS_TAG_BLOCK_WRITE_FAILED Tag Block Write failed
• RFID_READER_FUNCTION_UNSUPPORTED Function not supported by Reader

Remarks

This function behaves synchronously when performing operation on single Tag i.e When specifying pTagID, the function waits for the operation to complete and returns with the result of the operation. If pTagID is NULL, the function behaves asynchronously and will return immediately. The completion of the operation will be signalled using ACCESS_STOP_EVENT, after which RFID_GetLastAccessResult can be called to know the result of the operation.

See also

RFID_Read, RFID_Write, RFID_Kill, RFID_Lock, RFID_BlockErase, RFID_GetLastAccessResult

Remarks

Example: Similar to

RFID_Write

RFID_BlockErase()

RFID_STATUS WINAPI RFID_BlockErase	(	RFID_HANDLE32	readerHandle,
		UINT8 *	pTagID,
		UINT32	tagIDLength,
		LPBLOCK_ERASE_ACCESS_PARAMS	lpBlkEraseAccessParams,
		LPACCESS_FILTER	lpAccessFilter,
		LPANTENNA_INFO	lpAntennaInfo,
		LPVOID	rsvd
	)

This function erases tag(s).

Parameters

[in]	readerHandle	Handle to the RFID device.
[in]	pTagID	Access-Operation will be performed on Tag with mentioned TagID. If this is NULL, lpAccessFilter will be considered as Filter Criteria for the Access operation.
[in]	tagIDLength	Tag Length(Ignored if pTagID is NULL)
[in]	lpBlkEraseAccessParams	Pointer to BLOCK_ERASE_ACCESS_PARAMS.
[in]	lpAccessFilter	Filter Criteria for the Access operation. If this is NULL, there wont be any access filters used for the operation.
[in]	lpAntennaInfo	Antenna List on which the access operation is to be performed. If this is NULL, access is performed on ALL antennas.
[in]	rsvd	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 Parameter is invalid
• RFID_API_COMMAND_TIMEOUT Timeout and no responses from the reader
• RFID_COMM_NO_CONNECTION No Connection exists to the Host
• RFID_INVENTORY_IN_PROGRESS Inventory in progress, cannot perform requested operation
• RFID_ACCESS_IN_PROGRESS Access Operation in progress, cannot perform requested operation
• RFID_ACCESS_TAG_BLOCK_ERASE_FAILED Tag Block Erase failed
• RFID_READER_FUNCTION_UNSUPPORTED Function not supported by Reader

Remarks

This function behaves synchronously when performing operation on single Tag i.e When specifying pTagID, the function waits for the operation to complete and returns with the result of the operation. If pTagID is NULL, the function behaves asynchronously and will return immediately. The completion of the operation will be signalled using ACCESS_STOP_EVENT, after which RFID_GetLastAccessResult can be called to know the result of the operation.

See also

RFID_Read, RFID_Write, RFID_Kill, RFID_Lock, RFID_BlockWrite, RFID_GetLastAccessResult

Remarks

Example:

// Block Erase
RFID_HANDLE32 readerHandle;
RFID_STATUS rfidStatus = RFID_API_SUCCESS;
BLOCK_ERASE_ACCESS_PARAMS blockEraseAccessParams;
UINT32 accessSuccessCount, accessFailureCount;
// Give the EPC-id of the tag which you have in Field of View
UINT8 specificTag[8] = {0x12, 0x12, 0x25, 0x25, 0x33, 0x33, 0x44, 0x44};
UINT32 specificTagIdLength = 8;
 
if(RFID_API_SUCCESS == RFID_Connect(&readerHandle, TEXT("157.235.207.190"), 0, 0, 0))
{
blockEraseAccessParams.accessPassword = 0;
blockEraseAccessParams.memoryBank = MEMORY_BANK_USER;
blockEraseAccessParams.byteCount = 100;
blockEraseAccessParams.byteOffset = 0;
 
rfidStatus = RFID_BlockErase(readerHandle, specificTag, specificTagIdLength,
&blockEraseAccessParams, NULL, NULL, NULL);
accessSuccessCount = accessFailureCount = 0;
rfidStatus =  RFID_GetLastAccessResult(readerHandle,
&accessSuccessCount, &accessFailureCount);
printf("\n\n Block Erase Tag: Success = %d, Failed = %d", accessSuccessCount,
accessFailureCount);
 
rfidStatus = RFID_Disconnect(readerHandle);
}

RFID_BlockPermalock()

RFID_STATUS WINAPI RFID_BlockPermalock	(	RFID_HANDLE32	readerHandle,
		UINT8 *	pTagID,
		UINT32	tagIDLength,
		LPBLOCK_PERMALOCK_ACCESS_PARAMS	lpBlkPermalockAccessParams,
		LPACCESS_FILTER	lpAccessFilter,
		LPANTENNA_INFO	lpAntennaInfo,
		LPTAG_DATA	lpTagData,
		LPVOID	rsvd
	)

This function allows to permalock multiple words in a Tag’s Reserved, EPC, TID, or User memory with a single command, or read the permalock satus of the memory blocks in a Tag's User memory.

Parameters

[in]	readerHandle	Handle to the RFID device.
[in]	pTagID	Access-Operation will be performed on Tag with mentioned TagID. If this is NULL, lpAccessFilter will be considered as Filter Criteria for the Access operation.
[in]	tagIDLength	Tag Length(Ignored if pTagID is NULL)
[in]	lpBlkPermalockAccessParams	Pointer to BLOCK_PERMALOCK_ACCESS_PARAMS.
[in]	lpAccessFilter	Filter Criteria for the Access operation. If this is NULL, there wont be any access filters used for the operation.
[in]	lpAntennaInfo	Antenna List on which the access operation is to be performed. If this is NULL, access is performed on ALL antennas.
[out]	lpTagData	Returns the Tag that contained the permalock mask status if the function was called with a valid pTagID. If pTagID is NULL, tags reported from Reader can be fetched using RFID_GetReadTag or RFID_GetEventData optionally waiting for by waiting for the TAG_READ_EVENT.
[in]	rsvd	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 Parameter is invalid
• RFID_API_COMMAND_TIMEOUT Timeout and no responses from the reader
• RFID_COMM_NO_CONNECTION No Connection exists to the Host
• RFID_INVENTORY_IN_PROGRESS Inventory in progress, cannot perform requested operation
• RFID_ACCESS_IN_PROGRESS Access Operation in progress, cannot perform requested operation
• RFID_ACCESS_TAG_BLOCK_PERMALOCK_FAILED Tag Block Permalock failed
• RFID_READER_FUNCTION_UNSUPPORTED Function not supported by Reader

Remarks

This function behaves synchronously when performing operation on single Tag i.e When specifying pTagID, the function waits for the operation to complete and returns with the result of the operation. If pTagID is NULL, the function behaves asynchronously and will return immediately. The completion of the operation will be signalled using ACCESS_STOP_EVENT, after which RFID_GetLastAccessResult can be called to know the result of the operation.

See also

RFID_Read, RFID_Write, RFID_Kill, RFID_Lock, RFID_BlockWrite, RFID_BlockErase, RFID_Recommission, RFID_GetLastAccessResult

Remarks

Example:

// Code snippet for Read Access operation on multiple tags
RFID_HANDLE32 readerHandle;
RFID_STATUS rfidStatus = RFID_API_SUCCESS;
BLOCK_PERMALOCK_ACCESS_PARAMS blkPermalockAccessParams;
LPTAG_DATA pTagData;
UINT32 accessSuccessCount, accessFailureCount;
 
if(RFID_API_SUCCESS == RFID_Connect(&readerHandle, TEXT("157.235.207.190"), 0, 0, 0))
{
HANDLE accessComplete = CreateEvent(NULL, FALSE, FALSE, NULL);
pTagData = RFID_AllocateTag(readerHandle);
if(NULL == pTagData)
{
printf("\n Tag Allocation failed");
}
else
{
RFID_RegisterEventNotification(readerHandle, ACCESS_STOP_EVENT, accessComplete);
// Read User-Bank of multiple tags
blkPermalockAccessParams.readLock = TRUE;
blkPermalockAccessParams.accessPassword = 0;
blkPermalockAccessParams.memoryBank = MEMORY_BANK_USER;
blkPermalockAccessParams.byteCount = 64;
blkPermalockAccessParams.byteOffset = 0;
 
rfidStatus = RFID_BlockPermalock(readerHandle, NULL, 0, &blkPermalockAccessParams, NULL, NULL, NULL, NULL);
if(RFID_API_SUCCESS != rfidStatus)
{
ERROR_INFO errorInfo;
RFID_GetLastErrorInfo(readerHandle, &errorInfo);
printf("\n Read Failed: %S", errorInfo.vendorMessage);
}
WaitForSingleObject(accessComplete, INFINITE);
accessSuccessCount = accessFailureCount = 0;
rfidStatus =  RFID_GetLastAccessResult(readerHandle,
&accessSuccessCount, &accessFailureCount);
printf("\n\n Reading User memory: Success = %d, Failed = %d", accessSuccessCount,
accessFailureCount);
// Fetch the tags
while(RFID_API_SUCCESS == RFID_GetReadTag(readerHandle, pTagData))
{
// Lets print the Tag ID and Memory Bank
printTagMemoryBankData(pTagData->pTagID, pTagData->tagIDLength,
pTagData->pMemoryBankData, pTagData->memoryBankDataLength, "User Memory");
}
}
rfidStatus = RFID_Disconnect(readerHandle);
CloseHandle(accessComplete);
}

RFID_Recommission()

RFID_STATUS WINAPI RFID_Recommission	(	RFID_HANDLE32	readerHandle,
		UINT8 *	pTagID,
		UINT32	tagIDLength,
		LPRECOMMISSION_ACCESS_PARAMS	lpRecommissionParams,
		LPACCESS_FILTER	lpAccessFilter,
		LPANTENNA_INFO	lpAntennaInfo,
		LPVOID	rsvd
	)

This function is used for recommissioning tag(s).

Parameters

[in]	readerHandle	Handle to the RFID device.
[in]	pTagID	Access-Operation will be performed on Tag with mentioned TagID. If this is NULL, lpAccessFilter will be considered as Filter Criteria for the Access operation.
[in]	tagIDLength	Tag Length(Ignored if pTagID is NULL)
[in]	lpRecommissionParams	Pointer to RECOMMISSION_ACCESS_PARAMS.
[in]	lpAccessFilter	Filter Criteria for the Access operation. If this is NULL, there wont be any access filters used for the operation.
[in]	lpAntennaInfo	Antenna List on which the access operation is to be performed. If this is NULL, access is performed on ALL antennas.
[in]	rsvd	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 Parameter is invalid
• RFID_API_COMMAND_TIMEOUT Timeout and no responses from the reader
• RFID_COMM_NO_CONNECTION No Connection exists to the Host
• RFID_INVENTORY_IN_PROGRESS Inventory in progress, cannot perform requested operation
• RFID_ACCESS_IN_PROGRESS Access Operation in progress, cannot perform requested operation
• RFID_ACCESS_TAG_RECOMMISSION_FAILED Tag Recommission failed
• RFID_READER_FUNCTION_UNSUPPORTED Function not supported by Reader

Remarks

This function behaves synchronously when performing operation on single Tag i.e When specifying pTagID, the function waits for the operation to complete and returns with the result of the operation. If pTagID is NULL, the function behaves asynchronously and will return immediately. The completion of the operation will be signalled using ACCESS_STOP_EVENT, after which RFID_GetLastAccessResult can be called to know the result of the operation.

See also

RFID_Read, RFID_Write, RFID_Kill, RFID_Lock, RFID_BlockWrite, RFID_BlockErase, RFID_BlockPermalock, RFID_GetLastAccessResult

Remarks

Example:

// Block Erase
RFID_HANDLE32 readerHandle;
RFID_STATUS rfidStatus = RFID_API_SUCCESS;
RECOMMISSION_ACCESS_PARAMS recommissionAccessParams;
UINT32 accessSuccessCount, accessFailureCount;
// Give the EPC-id of the tag which you have in Field of View
UINT8 specificTag[8] = {0x12, 0x12, 0x25, 0x25, 0x33, 0x33, 0x44, 0x44};
UINT32 specificTagIdLength = 8;
 
if(RFID_API_SUCCESS == RFID_Connect(&readerHandle, TEXT("157.235.207.190"), 0, 0, 0))
{
recommissionAccessParams.killPassword = 0xAAAAAAAA;
recommissionAccessParams.opCode = RECOMMISSION_DISABLE_PASSWORD
 
rfidStatus = RFID_Recommission(readerHandle, specificTag, specificTagIdLength,
&recommissionAccessParams, NULL, NULL, NULL);
accessSuccessCount = accessFailureCount = 0;
rfidStatus =  RFID_GetLastAccessResult(readerHandle,
&accessSuccessCount, &accessFailureCount);
printf("\n\n Recommissioning Tag: Success = %d, Failed = %d", accessSuccessCount,
accessFailureCount);
 
rfidStatus = RFID_Disconnect(readerHandle);
}