TagManagement

Functions
RFID_STATUS WINAPI	RFID_GetTagStorageSettings (RFID_HANDLE32 readerHandle, LPTAG_STORAGE_SETTINGS lpTagStorageSettings)
	This function gets the Tag-storage settings. More...
RFID_STATUS WINAPI	RFID_SetTagStorageSettings (RFID_HANDLE32 readerHandle, LPTAG_STORAGE_SETTINGS lpTagStorageSettings)
	This function allows configuring the maximum Tag-storage capacity of the DLL and the storage to be allocated in the Tag data-structure (TAG_DATA) for the Memory-Bank data. More...
LPTAG_DATA WINAPI	RFID_AllocateTag (RFID_HANDLE32 readerHandle)
	This function allocates and initializes the TAG_DATA structure for the application. More...
LPRFSURVEY_DATA WINAPI	RFID_AllocateRFSurvey (RFID_HANDLE32 readerHandle)
	This function allocates and initializes the RF_SURVEY_DATA structure for the application. More...
RFID_STATUS WINAPI	RFID_DeallocateTag (RFID_HANDLE32 readerHandle, TAG_DATA *pTagData)
	This function de-allocates the TAG_DATA structure previously created using RFID_AllocateTag. More...
RFID_STATUS WINAPI	RFID_DeallocateRFSurvey (RFID_HANDLE32 readerHandle, LPRFSURVEY_DATA lpRFSurveyData)
	This function de-allocates the RF_SURVEY_DATA structure previously created using RFID_AllocateRFSurvey. More...
RFID_STATUS WINAPI	RFID_GetReadTag (RFID_HANDLE32 readerHandle, LPTAG_DATA lpTagData)
	This function returns a Tag if available. More...
RFID_STATUS WINAPI	RFID_PurgeTags (RFID_HANDLE32 readerHandle, LPVOID rsvd)
	This function purges all tags present in Dll and Reader queues. More...

Detailed Description

Function Documentation

RFID_GetTagStorageSettings()

RFID_STATUS WINAPI RFID_GetTagStorageSettings	(	RFID_HANDLE32	readerHandle,
		LPTAG_STORAGE_SETTINGS	lpTagStorageSettings
	)

This function gets the Tag-storage settings.

Parameters

[in]	readerHandle	Handle to the RFID device.
[in]	lpTagStorageSettings	Pointer to TAG_STORAGE_SETTINGS.

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

Remarks

It provides information about the size of EPC and Memory Bank data to be stored in the TAG_DATA and the fields enabled for use in TAG_DATA. It is specified the maximum storage allotted for storing TAG_DATA in the Dll.

See also

RFID_PerformInventory, RFID_SetTagStorageSettings

Remarks

Example: See

RFID_SetTagStorageSettings

RFID_SetTagStorageSettings()

RFID_STATUS WINAPI RFID_SetTagStorageSettings	(	RFID_HANDLE32	readerHandle,
		LPTAG_STORAGE_SETTINGS	lpTagStorageSettings
	)

This function allows configuring the maximum Tag-storage capacity of the DLL and the storage to be allocated in the Tag data-structure (TAG_DATA) for the Memory-Bank data.

Parameters

[in]	readerHandle	Handle to the RFID device.
[in]	lpTagStorageSettings	Pointer to TAG_STORAGE_SETTINGS.

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

Remarks

If the application does not call this function, default settings will be used, maxTagCount is 4096, maxMemoryBankByteCount is 64 bytes (512 bits) and maxTagIDByteCount is 12 bytes (96 bits). All the fields of TAG_DATA will be enabled for use by default. The field tagFields which is a member of TAG_STORAGE_SETTINGS can be used to enable/disable fields of TAG_DATA. Tags reported from the Reader as part of Inventory or Access operations will be temporarily queued in the DLL, till the user fetches them using RFID_GetReadTag. When the number of tags queued in the DLL exceeds 90% of maxTagCount, the event registered for BUFFER_FULL_WARNING_EVENT will be signaled once. When the number of tags queued in the DLL exceeds maxTagCount, the event registered for BUFFER_FULL_EVENT will be signaled for each tag that is discarded. Each TAG_DATA structure holds a memory-bank in it, the size of which can be configured so as to optimize the memory. The application can use this API to customize the Tag-size based on requirements.

See also

RFID_PerformInventory, RFID_StopInventory, RFID_AddPreFilter, RFID_DeletePreFilter, RFID_SetSingulationControl, RFID_AllocateTag

Remarks

Example: See

RFID_PerformInventory

RFID_AllocateTag()

LPTAG_DATA WINAPI RFID_AllocateTag

(

RFID_HANDLE32

readerHandle

)

This function allocates and initializes the TAG_DATA structure for the application.

Parameters

[in]

readerHandle

Handle to the RFID device.

Returns

Pointer to newly allocated LPTAG_DATA

Remarks

This function allocates memory for the Tag and for the Memory-bank data which is to be stored in the Tag. The allocation for memory bank data is done based on the default Memory-bank size or the Memory-bank size set using RFID_SetTagStorageSettings. TAG_DATA allocated using this function shall be used when getting read-tags using RFID_GetReadTag.

See also

RFID_SetTagStorageSettings, RFID_DeallocateTag, RFID_GetReadTag

Remarks

Example: Example: See

RFID_PerformInventory

RFID_AllocateRFSurvey()

LPRFSURVEY_DATA WINAPI RFID_AllocateRFSurvey

(

RFID_HANDLE32

readerHandle

)

This function allocates and initializes the RF_SURVEY_DATA structure for the application.

Parameters

[in]

readerHandle

Handle to the RFID device.

Returns

Pointer to newly allocated LPRFSURVEY_DATA

Remarks

This function allocates memory for the rf survey and for the Memory-bank data which is to be stored in the rf survey data. The allocation for memory bank data is done based on the default Memory-bank size or the Memory-bank size set using RFID_SetRFSurveyStorageSettings. RF_SURVEY_DATA allocated using this function shall be used when getting rf survey data using RFID_GetRFSurvey.

See also

RFID_SetRFSurveyStorageSettings, RFID_DeallocateRFSurvey, RFID_GetRFSurvey

Remarks

Example: Example: See

RFID_StartRFSurvey

RFID_DeallocateTag()

RFID_STATUS WINAPI RFID_DeallocateTag	(	RFID_HANDLE32	readerHandle,
		TAG_DATA *	pTagData
	)

This function de-allocates the TAG_DATA structure previously created using RFID_AllocateTag.

Parameters

[in]	readerHandle	Handle to the RFID device.
[in]	pTagData	Pointer to previously allocated TAG_DATA.

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

Remarks

This function de-allocates the Memory-bank’s data storage as well as the Tag-data.

See also

RFID_SetTagStorageSettings, RFID_AllocateTag, RFID_GetReadTag

Remarks

Example: See

RFID_PerformInventory

RFID_DeallocateRFSurvey()

RFID_STATUS WINAPI RFID_DeallocateRFSurvey	(	RFID_HANDLE32	readerHandle,
		LPRFSURVEY_DATA	lpRFSurveyData
	)

This function de-allocates the RF_SURVEY_DATA structure previously created using RFID_AllocateRFSurvey.

Parameters

[in]	readerHandle	Handle to the RFID device.
[in]	lpRFSurveyData	Pointer to previously allocated RF_SURVEY_DATA.

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

Remarks

This function de-allocates the Memory-bank’s data storage as well as the RFSurvey-data.

See also

RFID_SetRFSurveyStorageSettings, RFID_AllocateRFSurevy, RFID_GetRFSurvey

Remarks

Example: See

RFID_StartRFSurvey

RFID_GetReadTag()

RFID_STATUS WINAPI RFID_GetReadTag	(	RFID_HANDLE32	readerHandle,
		LPTAG_DATA	lpTagData
	)

This function returns a Tag if available.

Parameters

[in]	readerHandle	Handle to the RFID device.
[out]	lpTagData	Pointer to TAG_DATA.

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_NO_READ_TAGS No read Tags

Remarks

None

See also

RFID_RegisterEventNotification, RFID_PerformInventory, RFID_PerformAccessSequence, RFID_Read, RFID_SetTagStorageSettings, RFID_AllocateTag

Remarks

Example: See

RFID_PerformInventory, RFID_Read

RFID_PurgeTags()

RFID_STATUS WINAPI RFID_PurgeTags	(	RFID_HANDLE32	readerHandle,
		LPVOID	rsvd
	)

This function purges all tags present in Dll and Reader queues.

Parameters

[in]	readerHandle	Handle to the RFID device.
[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

Remarks

None

See also

RFID_GetReadTag, RFID_PerformInventory, RFID_PerformAccessSequence, RFID_Read, RFID_SetTagStorageSettings, RFID_AllocateTag

Remarks

Example: See

RFID_PerformInventory