ReaderManagement

Functions
RFID_STATUS WINAPI	RFID_LoginW (RFID_HANDLE32 *pReaderManagementHandle, LPLOGIN_INFOW lpLoginInfo, READER_TYPE readerType, BOOLEAN secureMode, LPVOID rsvd)
	This function is used to login in to the reader. More...
RFID_STATUS WINAPI	RFID_LoginA (RFID_HANDLE32 *pReaderManagementHandle, LPLOGIN_INFOA lpLoginInfo, READER_TYPE readerType, BOOLEAN secureMode, LPVOID rsvd)
RFID_STATUS WINAPI	RFID_Logout (RFID_HANDLE32 readerManagementHandle)
	This function is used to logout from the reader. More...
RFID_STATUS WINAPI	RFID_GetReaderStats (RFID_HANDLE32 readerManagementHandle, UINT16 antennaID, LPREADER_STATS lpReaderStats)
	This function gets the statistics from the Reader. More...
RFID_STATUS WINAPI	RFID_ClearReaderStats (RFID_HANDLE32 readerManagementHandle)
	This function clears the reader statistics. More...
RFID_STATUS WINAPI	RFID_EnableReadPoint (RFID_HANDLE32 readerManagementHandle, UINT16 antennaID, BOOLEAN status)
	This function enables a Read-Point, i.e. More...
RFID_STATUS WINAPI	RFID_GetReadPointStatus (RFID_HANDLE32 readerManagementHandle, UINT16 antennaID, BOOLEAN *pStatus)
	This function gets the status of a Read-Point, i.e. More...
RFID_STATUS WINAPI	RFID_GetReadPointConnectStatus (RFID_HANDLE32 readerManagementHandle, UINT16 antennaID, BOOLEAN *pConnectStatus)
	This function gets the connect status of a Read-Point, i.e. More...
RFID_STATUS WINAPI	RFID_SetAntennaMode (RFID_HANDLE32 readerManagementHandle, ANTENNA_MODE antennaMode)
	This function sets the antenna mode to either mono static or bi-static. More...
RFID_STATUS WINAPI	RFID_GetAntennaMode (RFID_HANDLE32 readerManagementHandle, ANTENNA_MODE *pAntennaMode)
	This function gets the antenna mode to either mono-static or bi-static. More...
RFID_STATUS WINAPI	RFID_ExportProfileToReaderW (RFID_HANDLE32 readerManagementHandle, TCHAR *pProfileName, TCHAR *pProfilePath, BOOLEAN activation)
	Function name : RFID_ExportProfileToReader. More...
RFID_STATUS WINAPI	RFID_ExportProfileToReaderA (RFID_HANDLE32 readerManagementHandle, CHAR *pProfileName, CHAR *pProfilePath, BOOLEAN activation)
RFID_STATUS WINAPI	RFID_ImportProfileFromReaderW (RFID_HANDLE32 readerManagementHandle, TCHAR *pProfileName, TCHAR *pProfilePath)
	Function name : RFID_ImportProfileFromReader. More...
RFID_STATUS WINAPI	RFID_ImportProfileFromReaderA (RFID_HANDLE32 readerManagementHandle, CHAR *pProfileName, CHAR *pProfilePath)
RFID_STATUS WINAPI	RFID_GetProfileListW (RFID_HANDLE32 readerManagementHandle, LPPROFILE_LIST lpProfileList)
	Function name : RFID_GetProfileList. More...
RFID_STATUS WINAPI	RFID_GetProfileListA (RFID_HANDLE32 readerManagementHandle, LPPROFILE_LISTA lpProfileList)
RFID_STATUS WINAPI	RFID_SetActiveProfileW (RFID_HANDLE32 readerManagementHandle, WCHAR *pProfileName)
	Function name : RFID_SetActiveProfile. More...
RFID_STATUS WINAPI	RFID_SetActiveProfileA (RFID_HANDLE32 readerManagementHandle, CHAR *pProfileName)
RFID_STATUS WINAPI	RFID_DeleteProfileW (RFID_HANDLE32 readerManagementHandle, WCHAR *pProfileName)
	Function name : RFID_DeleteProfile. More...
RFID_STATUS WINAPI	RFID_DeleteProfileA (RFID_HANDLE32 readerManagementHandle, CHAR *pProfileName)
RFID_STATUS WINAPI	RFID_UpdateSoftwareW (RFID_HANDLE32 readerManagementHandle, LPFTPSERVER_INFOW lpFtpLoginInfo)
	This function updates the reader firmware software from the FTP/SCP server. More...
RFID_STATUS WINAPI	RFID_UpdateSoftwareA (RFID_HANDLE32 readerManagementHandle, LPFTPSERVER_INFOA lpFtpLoginInfo)
RFID_STATUS WINAPI	RFID_GetUpdateStatusW (RFID_HANDLE32 readerManagementHandle, LPUPDATE_STATUSW lpStatus)
	This function gets the firmware/software update status from the reader. More...
RFID_STATUS WINAPI	RFID_GetUpdateStatusA (RFID_HANDLE32 readerManagementHandle, LPUPDATE_STATUSA lpStatus)
RFID_STATUS WINAPI	RFID_GetFilesToUpdateW (RFID_HANDLE32 readerManagementHandle, LPFILE_UPDATE_LISTW lpFileUpdateList)
	Function name : RFID_GetFilesToUpdate. More...
RFID_STATUS WINAPI	RFID_GetFilesToUpdateA (RFID_HANDLE32 readerManagementHandle, LPFILE_UPDATE_LISTA lpFileUpdateList)
RFID_STATUS WINAPI	RFID_UpdatePartition (RFID_HANDLE32 readerManagementHandle, UINT16 partitionIndex)
	This function updates the partition for the given partition index. More...
RFID_STATUS WINAPI	RFID_GetUpdatePartitionStatusW (RFID_HANDLE32 readerManagementHandle, LPUPDATE_PARTITION_STATUSW lpStatus)
	This function gets the partition update status. More...
RFID_STATUS WINAPI	RFID_GetUpdatePartitionStatusA (RFID_HANDLE32 readerManagementHandle, LPUPDATE_PARTITION_STATUSA lpStatus)
RFID_STATUS WINAPI	RFID_UpdateComplete (RFID_HANDLE32 readerManagementHandle)
	This function completes the single file update and reboots the reader. More...
RFID_STATUS WINAPI	RFID_UpdateRadioFirmwareW (RFID_HANDLE32 readerManagementHandle, TCHAR *pFileName)
	This function updates the radio firmware. More...
RFID_STATUS WINAPI	RFID_UpdateRadioFirmwareA (RFID_HANDLE32 readerManagementHandle, CHAR *pFileName)
RFID_STATUS WINAPI	RFID_UpdateRadioConfigW (RFID_HANDLE32 readerManagementHandle, TCHAR *pFileName)
	This function updates the radio config data (OEM data) More...
RFID_STATUS WINAPI	RFID_UpdateRadioConfigA (RFID_HANDLE32 readerManagementHandle, CHAR *pFileName)
RFID_STATUS WINAPI	RFID_Restart (RFID_HANDLE32 readerManagementHandle)
	This function issues a restart command to the RFID device. More...
RFID_STATUS WINAPI	RFID_FactoryReset (RFID_HANDLE32 readerManagementHandle)
	This function issues a Reset to Factory Defaults command to the RFID device. More...
RFID_STATUS WINAPI	RFID_GetHealthStatus (RFID_HANDLE32 readerManagementHandle, SERVICE_ID serviceID, HEALTH_STATUS *pHealthStatus, LPVOID rsvd)
	This function gets the health status of the RFID reader. More...
RFID_STATUS WINAPI	RFID_GetUSBOperationMode (RFID_HANDLE32 readerManagementHandle, LPUSB_OPERATION_INFO lpUsbOperationInfo)
	This function gets the USB operation settings of the RFID Reader. More...
RFID_STATUS WINAPI	RFID_SetUSBOperationMode (RFID_HANDLE32 readerManagementHandle, LPUSB_OPERATION_INFO lpUsbOperationInfo)
	This function sets the USB operation Mode settings of the RFID Reader. More...
RFID_STATUS WINAPI	RFID_GetGPIDebounceTime (RFID_HANDLE32 readerManagementHandle, UINT32 *pDebounceTimeMilliseconds, LPVOID rsvd)
	This function gets the GPI debounce time of the RFID Reader. More...
RFID_STATUS WINAPI	RFID_SetGPIDebounceTime (RFID_HANDLE32 readerManagementHandle, UINT32 debounceTimeMilliseconds, LPVOID rsvd)
	This function sets the GPI Debounce time of the RFID Reader. More...
RFID_STATUS WINAPI	RFID_SetUserLED (RFID_HANDLE32 readerManagementHandle, LPLED_INFO lpLedInfo)
	This function sets User LED of the RFID Reader. More...
RFID_STATUS WINAPI	RFID_GetLocalTime (RFID_HANDLE32 readerManagementHandle, LPSYSTEMTIME lpSystemTime)
	This function gets the local time of the RFID Reader. More...
RFID_STATUS WINAPI	RFID_SetLocalTime (RFID_HANDLE32 readerManagementHandle, LPSYSTEMTIME lpSystemTime)
	This function sets Local time of the RFID Reader. More...
RFID_STATUS WINAPI	RFID_SetReaderInfoW (RFID_HANDLE32 readerManagementHandle, LPREADER_INFOW lpReaderInfo)
	This function sets the Reader information in the reader. More...
RFID_STATUS WINAPI	RFID_SetReaderInfoA (RFID_HANDLE32 readerManagementHandle, LPREADER_INFOA lpReaderInfo)
RFID_STATUS WINAPI	RFID_GetReaderInfoW (RFID_HANDLE32 readerManagementHandle, LPREADER_INFOW lpReaderInfo)
	This function gets the Reader information in the reader. More...
RFID_STATUS WINAPI	RFID_GetReaderInfoA (RFID_HANDLE32 readerManagementHandle, LPREADER_INFOA lpReaderInfo)
RFID_STATUS WINAPI	RFID_GetTimeZoneListW (RFID_HANDLE32 readerManagementHandle, LPTIME_ZONE_LISTW lpTimeZoneList)
	Function name : RFID_GetTimeZoneList. More...
RFID_STATUS WINAPI	RFID_GetTimeZoneListA (RFID_HANDLE32 readerManagementHandle, LPTIME_ZONE_LISTA lpTimeZoneList)
RFID_STATUS WINAPI	RFID_SetTimeZone (RFID_HANDLE32 readerManagementHandle, UINT16 timeZoneIndex)
	This function sets the time zone index in the reader. More...
RFID_STATUS WINAPI	RFID_GetSystemInfoW (RFID_HANDLE32 readerManagementHandle, LPREADER_SYSTEM_INFO lpSystemInfo)
	This function gets the system Information related to the reader. More...
RFID_STATUS WINAPI	RFID_GetSystemInfoA (RFID_HANDLE32 readerManagementHandle, LPREADER_SYSTEM_INFOA lpSystemInfo)
RFID_STATUS WINAPI	RFID_GetNetworkInterfaceSettingsW (RFID_HANDLE32 readerManagementHandle, LPREADER_NETWORK_INFOW lpnetworkInfo)
	This function gets the Network Information related to the reader. More...
RFID_STATUS WINAPI	RFID_GetNetworkInterfaceSettingsA (RFID_HANDLE32 readerManagementHandle, LPREADER_NETWORK_INFOA lpnetworkInfo)
	This function gets the Network Information related to the reader. More...
RFID_STATUS WINAPI	RFID_GetLLRPConnectionConfigW (RFID_HANDLE32 readerManagementHandle, LPLLRP_CONNECTION_CONFIGW lpLLRPConnectionConfig)
	This function gets the LLRP Connection Configuration from the reader. More...
RFID_STATUS WINAPI	RFID_GetLLRPConnectionConfigA (RFID_HANDLE32 readerManagementHandle, LPLLRP_CONNECTION_CONFIGA lpLLRPConnectionConfig)
RFID_STATUS WINAPI	RFID_SetLLRPConnectionConfigW (RFID_HANDLE32 readerManagementHandle, LPLLRP_CONNECTION_CONFIGW lpLLRPConnectionConfig)
	This function sets the LLRP Connection Configuration at the reader. More...
RFID_STATUS WINAPI	RFID_SetLLRPConnectionConfigA (RFID_HANDLE32 readerManagementHandle, LPLLRP_CONNECTION_CONFIGA lpLLRPConnectionConfig)
RFID_STATUS WINAPI	RFID_GetLLRPConnectionStatusW (RFID_HANDLE32 readerManagementHandle, LPLLRP_CONNECTION_STATUSW lpLLRPConnectionStatus)
	This function gets the LLRP Connection Status from the reader. More...
RFID_STATUS WINAPI	RFID_GetLLRPConnectionStatusA (RFID_HANDLE32 readerManagementHandle, LPLLRP_CONNECTION_STATUSA lpLLRPConnectionStatus)
RFID_STATUS WINAPI	RFID_InitiateLLRPConnectionFromReader (RFID_HANDLE32 readerManagementHandle, LPVOID rsvd)
	This function initiates an LLRP Connection from the reader to the port on the Server-IP as configured in LLRP_CONNECTION_CONFIG. More...
RFID_STATUS WINAPI	RFID_DisconnectLLRPConnectionFromReader (RFID_HANDLE32 readerManagementHandle)
	This function disconnects the current LLRP Connection from the reader. More...
RFID_STATUS WINAPI	RFID_TurnOffRadioWhenIdle (RFID_HANDLE32 readerManagementHandle, INT32 idleTimeoutSeconds)
	This function sets the idle timeout for the radio, after which the radio turns off. More...
RFID_STATUS WINAPI	RFID_GetRadioIdleTimeout (RFID_HANDLE32 readerManagementHandle, INT32 *pIdleTimeoutSeconds)
	This function gets the radio idle timeout of the reader. More...
RFID_STATUS WINAPI	RFID_InstallUserAppW (RFID_HANDLE32 readerManagementHandle, WCHAR *pPathToPackage)
	This function installs the application specified by the user on the reader. More...
RFID_STATUS WINAPI	RFID_InstallUserAppA (RFID_HANDLE32 readerManagementHandle, CHAR *pPathToPackage)
RFID_STATUS WINAPI	RFID_UninstallUserAppW (RFID_HANDLE32 readerManagementHandle, WCHAR *pAppName)
	This function uninstalls the application specified by the user from the reader. More...
RFID_STATUS WINAPI	RFID_UninstallUserAppA (RFID_HANDLE32 readerManagementHandle, CHAR *pAppName)
RFID_STATUS WINAPI	RFID_StartUserAppW (RFID_HANDLE32 readerManagementHandle, WCHAR *pAppName)
	This function starts the application specified by the user. More...
RFID_STATUS WINAPI	RFID_StartUserAppA (RFID_HANDLE32 readerManagementHandle, CHAR *pAppName)
RFID_STATUS WINAPI	RFID_StopUserAppW (RFID_HANDLE32 readerManagementHandle, WCHAR *pAppName)
	This function stops the application specified by the user. More...
RFID_STATUS WINAPI	RFID_StopUserAppA (RFID_HANDLE32 readerManagementHandle, CHAR *pAppName)
RFID_STATUS WINAPI	RFID_GetUserAppRunStatusW (RFID_HANDLE32 readerManagementHandle, WCHAR *pAppName, BOOLEAN *pRunStatus)
	This function gets the run status of the application specified by the user. More...
RFID_STATUS WINAPI	RFID_GetUserAppRunStatusA (RFID_HANDLE32 readerManagementHandle, CHAR *pAppName, BOOLEAN *pRunStatus)
RFID_STATUS WINAPI	RFID_ListUserAppsW (RFID_HANDLE32 readerManagementHandle, LPUSERAPP_LIST lpAppList)
	This function lists all the user applications installed on the reader. More...
RFID_STATUS WINAPI	RFID_ListUserAppsA (RFID_HANDLE32 readerManagementHandle, LPUSERAPP_LISTA lpAppList)
	This function lists all the user applications installed on the reader. More...
RFID_STATUS WINAPI	RFID_SetUserAppAutoStartW (RFID_HANDLE32 readerManagementHandle, WCHAR *pAppName, BOOLEAN Enable)
	This function enables/disables autoStart of the applications specified by the reader. More...
RFID_STATUS WINAPI	RFID_SetUserAppAutoStartA (RFID_HANDLE32 readerManagementHandle, CHAR *pAppName, BOOLEAN Enable)
RFID_STATUS WINAPI	RFID_SetCableLossCompensation (RFID_HANDLE32 readerManagementHandle, UINT16 nTotalAntennasToSet, LPCABLE_LOSS_COMPENSATION *lppCableLossCompensation)
	This function sets the cable loss compensation settings. More...
RFID_STATUS WINAPI	RFID_GetCableLossCompensation (RFID_HANDLE32 readerManagementHandle, LPCABLE_LOSS_COMPENSATION lpCableLossCompensation)
	This function gets the cable loss compensation setting for given antenna ID. More...
RFID_STATUS WINAPI	RFID_GetSupportedRegionListW (RFID_HANDLE32 readerManagementHandle, REGION_LISTW *SupportedRegions)
	This function gives list of supported regions on Reader. More...
RFID_STATUS WINAPI	RFID_GetSupportedRegionListA (RFID_HANDLE32 readerManagementHandle, REGION_LISTA *SupportedRegions)
RFID_STATUS WINAPI	RFID_GetRegionStandardListW (RFID_HANDLE32 readerManagementHandle, WCHAR *RegionName, STANDARD_INFO_LISTW *RegionStds)
	This function gives list of supported communication standards for a particular region. More...
RFID_STATUS WINAPI	RFID_GetRegionStandardListA (RFID_HANDLE32 readerManagementHandle, CHAR *RegionName, STANDARD_INFO_LISTA *RegionStds)
RFID_STATUS WINAPI	RFID_SetActiveRegionW (RFID_HANDLE32 readerManagementHandle, WCHAR *RegionName, WCHAR *CommunicationStandardName)
	Set particular region as active region. More...
RFID_STATUS WINAPI	RFID_SetActiveRegionA (RFID_HANDLE32 readerManagementHandle, CHAR *RegionName, CHAR *CommunicationStandardName)
RFID_STATUS WINAPI	RFID_SetFrequencySetting (RFID_HANDLE32 readerManagementHandle, BOOLEAN bEnableFrequencyHopping, CHANNEL_LIST *lpChannelTable)
	Set freq-hopping with a list of supported channel indexes for active region. More...
RFID_STATUS WINAPI	RFID_GetActiveRegionInfoW (RFID_HANDLE32 readerManagementHandle, ACTIVE_REGION_INFOW *ActiveRegionInfo)
	Get region information which is currently active region and frequency settings. More...
RFID_STATUS WINAPI	RFID_GetActiveRegionInfoA (RFID_HANDLE32 readerManagementHandle, ACTIVE_REGION_INFOA *ActiveRegionInfo)
RFID_STATUS WINAPI	RFID_GetActiveRegionStandardInfoW (RFID_HANDLE32 readerManagementHandle, STANDARD_REGION_INFOW *CurrentActiveRegionStandardInfo)
	Get active region standard information. More...
RFID_STATUS WINAPI	RFID_GetActiveRegionStandardInfoA (RFID_HANDLE32 readerManagementHandle, STANDARD_REGION_INFOA *CurrentActiveRegionStandardInfo)
RFID_STATUS WINAPI	RFID_ChangePasswordW (RFID_HANDLE32 readerManagementHandle, USER_INFOW *lpUserInfo)
	This function changes the password for the given user. More...
RFID_STATUS WINAPI	RFID_ChangePasswordA (RFID_HANDLE32 readerManagementHandle, LPUSER_INFOA lpUserInfo)
	This function changes the password for the given user. More...
RFID_STATUS WINAPI	RFID_GetPowerNegotiationState (RFID_HANDLE32 readerManagementHandle, BOOLEAN *lpPowerNegotiationState)
	This function gets the power negotiation state of the RFID Reader. More...
RFID_STATUS WINAPI	RFID_SetPowerNegotiationState (RFID_HANDLE32 readerManagementHandle, BOOLEAN powerNegotiationState)
	This function sets the power negotiation state of the RFID Reader. More...
RFID_STATUS WINAPI	RFID_GetPowerNegotiationStatus (RFID_HANDLE32 readerManagementHandle, POWER_NEGOTIATION_STATUS *lpPowerNegotiationStatus)
	This function gets the Power Negotiation Status of the RFID reader. More...
RFID_STATUS WINAPI	RFID_SetNTPServerW (RFID_HANDLE32 readerManagementHandle, LPTIME_SERVER_INFOW lpTimeServerInfo)
	This function sets the NTP Server configuration. More...
RFID_STATUS WINAPI	RFID_SetNTPServerA (RFID_HANDLE32 readerManagementHandle, LPTIME_SERVER_INFOA lpTimeServerInfo)
	This function sets the NTP Server configuration. More...
RFID_STATUS WINAPI	RFID_GetNTPServerW (RFID_HANDLE32 readerManagementHandle, LPTIME_SERVER_INFOW lpTimeServerInfo)
	This function gets the NTP Server configuration. More...
RFID_STATUS WINAPI	RFID_GetNTPServerA (RFID_HANDLE32 readerManagementHandle, LPTIME_SERVER_INFOA lpTimeServerInfo)
	This function gets the NTP Server configuration. More...
RFID_STATUS WINAPI	RFID_SetSysLogServerW (RFID_HANDLE32 readerManagementHandle, LPSYSLOG_SERVER_INFOW lpSysLogServerInfo)
	This function sets the SysLog Server configuration. More...
RFID_STATUS WINAPI	RFID_SetSysLogServerA (RFID_HANDLE32 readerManagementHandle, LPSYSLOG_SERVER_INFOA lpSysLogServerInfo)
	This function sets the SysLog Server configuration. More...
RFID_STATUS WINAPI	RFID_SetWirelessNetworkW (RFID_HANDLE32 readerManagementHandle, LPWIRELESS_CONFIGURED_PARAMETERSW lpWirelessConfiguredParameters)
	This function sets the Wireless Network configuration. More...
RFID_STATUS WINAPI	RFID_SetWirelessNetworkA (RFID_HANDLE32 readerManagementHandle, LPWIRELESS_CONFIGURED_PARAMETERSA lpWirelessConfiguredParameters)
	This function sets the Wireless Network configuration. More...
RFID_STATUS WINAPI	RFID_SetNetworkInterfaceSettingsW (RFID_HANDLE32 readerManagementHandle, LPREADER_NETWORK_INFOW lpnetworkInfo)
	This function sets the Network Interfcae Settings. More...
RFID_STATUS WINAPI	RFID_SetNetworkInterfaceSettingsA (RFID_HANDLE32 readerManagementHandle, LPREADER_NETWORK_INFOA lpnetworkInfo)
	This function sets the Network Interfcae Settings. More...
RFID_STATUS WINAPI	RFID_GetSysLogServerW (RFID_HANDLE32 readerManagementHandle, LPSYSLOG_SERVER_INFOW lpSysLogServerInfo)
	This function gets the SysLog Server configuration. More...
RFID_STATUS WINAPI	RFID_GetSysLogServerA (RFID_HANDLE32 readerManagementHandle, LPSYSLOG_SERVER_INFOA lpSysLogServerInfo)
	This function gets the SysLog Server configuration. More...
RFID_STATUS WINAPI	RFID_GetWirelessConfigParametersA (RFID_HANDLE32 readerManagementHandle, LPWIRELESS_CONFIGURED_PARAMETERSA lpWirelessConfiguredParameters)
	This function gets the Wireless N/W Configuration Parameters. More...
RFID_STATUS WINAPI	RFID_GetWirelessConfigParametersW (RFID_HANDLE32 readerManagementHandle, LPWIRELESS_CONFIGURED_PARAMETERSW lpWirelessConfiguredParameters)
	This function gets the SysLog Server configuration. More...
RFID_STATUS WINAPI	RFID_GetTemperatureStatusW (RFID_HANDLE32 readerManagementHandle, LPTEMPERATURE_STATUSW lpTemperatureStatus)
	This function gets the Temperature Status of the RFID reader. More...
RFID_STATUS WINAPI	RFID_GetTemperatureStatusA (RFID_HANDLE32 readerManagementHandle, LPTEMPERATURE_STATUSA lpTemperatureStatus)
	This function gets the Temperature Status of the RFID reader. More...
RFID_STATUS WINAPI	RFID_GetCountryCodeFromRegion (RFID_HANDLE32 readerManagementHandle, WCHAR *RegionName, UINT32 *CountryCode)
	This function get the country code given the region name. More...
RFID_STATUS WINAPI	RFID_GenerateRegionsConfigFile (RFID_HANDLE32 readerManagementHandle)
	This function is used to generate regions config file in RE40. More...

Detailed Description

Function Documentation

RFID_LoginW()

RFID_STATUS WINAPI RFID_LoginW	(	RFID_HANDLE32 *	pReaderManagementHandle,
		LPLOGIN_INFOW	lpLoginInfo,
		READER_TYPE	readerType,
		BOOLEAN	secureMode,
		LPVOID	rsvd
	)

This function is used to login in to the reader.

Parameters

[out]	pReaderManagementHandle	Returns handle to the Reader Management Interface of the Reader.
[in]	lpLoginInfo	Pointer to LOGIN_INFO (user name & password).
[in]	readerType	Specifies the Reader type (XR, FX or MC).
[in]	secureMode	FALSE for HTTP, TRUE for HTTPS.
[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_COMM_OPEN_ERROR Connection to the Reader Failed.
• RFID_RM_INVALID_USERNAME_PASSWORD Failed due to invalid user name and/or password.
• RFID_RM_LOGIN_ERROR Failed to Login due to unspecified error.
• RFID_API_PARAM_ERROR Parameter Error.

Remarks

All further Reader Management functions requires providing the handle readerManagementHandle. This function is applicable for the readers which supports HTTP web interface and the login command. This function can be used wherever login and logout process is required with the reader. Some readers do not allow full functionality over HTTP if there is an LLRP connection existing to the reader, in which case it may be required to call RFID_Disconnect to exercise full Reader Management functionality. Even though Hand-Held / Device-based Readers like MC does not have web-interface it is required to call this function with lpLoginInfo as NULL, and readerType as MC.

See also

RFID_Logout

Remarks

Example:

RFID_HANDLE32 readerManagementHandle;
RFID_STATUS rfidStatus = RFID_API_SUCCESS;
LOGIN_INFO loginInfo;
READER_TYPE readerType = XR;
BOOLEAN secureMode = FALSE; // HTTP
READER_SYSTEM_INFO readerSystemInfo;
BOOLEAN antennaStatus = TRUE;
UINT16 antennaID = 1;
ANTENNA_MODE antennaMode;
 
_tcscpy(loginInfo.userName, TEXT("admin"));
_tcscpy(loginInfo.password, TEXT("admin"));
_tcscpy(loginInfo.hostName, TEXT("157.235.207.190"));
 
if(RFID_API_SUCCESS == RFID_Login(&readerManagementHandle,
&loginInfo, readerType, secureMode, NULL))
{
rfidStatus = RFID_GetSystemInfo(readerManagementHandle, &readerSystemInfo);
rfidStatus = RFID_GetAntennaMode(readerManagementHandle, &antennaMode);
printf("\n Antenna mode is %s", antennaMode == ANTENNA_MODE_BISTATIC ?
"Bi-static" : "Mono-static");
if(antennaMode == ANTENNA_MODE_BISTATIC)
rfidStatus = RFID_SetAntennaMode(readerManagementHandle,
ANTENNA_MODE_MONOSTATIC);
rfidStatus = RFID_GetReadPointStatus(readerManagementHandle, antennaID, &antennaStatus);
if(RFID_API_SUCCESS == RFID_EnableReadPoint(readerManagementHandle,
antennaID, antennaStatus))
printf("\n Antenna %d is %s", antennaID, antennaStatus ? "Enabled" : "Disabled");
// Restart the Reader (when required)
rfidStatus = RFID_Restart(readerManagementHandle);
 
RFID_Logout(readerManagementHandle); // Call RFID_Logout so as to clean up the Dll
}

RFID_LoginA()

RFID_STATUS WINAPI RFID_LoginA	(	RFID_HANDLE32 *	pReaderManagementHandle,
		LPLOGIN_INFOA	lpLoginInfo,
		READER_TYPE	readerType,
		BOOLEAN	secureMode,
		LPVOID	rsvd
	)

RFID_Logout()

RFID_STATUS WINAPI RFID_Logout

(

RFID_HANDLE32

readerManagementHandle

)

This function is used to logout from the reader.

Parameters

[in]

readerManagementHandle

Handle returned by RFID_Login.

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

In case of APIs like RFID_Restart, RFID_UpdateSoftware which results in rebooting the reader, it is required to call RFID_Logout so as to clean up the previous connection. In such cases, the application shall login back to the Reader using RFID_Login.

See also

RFID_Login

Remarks

Example: See

RFID_Login

RFID_GetReaderStats()

RFID_STATUS WINAPI RFID_GetReaderStats	(	RFID_HANDLE32	readerManagementHandle,
		UINT16	antennaID,
		LPREADER_STATS	lpReaderStats
	)

This function gets the statistics from the Reader.

The statistics contains only RFID related statistics.

Parameters

[in]	readerManagementHandle	Handle to the RFID device.
[in]	antennaID	Antenna ID; cannot be zero.
[out]	lpReaderStats	Pointer to READER_STATS.

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
• RFID_READER_FUNCTION_UNSUPPORTED Unsupported on readers like XR, MC

Remarks

The elements are set to zero if the custom elements like fujistu or nxp aree not supported by the reader

See also

RFID_ClearReaderStats

Remarks

Example:

RFID_ClearReaderStats()

RFID_STATUS WINAPI RFID_ClearReaderStats

(

RFID_HANDLE32

readerManagementHandle

)

This function clears the reader statistics.

Parameters

[in]

readerManagementHandle

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 Invalid handle is provided
• RFID_API_PARAM_ERROR Invalid parameter given
• RFID_READER_FUNCTION_UNSUPPORTED Unsupported on readers like XR, MC

Remarks

None.

See also

RFID_GetReaderStats

Remarks

Example:

RFID_EnableReadPoint()

RFID_STATUS WINAPI RFID_EnableReadPoint	(	RFID_HANDLE32	readerManagementHandle,
		UINT16	antennaID,
		BOOLEAN	status
	)

This function enables a Read-Point, i.e.

Antenna for use using the Reader Management interface.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[in]	antennaID	Antenna ID
[in]	status	Enable-TRUE, Disable-FALSE

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_OUT_OF_RANGE Invalid AntennaID
• RFID_READER_FUNCTION_UNSUPPORTED Unsupported on Device-based readers like MC

Remarks

See also

RFID_GetReadPointStatus

Remarks

Example: See

RFID_Login

RFID_GetReadPointStatus()

RFID_STATUS WINAPI RFID_GetReadPointStatus	(	RFID_HANDLE32	readerManagementHandle,
		UINT16	antennaID,
		BOOLEAN *	pStatus
	)

This function gets the status of a Read-Point, i.e.

Antenna using the Reader Management interface.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[in]	antennaID	Antenna ID
[out]	pStatus	Pointer to status: Enabled-TRUE, Disabled-FALSE

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_OUT_OF_RANGE Invalid AntennaID
• RFID_READER_FUNCTION_UNSUPPORTED Unsupported on Device-based readers like MC

Remarks

See also

RFID_EnableReadPoint

Remarks

Example: See

RFID_Login

RFID_GetReadPointConnectStatus()

RFID_STATUS WINAPI RFID_GetReadPointConnectStatus	(	RFID_HANDLE32	readerManagementHandle,
		UINT16	antennaID,
		BOOLEAN *	pConnectStatus
	)

This function gets the connect status of a Read-Point, i.e.

Antenna using the Reader Management interface.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[in]	antennaID	Antenna ID
[out]	pConnectStatus	Pointer to status: Connected-TRUE, Disconnected-FALSE

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_OUT_OF_RANGE Invalid AntennaID
• RFID_READER_FUNCTION_UNSUPPORTED Unsupported on Device-based readers like MC

Remarks

See also

RFID_GetReadPointStatus

Remarks

Example: See

RFID_Login

RFID_SetAntennaMode()

RFID_STATUS WINAPI RFID_SetAntennaMode	(	RFID_HANDLE32	readerManagementHandle,
		ANTENNA_MODE	antennaMode
	)

This function sets the antenna mode to either mono static or bi-static.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[in]	antennaMode	Specifies Antenna mode of type (ANTENNA_MODE)

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 Device-based readers like MC

Remarks

See also

Remarks

Example: See

RFID_Login

RFID_GetAntennaMode()

RFID_STATUS WINAPI RFID_GetAntennaMode	(	RFID_HANDLE32	readerManagementHandle,
		ANTENNA_MODE *	pAntennaMode
	)

This function gets the antenna mode to either mono-static or bi-static.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[out]	pAntennaMode	Antenna mode of type (ANTENNA_MODE).

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 Device-based readers like MC

Remarks

See also

Remarks

Example: See

RFID_Login

RFID_ExportProfileToReaderW()

RFID_STATUS WINAPI RFID_ExportProfileToReaderW	(	RFID_HANDLE32	readerManagementHandle,
		TCHAR *	pProfileName,
		TCHAR *	pProfilePath,
		BOOLEAN	activation
	)

Function name : RFID_ExportProfileToReader.

This function updates the reader configuration XML file.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[in]	pProfileName	Profile to be uploaded, e.g. "Config.xml".
[in]	pProfilePath	Local Path Of the Profile.
[in]	activation	Determines whether the profile is to be activated or not. If activation is set TRUE, the profile will be uploaded and activated. If activation is set FALSE, the profile will be uploaded but not activated. This value is ignored in XR.

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 Device-based readers like MC

Remarks

See also

RFID_GetProfileList, RFID_SetActiveProfile, RFID_ImportProfileFromReader, RFID_DeleteProfile

Remarks

Example: See

RFID_GetProfileList

RFID_ExportProfileToReaderA()

RFID_STATUS WINAPI RFID_ExportProfileToReaderA	(	RFID_HANDLE32	readerManagementHandle,
		CHAR *	pProfileName,
		CHAR *	pProfilePath,
		BOOLEAN	activation
	)

RFID_ImportProfileFromReaderW()

RFID_STATUS WINAPI RFID_ImportProfileFromReaderW	(	RFID_HANDLE32	readerManagementHandle,
		TCHAR *	pProfileName,
		TCHAR *	pProfilePath
	)

Function name : RFID_ImportProfileFromReader.

This function downloads the reader configuration XML file.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[in]	pProfileName	Profile Name to be downloaded, e.g. "Config.xml".
[in]	pProfilePath	Local Path of the Profile to be saved.

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 Device-based readers like MC

Remarks

See also

RFID_GetProfileList, RFID_SetActiveProfile, RFID_ExportProfileToReader, RFID_DeleteProfile

Remarks

Example: See

RFID_GetProfileList

RFID_ImportProfileFromReaderA()

RFID_STATUS WINAPI RFID_ImportProfileFromReaderA	(	RFID_HANDLE32	readerManagementHandle,
		CHAR *	pProfileName,
		CHAR *	pProfilePath
	)

RFID_GetProfileListW()

RFID_STATUS WINAPI RFID_GetProfileListW	(	RFID_HANDLE32	readerManagementHandle,
		LPPROFILE_LIST	lpProfileList
	)

Function name : RFID_GetProfileList.

This function gets the list of profile available in the reader.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[out]	lpProfileList	Pointer to PROFILE_LIST .

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 XR and Device-based readers like MC

Remarks

See also

RFID_SetActiveProfile, RFID_ImportProfileFromReader, RFID_ExportProfileToReader, RFID_DeleteProfile

Remarks

Example: See

RFID_HANDLE32 readerManagementHandle;
RFID_STATUS rfidStatus = RFID_API_SUCCESS;
LOGIN_INFO loginInfo;
READER_TYPE readerType = FX;
BOOL secureMode=0;
 
_tcscpy(loginInfo.userName, TEXT("admin"));
_tcscpy(loginInfo.password, TEXT("change"));
_tcscpy(loginInfo.hostName, TEXT("157.235.208.51"));
loginInfo.forceLogin = true;
loginInfo.version = RFID_API3_5_1;
 
if(RFID_API_SUCCESS == RFID_Login(&readerManagementHandle, &loginInfo, readerType, secureMode, NULL))
{
PROFILE_LIST profileList;
TCHAR currentFileName[MAX_PATH];
TCHAR newFileName[MAX_PATH];
rfidStatus = RFID_GetProfileList(readerManagementHandle,  &profileList);
if(RFID_API_SUCCESS == rfidStatus)
{
for(int count = 0; count < profileList.numProfiles; count++)
printf("\n%d. %S",count+1,  profileList.pProfileName[count]);
_stprintf(currentFileName, TEXT("%s"), profileList.pProfileName[0]);
_stprintf(newFileName, TEXT("new%s"), currentFileName);
}
 
rfidStatus = RFID_ImportProfileFromReader(readerManagementHandle,  currentFileName, TEXT(".\\"));
if(RFID_API_SUCCESS == rfidStatus)
{
CopyFile(currentFileName, newFileName, false);
// can change some profile settings if needed
// and export it back to reader
rfidStatus = RFID_ExportProfileToReader(readerManagementHandle,  newFileName,TEXT(".\\"), FALSE);
rfidStatus = RFID_SetActiveProfile(readerManagementHandle, newFileName);
}
rfidStatus = RFID_SetActiveProfile(readerManagementHandle, currentFileName);
rfidStatus = RFID_DeleteProfile(readerManagementHandle, newFileName);
 
RFID_Logout(readerManagementHandle); // Logout so that Dll is cleaned up
}

RFID_GetProfileListA()

RFID_STATUS WINAPI RFID_GetProfileListA	(	RFID_HANDLE32	readerManagementHandle,
		LPPROFILE_LISTA	lpProfileList
	)

RFID_SetActiveProfileW()

RFID_STATUS WINAPI RFID_SetActiveProfileW	(	RFID_HANDLE32	readerManagementHandle,
		WCHAR *	pProfileName
	)

Function name : RFID_SetActiveProfile.

This function sets the profile as active profile in the reader.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[in]	pProfileName	Pointer to Profile Name .

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 XR and Device-based readers like MC

Remarks

Setting a Profile as Active disconnects the existing LLRP connection on FX Series Readers and hence applications can connect back to the Reader using RFID_Connect.

See also

RFID_GetProfileList, RFID_DeleteProfile, RFID_ImportProfileFromReader, RFID_ExportProfileToReader,

Remarks

Example: See

RFID_GetProfileList

RFID_SetActiveProfileA()

RFID_STATUS WINAPI RFID_SetActiveProfileA	(	RFID_HANDLE32	readerManagementHandle,
		CHAR *	pProfileName
	)

RFID_DeleteProfileW()

RFID_STATUS WINAPI RFID_DeleteProfileW	(	RFID_HANDLE32	readerManagementHandle,
		WCHAR *	pProfileName
	)

Function name : RFID_DeleteProfile.

This function deletes the profile from the reader.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[in]	pProfileName	Pointer to Profile Name.

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 XR and Device-based readers like MC

Remarks

See also

RFID_GetProfileList, RFID_SetActiveProfile, RFID_ImportProfileFromReader, RFID_ExportProfileToReader

Remarks

Example: See

RFID_GetProfileList

RFID_DeleteProfileA()

RFID_STATUS WINAPI RFID_DeleteProfileA	(	RFID_HANDLE32	readerManagementHandle,
		CHAR *	pProfileName
	)

RFID_UpdateSoftwareW()

RFID_STATUS WINAPI RFID_UpdateSoftwareW	(	RFID_HANDLE32	readerManagementHandle,
		LPFTPSERVER_INFOW	lpFtpLoginInfo
	)

This function updates the reader firmware software from the FTP/SCP server.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[in]	lpFtpLoginInfo	Pointer to FTPSERVER_INFO which contains the Reader's OSUpdate software.

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 Device-based readers like MC

Remarks

This function is valid only for Fixed Readers and not Handhelds. The firmware update status can be tracked with RFID_GetUpdateStatus. The readerHandle restarts after the Software update is complete. It is necessary to call RFID_Logout so as to clean up the Dll. To reconnect, call RFID_Login.

See also

RFID_GetUpdateStatus

Remarks

Example:

RFID_HANDLE32 readerManagementHandle;
RFID_STATUS rfidStatus = RFID_API_SUCCESS;
LOGIN_INFO loginInfo;
READER_TYPE readerType = XR;
BOOLEAN secureMode=0;
UPDATE_STATUS updateStatus;
 
_tcscpy(loginInfo.userName, TEXT("admin"));
_tcscpy(loginInfo.password, TEXT("admin"));
_tcscpy(loginInfo.hostName, TEXT("157.235.207.190"));
 
if(RFID_API_SUCCESS == RFID_Login(&readerManagementHandle,
&loginInfo, readerType, secureMode, NULL))
{
_tcscpy_s(loginInfo.userName, TEXT(""));
_tcscpy_s(loginInfo.password, TEXT(""));
_tcscpy_s(loginInfo.hostName,
TEXT("ftp://157.235.88.198/pub/XR400/TestRelease/Rev_3_3_7"));
 
rfidStatus = RFID_UpdateSoftware(readerManagementHandle, &loginInfo);
updateStatus.percentage = 0;
while(100 != updateStatus.percentage)
{
updateStatus.percentage=0;
rfidStatus = RFID_GetUpdateStatus(readerManagementHandle, &updateStatus);
if(RFID_RM_NO_UPDATION_IN_PROGRESS == rfidStatus)
break;
Sleep(10000);
}
RFID_Logout(readerManagementHandle); // Logout so that Dll is cleaned up
}

RFID_UpdateSoftwareA()

RFID_STATUS WINAPI RFID_UpdateSoftwareA	(	RFID_HANDLE32	readerManagementHandle,
		LPFTPSERVER_INFOA	lpFtpLoginInfo
	)

RFID_GetUpdateStatusW()

RFID_STATUS WINAPI RFID_GetUpdateStatusW	(	RFID_HANDLE32	readerManagementHandle,
		LPUPDATE_STATUSW	lpStatus
	)

This function gets the firmware/software update status from the reader.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[out]	lpStatus	Pointer to UPDATE_STATUS .

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

See also

Remarks

Example: See

RFID_UpdateSoftware

RFID_GetUpdateStatusA()

RFID_STATUS WINAPI RFID_GetUpdateStatusA	(	RFID_HANDLE32	readerManagementHandle,
		LPUPDATE_STATUSA	lpStatus
	)

RFID_GetFilesToUpdateW()

RFID_STATUS WINAPI RFID_GetFilesToUpdateW	(	RFID_HANDLE32	readerManagementHandle,
		LPFILE_UPDATE_LISTW	lpFileUpdateList
	)

Function name : RFID_GetFilesToUpdate.

This function gets the list of files names to update the reader software.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[out]	lpFileUpdateList	Pointer to FILE_UPDATE_LIST

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 XR and Device-based readers like MC

Remarks

response.txt availabe as part of firmare package must be placed in "\var\volatile" folder of the reader

See also

RFID_

Remarks

Example: See

RFID_HANDLE32 readerManagementHandle;
RFID_STATUS rfidStatus = RFID_API_SUCCESS;
LOGIN_INFO loginInfo;
READER_TYPE readerType = FX;
BOOL secureMode=0;
 
_tcscpy(loginInfo.userName, TEXT("admin"));
_tcscpy(loginInfo.password, TEXT("change"));
_tcscpy(loginInfo.hostName, TEXT("157.235.208.51"));
loginInfo.forceLogin = true;
loginInfo.version = RFID_API3_5_1;
 
if(RFID_API_SUCCESS == RFID_Login(&readerManagementHandle, &loginInfo, readerType, secureMode, NULL))
{
    PROFILE_LIST profileList;
    TCHAR currentFileName[MAX_PATH];
    TCHAR newFileName[MAX_PATH];
    rfidStatus = RFID_GetProfileList(readerManagementHandle,  &profileList);
    if(RFID_API_SUCCESS == rfidStatus)
    {
    for(int count = 0; count < profileList.numProfiles; count++)
    printf("\n%d. %S",count+1,  profileList.pProfileName[count]);
    _stprintf(currentFileName, TEXT("%s"), profileList.pProfileName[0]);
    _stprintf(newFileName, TEXT("new%s"), currentFileName);
} 
RFID_Logout(readerManagementHandle); // Logout so that Dll is cleaned up** 

RFID_GetFilesToUpdateA()

RFID_STATUS WINAPI RFID_GetFilesToUpdateA	(	RFID_HANDLE32	readerManagementHandle,
		LPFILE_UPDATE_LISTA	lpFileUpdateList
	)

RFID_UpdatePartition()

RFID_STATUS WINAPI RFID_UpdatePartition	(	RFID_HANDLE32	readerManagementHandle,
		UINT16	partitionIndex
	)

This function updates the partition for the given partition index.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[in]	partitionIndex	Partition Zone Index (zero based) which are retrived from RFID_GetFilesToUpdate

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 XR and Device-based readers like MC

Remarks

See also

RFID_GetFilesToUpdate, RFID_UpdatePartition, RFID_GetUpdatePartitionStatus, RFID_UpdateComplete

Remarks

Example: See

RFID_GetUpdatePartitionStatusW()

RFID_STATUS WINAPI RFID_GetUpdatePartitionStatusW	(	RFID_HANDLE32	readerManagementHandle,
		LPUPDATE_PARTITION_STATUSW	lpStatus
	)

This function gets the partition update status.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[out]	lpStatus	Pointer to UPDATE_PARTITION_STATUS .

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

See also

Remarks

Example: See

RFID_UpdatePartition

RFID_GetUpdatePartitionStatusA()

RFID_STATUS WINAPI RFID_GetUpdatePartitionStatusA	(	RFID_HANDLE32	readerManagementHandle,
		LPUPDATE_PARTITION_STATUSA	lpStatus
	)

RFID_UpdateComplete()

RFID_STATUS WINAPI RFID_UpdateComplete

(

RFID_HANDLE32

readerManagementHandle

)

This function completes the single file update and reboots the reader.

Parameters

[in]

readerManagementHandle

Handle returned by RFID_Login.

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

See also

Remarks

Example: See

RFID_UpdatePartition

RFID_UpdateRadioFirmwareW()

RFID_STATUS WINAPI RFID_UpdateRadioFirmwareW	(	RFID_HANDLE32	readerManagementHandle,
		TCHAR *	pFileName
	)

This function updates the radio firmware.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[in]	pFileName	String containing the name of firmware update file.

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, FX

Remarks

This function is valid only for Handheld Readers. As the radio would restart after the update, it is required to call RFID_Logout to clean up the Dll's existing connection and call RFID_Login again to get a valid Handle.

See also

Remarks

Example:

RFID_HANDLE32 readerManagementHandle, readerHandle;
RFID_STATUS rfidStatus;
UPDATE_STATUS UpdateStatus;
rfidStatus = RFID_Login(&readerManagementHandle, NULL, MC, false, NULL);
if(rfidStatus == RFID_API_SUCCESS)
{
rfidStatus = RFID_UpdateRadioFirmware(readerManagementHandle, L"sailfish.0.2.41.a79");
if(rfidStatus == RFID_API_SUCCESS)
{
do
{
Sleep(1000);
rfidStatus = RFID_GetUpdateStatus(readerManagementHandle, &UpdateStatus);
if(rfidStatus == RFID_RM_NO_UPDATION_IN_PROGRESS)
break;
}while(UpdateStatus.percentage != 100);
RFID_Logout(readerManagementHandle); // Logout so that Dll is cleaned up
}
}

RFID_UpdateRadioFirmwareA()

RFID_STATUS WINAPI RFID_UpdateRadioFirmwareA	(	RFID_HANDLE32	readerManagementHandle,
		CHAR *	pFileName
	)

RFID_UpdateRadioConfigW()

RFID_STATUS WINAPI RFID_UpdateRadioConfigW	(	RFID_HANDLE32	readerManagementHandle,
		TCHAR *	pFileName
	)

This function updates the radio config data (OEM data)

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[in]	pFileName	String containing the name of config update file.

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, FX

Remarks

This function is valid only for Handheld reader. As the radio would restart after the update, it is required to call RFID_Logout to clean up the Dll's existing connection and call RFID_Login again to get a valid Handle.

See also

Remarks

Example:

RFID_HANDLE32 readerManagementHandle, readerHandle;
RFID_STATUS rfidStatus;
UPDATE_STATUS UpdateStatus;
rfidStatus = RFID_Login(&readerManagementHandle, NULL, MC, false, NULL);
if(rfidStatus == RFID_API_SUCCESS)
{
rfidStatus = RFID_UpdateRadioConfig(readerManagementHandle, L"SAILFISH_OEMCFG_245.dmp");
if(rfidStatus == RFID_API_SUCCESS)
{
do
{
Sleep(1000);
rfidStatus = RFID_GetUpdateStatus(readerManagementHandle, &UpdateStatus);
if(rfidStatus == RFID_RM_NO_UPDATION_IN_PROGRESS)
break;
}while(UpdateStatus.percentage != 100);
RFID_Logout(readerManagementHandle); // Logout so that Dll is cleaned up
}

RFID_UpdateRadioConfigA()

RFID_STATUS WINAPI RFID_UpdateRadioConfigA	(	RFID_HANDLE32	readerManagementHandle,
		CHAR *	pFileName
	)

RFID_Restart()

RFID_STATUS WINAPI RFID_Restart

(

RFID_HANDLE32

readerManagementHandle

)

This function issues a restart command to the RFID device.

Parameters

[in]

readerManagementHandle

Handle returned by RFID_Login.

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_COMM_OPEN_ERROR Unable to establish the communication with the reader
• RFID_COMMAND_TIMEOUT Timeout and no responses from the reader

Remarks

It is necessary to call RFID_Logout after calling RFID_Restart so as to clean up the Dll. To reconnect, call RFID_Login.

See also

Remarks

Example: See

RFID_Login

RFID_FactoryReset()

RFID_STATUS WINAPI RFID_FactoryReset

(

RFID_HANDLE32

readerManagementHandle

)

This function issues a Reset to Factory Defaults command to the RFID device.

Parameters

[in]

readerManagementHandle

Handle returned by RFID_Login.

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_COMM_OPEN_ERROR Unable to establish the communication with the reader
• RFID_COMMAND_TIMEOUT Timeout and no responses from the reader

Remarks

It is necessary to call RFID_Logout after calling RFID_Restart so as to clean up the Dll. To reconnect, call RFID_Login.

See also

Remarks

Example: See

RFID_Login

RFID_GetHealthStatus()

RFID_STATUS WINAPI RFID_GetHealthStatus	(	RFID_HANDLE32	readerManagementHandle,
		SERVICE_ID	serviceID,
		HEALTH_STATUS *	pHealthStatus,
		LPVOID	rsvd
	)

This function gets the health status of the RFID reader.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[in]	serviceID	Service ID to get the health status
[out]	pHealthStatus	Gets the status whether UP or DOWN
[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_COMM_OPEN_ERROR Unable to establish the communication with the reader
• RFID_COMMAND_TIMEOUT Timeout and no responses from the reader

See also

Remarks

Example: See

RFID_Login

RFID_GetUSBOperationMode()

RFID_STATUS WINAPI RFID_GetUSBOperationMode	(	RFID_HANDLE32	readerManagementHandle,
		LPUSB_OPERATION_INFO	lpUsbOperationInfo
	)

This function gets the USB operation settings of the RFID Reader.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[out]	lpUsbOperationInfo	Pointer to USB_OPERATION_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 Handle provided is invalid
• RFID_READER_FUNCTION_UNSUPPORTED Unsupported on Device-based readers like MC

Remarks

See also

RFID_SetUSBOperationMode

Remarks

Example:

// USB Operation Mode
RFID_HANDLE32 readerManagementHandle;
RFID_STATUS rfidStatus = RFID_API_SUCCESS;
LOGIN_INFO loginInfo;
READER_TYPE readerType = FX;
BOOL secureMode=0;
 
_tcscpy(loginInfo.userName, TEXT("admin"));
_tcscpy(loginInfo.password, TEXT("change"));
_tcscpy(loginInfo.hostName, TEXT("157.235.208.51"));
loginInfo.forceLogin = true;
loginInfo.version = RFID_API3_5_1;
 
if(RFID_API_SUCCESS == RFID_Login(&readerManagementHandle, &loginInfo, readerType, secureMode, NULL))
{
// Get USB Operation Mode
USB_OPERATION_INFO usbOperationInfo;
rfidStatus = RFID_GetUSBOperationMode(readerManagementHandle, &usbOperationInfo);
 
if(RFID_API_SUCCESS == rfidStatus)
{
if (usbOperationInfo.mode == ACTIVE_SYNC)
printf("Operation Mode\t: Active Sync\t Allow LLRP Connection Over ride \t: %s",  usbOperationInfo.allowLLRPConnectionOverride ? "true" : "false");
else if (usbOperationInfo.mode == NETWORK)
printf("Operation Mode\t: Network\t Allow LLRP Connection Over ride \t: %s",  usbOperationInfo.allowLLRPConnectionOverride ? "true" : "false");
 
}
 
// Set USB Operation Mode to Network (Virtual Network over USB)
usbOperationInfo.mode = NETWORK;
usbOperationInfo.allowLLRPConnectionOverride = true;
rfidStatus = RFID_SetUSBOperationMode(readerManagementHandle, &usbOperationInfo);
 
RFID_Logout(readerManagementHandle); // Logout so that Dll is cleaned up
}

RFID_SetUSBOperationMode()

RFID_STATUS WINAPI RFID_SetUSBOperationMode	(	RFID_HANDLE32	readerManagementHandle,
		LPUSB_OPERATION_INFO	lpUsbOperationInfo
	)

This function sets the USB operation Mode settings of the RFID Reader.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[in]	lpUsbOperationInfo	Pointer to USB_OPERATION_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 Handle provided is invalid
• RFID_READER_FUNCTION_UNSUPPORTED Unsupported on Device-based readers like MC

Remarks

See also

RFID_GetUSBOperationMode

Remarks

Example: See

RFID_GetUSBOperationMode

RFID_GetGPIDebounceTime()

RFID_STATUS WINAPI RFID_GetGPIDebounceTime	(	RFID_HANDLE32	readerManagementHandle,
		UINT32 *	pDebounceTimeMilliseconds,
		LPVOID	rsvd
	)

This function gets the GPI debounce time of the RFID Reader.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[in]	pDebounceTimeMilliseconds	Pointer to GPI Debounce time (in Milliseconds)
[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_READER_FUNCTION_UNSUPPORTED Unsupported on Device-based readers like MC

Remarks

The debounce time is used to filter out unwanted GPI signals. If the debounce time is greater than that GPI’s on time, then the GPI will be ignored. If the debounce time is less that the GPI on time, then the GPI will be detected.

See also

RFID_SetGPIDebounceTime

Remarks

Example: See

// GPI Debounce Time
RFID_HANDLE32 readerManagementHandle;
RFID_STATUS rfidStatus = RFID_API_SUCCESS;
LOGIN_INFO loginInfo;
READER_TYPE readerType = FX;
BOOL secureMode=0;
 
_tcscpy(loginInfo.userName, TEXT("admin"));
_tcscpy(loginInfo.password, TEXT("change"));
_tcscpy(loginInfo.hostName, TEXT("157.235.208.51"));
loginInfo.forceLogin = true;
loginInfo.version = RFID_API3_5_1;
 
if(RFID_API_SUCCESS == RFID_Login(&readerManagementHandle, &loginInfo, readerType, secureMode, NULL))
{
// Get GPI Debounce Time
UINT32 debounceTime = 0;
rfidStatus = RFID_GetGPIDebounceTime(readerManagementHandle, &debounceTime, NULL);
 
if(RFID_API_SUCCESS == rfidStatus)
printf("Current GPI Debounce Time\t: %d", debounceTime);
 
// Set GPI Debounce Time
debounceTime = 50; // 50 milliseconds
rfidStatus = RFID_SetGPIDebounceTime(readerManagementHandle, debounceTime, NULL);
 
RFID_Logout(readerManagementHandle); // Logout so that Dll is cleaned up
}

RFID_SetGPIDebounceTime()

RFID_STATUS WINAPI RFID_SetGPIDebounceTime	(	RFID_HANDLE32	readerManagementHandle,
		UINT32	debounceTimeMilliseconds,
		LPVOID	rsvd
	)

This function sets the GPI Debounce time of the RFID Reader.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[in]	debounceTimeMilliseconds	Specifies GPI debounce time (in Milliseconds)
[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_READER_FUNCTION_UNSUPPORTED Unsupported on Device-based readers like MC

Remarks

The allowed range for debounceTimeMilliseconds is 0 - 60000 Ms for FX series, validated at reader.

See also

Remarks

Example: See

See RFID_GetGPIDebounceTime

RFID_SetUserLED()

RFID_STATUS WINAPI RFID_SetUserLED	(	RFID_HANDLE32	readerManagementHandle,
		LPLED_INFO	lpLedInfo
	)

This function sets User LED of the RFID Reader.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[in]	lpLedInfo	Pointer to LED Info contains LED color, duration (in Seconds) & whether to blink

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 Device-based readers like MC

Remarks

None

See also

Remarks

Example: See

RFID_HANDLE32 readerManagementHandle;
RFID_STATUS rfidStatus = RFID_API_SUCCESS;
LOGIN_INFO loginInfo;
READER_TYPE readerType = FX;
BOOL secureMode=0;
 
_tcscpy(loginInfo.userName, TEXT("admin"));
_tcscpy(loginInfo.password, TEXT("change"));
_tcscpy(loginInfo.hostName, TEXT("157.235.208.51"));
loginInfo.forceLogin = true;
loginInfo.version = RFID_API3_5_1;
 
if(RFID_API_SUCCESS == RFID_Login(&readerManagementHandle, &loginInfo, readerType, secureMode, NULL))
{
LED_INFO LedInfo;
LedInfo.ledColor = LED_RED;
LedInfo.durationSeconds = 3;
LedInfo.blink = true;
// Set USER LED LED, duration 3000, blink = true
rfidStatus = RFID_SetUserLED(readerManagementHandle, &LedInfo);
 
RFID_Logout(readerManagementHandle); // Logout so that Dll is cleaned up
}

RFID_GetLocalTime()

RFID_STATUS WINAPI RFID_GetLocalTime	(	RFID_HANDLE32	readerManagementHandle,
		LPSYSTEMTIME	lpSystemTime
	)

This function gets the local time of the RFID Reader.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[in]	lpSystemTime	Pointer to Reader Local Time

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 Device-based readers like MC

Remarks

See also

RFID_SetLocalTime, RFID_GetTimeZoneList, RFID_SetTimeZone

Remarks

Example: See

RFID_HANDLE32 readerManagementHandle;
RFID_STATUS rfidStatus = RFID_API_SUCCESS;
LOGIN_INFO loginInfo;
READER_TYPE readerType = FX;
BOOL secureMode=0;
 
_tcscpy(loginInfo.userName, TEXT("admin"));
_tcscpy(loginInfo.password, TEXT("change"));
_tcscpy(loginInfo.hostName, TEXT("157.235.208.51"));
loginInfo.forceLogin = true;
loginInfo.version = RFID_API3_5_1;
 
if(RFID_API_SUCCESS == RFID_Login(&readerManagementHandle, &loginInfo, readerType, secureMode, NULL))
{
// Get Time Zone List
TIME_ZONE_LIST timeZoneList;
UINT16 orgActiveTimeZoneIndex = 0;
 
rfidStatus = RFID_GetTimeZoneList(readerManagementHandle, &timeZoneList);
 
if(RFID_API_SUCCESS == rfidStatus)
{
for(int nIndex = 0; nIndex < timeZoneList.numTimeZones; nIndex++)
{
printf("\n%d\t: %S",nIndex, timeZoneList.pTimeZone[nIndex]);
}
printf("Active Time Zone Index\t: %d", timeZoneList.activeTimeZoneIndex);
}
// Set Time Zone
rfidStatus = RFID_SetTimeZone(readerManagementHandle, 1);
 
 
// Get Local Time
SYSTEMTIME readerTime;
rfidStatus = RFID_GetLocalTime(readerManagementHandle, &readerTime);
// Set Local Time of the PC
GetLocalTime(&readerTime);
rfidStatus = RFID_SetLocalTime(readerManagementHandle, &readerTime);
 
RFID_Logout(readerManagementHandle); // Logout so that Dll is cleaned up
}

RFID_SetLocalTime()

RFID_STATUS WINAPI RFID_SetLocalTime	(	RFID_HANDLE32	readerManagementHandle,
		LPSYSTEMTIME	lpSystemTime
	)

This function sets Local time of the RFID Reader.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[in]	lpSystemTime	Pointer to Reader Local Time

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 Device-based readers like MC

Remarks

See also

RFID_GetLocalTime, RFID_GetTimeZoneList, RFID_SetTimeZone

Remarks

Example: See

RFID_GetLocalTime

RFID_SetReaderInfoW()

RFID_STATUS WINAPI RFID_SetReaderInfoW	(	RFID_HANDLE32	readerManagementHandle,
		LPREADER_INFOW	lpReaderInfo
	)

This function sets the Reader information in the reader.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[out]	lpReaderInfo	Pointer to READER_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 Handle provided is invalid
• RFID_READER_FUNCTION_UNSUPPORTED Unsupported on Device-based readers like MC

Remarks

See also

RFID_GetReaderInfo

Remarks

Example: See

See RFID_GetReaderInfo

RFID_SetReaderInfoA()

RFID_STATUS WINAPI RFID_SetReaderInfoA	(	RFID_HANDLE32	readerManagementHandle,
		LPREADER_INFOA	lpReaderInfo
	)

RFID_GetReaderInfoW()

RFID_STATUS WINAPI RFID_GetReaderInfoW	(	RFID_HANDLE32	readerManagementHandle,
		LPREADER_INFOW	lpReaderInfo
	)

This function gets the Reader information in the reader.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[out]	lpReaderInfo	Pointer to READER_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 Handle provided is invalid
• RFID_READER_FUNCTION_UNSUPPORTED Unsupported on Device-based readers like MC

Remarks

See also

RFID_SetReaderInfo

Remarks

Example: See

RFID_HANDLE32 readerManagementHandle;
RFID_STATUS rfidStatus = RFID_API_SUCCESS;
LOGIN_INFO loginInfo;
READER_TYPE readerType = FX;
BOOL secureMode=0;
 
_tcscpy(loginInfo.userName, TEXT("admin"));
_tcscpy(loginInfo.password, TEXT("change"));
_tcscpy(loginInfo.hostName, TEXT("157.235.208.51"));
loginInfo.forceLogin = true;
loginInfo.version = RFID_API3_5_1;
 
if(RFID_API_SUCCESS == RFID_Login(&readerManagementHandle, &loginInfo, readerType, secureMode, NULL))
{
READER_INFO readerInfo;
rfidStatus = RFID_GetReaderInfo(readerManagementHandle, &readerInfo);
_tcscpy(readerInfo.name, TEXT("API3 Test Reader - 1"));
_tcscpy(readerInfo.description, TEXT("Description1"));
_tcscpy(readerInfo.location, TEXT("RFID Bay - 1"));
_tcscpy(readerInfo.contact, TEXT("Ext - 2377"));
 
rfidStatus = RFID_SetReaderInfo(readerManagementHandle, &readerInfo);
 
RFID_Logout(readerManagementHandle); // Logout so that Dll is cleaned up
}

RFID_GetReaderInfoA()

RFID_STATUS WINAPI RFID_GetReaderInfoA	(	RFID_HANDLE32	readerManagementHandle,
		LPREADER_INFOA	lpReaderInfo
	)

RFID_GetTimeZoneListW()

RFID_STATUS WINAPI RFID_GetTimeZoneListW	(	RFID_HANDLE32	readerManagementHandle,
		LPTIME_ZONE_LISTW	lpTimeZoneList
	)

Function name : RFID_GetTimeZoneList.

This function gets the list of Time Zone supported by the reader.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[out]	lpTimeZoneList	Pointer to TIME_ZONE_LIST.

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 XR and Device-based readers like MC

Remarks

See also

RFID_GetLocalTime, RFID_SetLocalTime, RFID_SetTimeZone

Remarks

Example: See

RFID_GetLocalTime

RFID_GetTimeZoneListA()

RFID_STATUS WINAPI RFID_GetTimeZoneListA	(	RFID_HANDLE32	readerManagementHandle,
		LPTIME_ZONE_LISTA	lpTimeZoneList
	)

RFID_SetTimeZone()

RFID_STATUS WINAPI RFID_SetTimeZone	(	RFID_HANDLE32	readerManagementHandle,
		UINT16	timeZoneIndex
	)

This function sets the time zone index in the reader.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[in]	timeZoneIndex	Time Zone Index (zero based) which are retrived from RFID_GetTimeZoneList

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 XR and Device-based readers like MC

Remarks

See also

RFID_GetLocalTime, RFID_GetLocalTime, RFID_GetTimeZoneList

Remarks

Example: See

RFID_GetLocalTime

RFID_GetSystemInfoW()

RFID_STATUS WINAPI RFID_GetSystemInfoW	(	RFID_HANDLE32	readerManagementHandle,
		LPREADER_SYSTEM_INFO	lpSystemInfo
	)

This function gets the system Information related to the reader.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[out]	lpSystemInfo	Pointer to SYSTEM_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 Handle provided is invalid
• RFID_READER_FUNCTION_UNSUPPORTED Unsupported on XR and Device-based readers like MC

Remarks

See also

Remarks

Example: See

RFID_Login

RFID_GetSystemInfoA()

RFID_STATUS WINAPI RFID_GetSystemInfoA	(	RFID_HANDLE32	readerManagementHandle,
		LPREADER_SYSTEM_INFOA	lpSystemInfo
	)

RFID_GetNetworkInterfaceSettingsW()

RFID_STATUS WINAPI RFID_GetNetworkInterfaceSettingsW	(	RFID_HANDLE32	readerManagementHandle,
		LPREADER_NETWORK_INFOW	lpnetworkInfo
	)

This function gets the Network Information related to the reader.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[out]	lpnetworkInfo	Pointer to SYSTEM_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 Handle provided is invalid -RFID_READER_FUNCTION_UNSUPPORTED Unsupported on XR and Device - based readers like MC

Remarks

See also

Remarks

Example: See

RFID_Login

RFID_GetNetworkInterfaceSettingsA()

RFID_STATUS WINAPI RFID_GetNetworkInterfaceSettingsA	(	RFID_HANDLE32	readerManagementHandle,
		LPREADER_NETWORK_INFOA	lpnetworkInfo
	)

This function gets the Network Information related to the reader.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[out]	lpnetworkInfo	Pointer to SYSTEM_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 Handle provided is invalid -RFID_READER_FUNCTION_UNSUPPORTED Unsupported on XR and Device - based readers like MC

Remarks

See also

Remarks

Example: See

RFID_Login

RFID_GetLLRPConnectionConfigW()

RFID_STATUS WINAPI RFID_GetLLRPConnectionConfigW	(	RFID_HANDLE32	readerManagementHandle,
		LPLLRP_CONNECTION_CONFIGW	lpLLRPConnectionConfig
	)

This function gets the LLRP Connection Configuration from the reader.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[out]	lpLLRPConnectionConfig	Pointer to LLRP_CONNECTION_CONFIG

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 XR and Device-based readers like MC

Remarks

See also

RFID_SetLLRPConnectionConfig, RFID_InitiateLLRPConnectionFromReader, RFID_DisconnectLLRPConnectionFromReader

Remarks

Example: See

RFID_HANDLE32 readerManagementHandle;
RFID_STATUS rfidStatus = RFID_API_SUCCESS;
LOGIN_INFO loginInfo;
READER_TYPE readerType = FX;
BOOL secureMode=0;
UPDATE_STATUS updateStatus;
 
_tcscpy(loginInfo.userName, TEXT("admin"));
_tcscpy(loginInfo.password, TEXT("change"));
_tcscpy(loginInfo.hostName, TEXT("157.235.208.51"));
loginInfo.forceLogin = true;
 
if(RFID_API_SUCCESS == RFID_Login(&readerManagementHandle, &loginInfo, readerType, secureMode, NULL))
{
LLRP_CONNECTION_CONFIG llrpConnectionConfig;
if(RFID_API_SUCCESS == RFID_GetLLRPConnectionConfig(readerManagementHandle, &llrpConnectionConfig))
{
printf("\n Reader is in %s mode", llrpConnectionConfig.isClient ? "Client" : "Server" );
if(!llrpConnectionConfig.isClient)
{
// changing to client mode
llrpConnectionConfig.isClient = true;
_stprintf(llrpConnectionConfig.hostServerIP, TEXT("157.235.207.133"));
if(RFID_API_SUCCESS == RFID_SetLLRPConnectionConfig(readerManagementHandle, &llrpConnectionConfig))
{
printf("\n Reader changed to Client mode");
}
else
llrpConnectionConfig.isClient = false;
}
if(llrpConnectionConfig.isClient = true)
{
// attempt to initiate connection
if(RFID_API_SUCCESS == RFID_InitiateLLRPConnectionFromReader(readerManagementHandle, NULL))
{
// can do RFID_AcceptConnection and call all Generic interface APIs
// finally RFID_DisconnectLLRPConnectionFromReader and RFID_Disconnect
RFID_DisconnectLLRPConnectionFromReader(readerManagementHandle);
}
else
{
printf("\n Could not Initiate LLRPConnection From Reader");
}
}
 
}
RFID_Logout(readerManagementHandle); // Logout so that Dll is cleaned up
}

RFID_GetLLRPConnectionConfigA()

RFID_STATUS WINAPI RFID_GetLLRPConnectionConfigA	(	RFID_HANDLE32	readerManagementHandle,
		LPLLRP_CONNECTION_CONFIGA	lpLLRPConnectionConfig
	)

RFID_SetLLRPConnectionConfigW()

RFID_STATUS WINAPI RFID_SetLLRPConnectionConfigW	(	RFID_HANDLE32	readerManagementHandle,
		LPLLRP_CONNECTION_CONFIGW	lpLLRPConnectionConfig
	)

This function sets the LLRP Connection Configuration at the reader.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[in]	lpLLRPConnectionConfig	Pointer to LLRP_CONNECTION_CONFIG

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 XR and Device-based readers like MC

Remarks

This API can be used to configure the reader in LLRP Client or server mode, and other parameters like port, IP-Address of the host to connect to while in Client mode, etc.

See also

RFID_GetLLRPConnectionConfig, RFID_InitiateLLRPConnectionFromReader, RFID_DisconnectLLRPConnectionFromReader

Remarks

Example: See

RFID_GetLLRPConnectionConfig

RFID_SetLLRPConnectionConfigA()

RFID_STATUS WINAPI RFID_SetLLRPConnectionConfigA	(	RFID_HANDLE32	readerManagementHandle,
		LPLLRP_CONNECTION_CONFIGA	lpLLRPConnectionConfig
	)

RFID_GetLLRPConnectionStatusW()

RFID_STATUS WINAPI RFID_GetLLRPConnectionStatusW	(	RFID_HANDLE32	readerManagementHandle,
		LPLLRP_CONNECTION_STATUSW	lpLLRPConnectionStatus
	)

This function gets the LLRP Connection Status from the reader.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[out]	lpLLRPConnectionStatus	Pointer to LLRP_CONNECTION_STATUS

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 XR and Device-based readers like MC

Remarks

See also

RFID_GetLLRPConnectionStatus, RFID_SetLLRPConnectionConfig, RFID_GetLLRPConnectionConfig, RFID_DisconnectLLRPConnectionFromReader

Remarks

Example: See

RFID_GetLLRPConnectionConfig

RFID_GetLLRPConnectionStatusA()

RFID_STATUS WINAPI RFID_GetLLRPConnectionStatusA	(	RFID_HANDLE32	readerManagementHandle,
		LPLLRP_CONNECTION_STATUSA	lpLLRPConnectionStatus
	)

RFID_InitiateLLRPConnectionFromReader()

RFID_STATUS WINAPI RFID_InitiateLLRPConnectionFromReader	(	RFID_HANDLE32	readerManagementHandle,
		LPVOID	rsvd
	)

This function initiates an LLRP Connection from the reader to the port on the Server-IP as configured in LLRP_CONNECTION_CONFIG.

When the reader is configured in LLRP client mode, an LLRP connection can be initiated from the reader.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[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_READER_FUNCTION_UNSUPPORTED Unsupported on XR and Device-based readers like MC

Remarks

See also

RFID_SetLLRPConnectionConfig, RFID_GetLLRPConnectionConfig, RFID_DisconnectLLRPConnectionFromReader

Remarks

Example: See

RFID_GetLLRPConnectionConfig

RFID_DisconnectLLRPConnectionFromReader()

RFID_STATUS WINAPI RFID_DisconnectLLRPConnectionFromReader

(

RFID_HANDLE32

readerManagementHandle

)

This function disconnects the current LLRP Connection from the reader.

Parameters

[in]

readerManagementHandle

Handle returned by RFID_Login.

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 XR and Device-based readers like MC

Remarks

See also

RFID_SetLLRPConnectionConfig, RFID_GetLLRPConnectionConfig, RFID_InitiateLLRPConnectionFromReader

Remarks

Example: See

RFID_GetLLRPConnectionConfig

RFID_TurnOffRadioWhenIdle()

RFID_STATUS WINAPI RFID_TurnOffRadioWhenIdle	(	RFID_HANDLE32	readerManagementHandle,
		INT32	idleTimeoutSeconds
	)

This function sets the idle timeout for the radio, after which the radio turns off.

Parameters

[in]	readerManagementHandle	Handle to the RFID device .
[in]	idleTimeoutSeconds	Timeout value in seconds.

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 parameters.

Remarks

This API can be used to set the idle mode timeout for the radio. when there is no activity for the specified time the reader will turn off the radio to save power.

See also

RFID_GetRadioIdleTimeout

Remarks

Example: See

RFID_STATUS rfidStatus = RFID_API_SUCCESS;
rfidStatus = RFID_TurnOffRadioWhenIdle(GOOD_RM_HANDLE, 2); //Turn off radio after 2 secs
else if(RFID_API_SUCCESS == rfidStatus)
return true;
else
return false;

RFID_GetRadioIdleTimeout()

RFID_STATUS WINAPI RFID_GetRadioIdleTimeout	(	RFID_HANDLE32	readerManagementHandle,
		INT32 *	pIdleTimeoutSeconds
	)

This function gets the radio idle timeout of the reader.

Parameters

[in]	readerManagementHandle	Handle to the RFID device .
[out]	pIdleTimeoutSeconds	Pointer to integer variable containing timeout in seconds.

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 parameters.

Remarks

This API can be used to get the idle mode timeout of the radio.

See also

RFID_TurnOffRadioWhenIdle

Remarks

Example: See

INT32 RadioTimeOut;
RFID_STATUS rfidStatus=RFID_API_SUCCESS;
rfidStatus = RFID_GetRadioIdleTimeout(GOOD_RM_HANDLE, &RadioTimeOut);
if(RFID_API_SUCCESS == rfidStatus)
   return true;
else
   return false;

RFID_InstallUserAppW()

RFID_STATUS WINAPI RFID_InstallUserAppW	(	RFID_HANDLE32	readerManagementHandle,
		WCHAR *	pPathToPackage
	)

This function installs the application specified by the user on the reader.

Parameters

[in]	readerManagementHandle	Handle to the RFID device.
[in]	pPathToPackage	Pointer to the Absolute path of the package on the host machine.

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 parameters.
• RFID_API_UNKNOWN_ERROR Unknown error during uploading the package to the reader.

Remarks

RFID_InstallUserApp transfers a user application in the .deb format located in pathToPackage to the absolute remote path appName and installs it. The appName should contain the absolute remote path of the package, for ex: /var/volatile/tmp/package.deb". If the autoStart variable is set to TRUE then the application will be started automatically on every boot-up.

See also

RFID_UninstallUserApp, RFID_StartUserApp, RFID_StopUserApp, RFID_GetUserAppRunStatus, RFID_ListUserApps, RFID_SetUserAppAutoStart

Remarks

Example: See

RFID_STATUS rfidStatus = RFID_API_SUCCESS;
rfidStatus = RFID_InstallUserApp(GOOD_RM_HANDLE, “C:\Sample_app.deb”);
if(RFID_API_SUCCESS == rfidStatus)
   return true;
else
   return false;

RFID_InstallUserAppA()

RFID_STATUS WINAPI RFID_InstallUserAppA	(	RFID_HANDLE32	readerManagementHandle,
		CHAR *	pPathToPackage
	)

RFID_UninstallUserAppW()

RFID_STATUS WINAPI RFID_UninstallUserAppW	(	RFID_HANDLE32	readerManagementHandle,
		WCHAR *	pAppName
	)

This function uninstalls the application specified by the user from the reader.

Parameters

[in]	readerManagementHandle	Handle to the RFID device.
[in]	pAppName	Pointer to the name of the application to be uninstalled.

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 parameters.

Remarks

This function uninstalls the application specified by appName from the reader. The appName in this case should be the name of the app specified while creating the .deb package.

See also

RFID_InstallUserApp, RFID_StartUserApp, RFID_StopUserApp, RFID_GetUserAppRunStatus, RFID_ListUserApps, RFID_SetUserAppAutoStart

Remarks

Example: See

RFID_STATUS rfidStatus = RFID_API_SUCCESS;
rfidStatus = RFID_UninstallUserApp(GOOD_RM_HANDLE, “Sample_app”);
if(RFID_API_SUCCESS == rfidStatus)
return true;
else
return false;

RFID_UninstallUserAppA()

RFID_STATUS WINAPI RFID_UninstallUserAppA	(	RFID_HANDLE32	readerManagementHandle,
		CHAR *	pAppName
	)

RFID_StartUserAppW()

RFID_STATUS WINAPI RFID_StartUserAppW	(	RFID_HANDLE32	readerManagementHandle,
		WCHAR *	pAppName
	)

This function starts the application specified by the user.

Parameters

[in]	readerManagementHandle	Handle to the RFID device.
[in]	pAppName	Pointer to the name of the application to be started.

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 parameters.

Remarks

This function starts the application specified by appName. The appName is the name of the application specified while creating the .deb package. Note that this function does not check for any previous instances of the application that might be running and creates a new instance every time it is called. If multiple instance of the application are not desired then it is be addressed by the startup script of the application.

See also

RFID_InstallUserApp, RFID_UninstallUserApp, RFID_StopUserApp, RFID_GetUserAppRunStatus, RFID_ListUserApps, RFID_SetUserAppAutoStart

Remarks

Example: See

RFID_STATUS rfidStatus = RFID_API_SUCCESS;
 
rfidStatus = RFID_StartUserApp(GOOD_RM_HANDLE, “Sample_app”);
if(RFID_API_SUCCESS == rfidStatus)
return true;
else
return false;

RFID_StartUserAppA()

RFID_STATUS WINAPI RFID_StartUserAppA	(	RFID_HANDLE32	readerManagementHandle,
		CHAR *	pAppName
	)

RFID_StopUserAppW()

RFID_STATUS WINAPI RFID_StopUserAppW	(	RFID_HANDLE32	readerManagementHandle,
		WCHAR *	pAppName
	)

This function stops the application specified by the user.

Parameters

[in]	readerManagementHandle	Handle to the RFID device.
[in]	pAppName	Pointer to the name of the application to be started.

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 parameters.

Remarks

This function starts the application specified by appName. The appName is the name of the application specified while creating the .deb package. Note that this function does not kill all the instances of the application that might be running. That is to be addressed by the stop script of the application.

See also

RFID_InstallUserApp, RFID_UninstallUserApp, RFID_StartUserApp, RFID_GetUserAppRunStatus, RFID_ListUserApps, RFID_SetUserAppAutoStart

Remarks

Example: See

RFID_STATUS rfidStatus = RFID_API_SUCCESS;
 
rfidStatus = RFID_StopUserApp(GOOD_RM_HANDLE, “Sample_app”);
if(RFID_API_SUCCESS == rfidStatus)
return true;
else
return false;

RFID_StopUserAppA()

RFID_STATUS WINAPI RFID_StopUserAppA	(	RFID_HANDLE32	readerManagementHandle,
		CHAR *	pAppName
	)

RFID_GetUserAppRunStatusW()

RFID_STATUS WINAPI RFID_GetUserAppRunStatusW	(	RFID_HANDLE32	readerManagementHandle,
		WCHAR *	pAppName,
		BOOLEAN *	pRunStatus
	)

This function gets the run status of the application specified by the user.

Parameters

[in]	readerManagementHandle	Handle to the RFID device.
[in]	pAppName	Pointer to the name of the application whose status is to be retrieved.
[out]	pRunStatus	Pointer to the boolean variable that receives the run status of the application.

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 parameters.

Remarks

This function starts the application specified by appName. The appName is the name of the application specified while creating the .deb package. If the function returns RFID_API_SUCCESS then the runStatus variable contains TRUE if the application is running, FALSE otherwise.

See also

RFID_InstallUserApp, RFID_UninstallUserApp, RFID_StartUserApp, RFID_StopUserApp, RFID_ListUserApps, RFID_SetUserAppAutoStart

Remarks

Example: See

RFID_STATUS rfidStatus = RFID_API_SUCCESS;
BOOLEAN runStatus = FALSE;
rfidStatus = RFID_GetUserAppRunStatus(GOOD_RM_HANDLE, “Sample_app”, &runStatus);
if(rfidStatus == RFID_API_SUCCESS)
{
   if(runStatus == TRUE)
   {
      printf(“App is running”);
   }
   else
   {
      printf(“App is not running”);
      return true;
   }
}
else
{
     return false;
}

RFID_GetUserAppRunStatusA()

RFID_STATUS WINAPI RFID_GetUserAppRunStatusA	(	RFID_HANDLE32	readerManagementHandle,
		CHAR *	pAppName,
		BOOLEAN *	pRunStatus
	)

RFID_ListUserAppsW()

RFID_STATUS WINAPI RFID_ListUserAppsW	(	RFID_HANDLE32	readerManagementHandle,
		LPUSERAPP_LIST	lpAppList
	)

This function lists all the user applications installed on the reader.

Parameters

[in]	readerManagementHandle	Handle to the RFID device.
[out]	lpAppList	Pointer to USERAPP_LIST structure.Contains the list of installed applications. The pointer is handled by the RFID3 API and the user is not expected to clean up the same.

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 parameters.
• RFID_API_CANNOT_ALLOC_MEM Out of memory.

Remarks

This function gets the list of all applications installed on the reader. If on successful return the appList variable is NULL then there are no applications installed.

See also

RFID_InstallUserApp, RFID_UninstallUserApp, RFID_StartUserApp, RFID_StopUserApp, RFID_GetUserAppRunStatus, RFID_SetUserAppAutoStart

Remarks

Example: See

BOOLEAN findApp(TCHAR *testAppName, BOOLEAN *found)
{
     USERAPP_LIST appList;
     LPUSERAPP_LIST temp = NULL;
     RFID_STATUS rfidStatus = RFID_API_SUCCESS;
     
     *found = FALSE;
     
     // RFID_ListUserApps
     rfidStatus = RFID_ListUserApps(GOOD_RM_HANDLE, &appList);
     if(RFID_API_SUCCESS == rfidStatus)
     {
         temp = &appList;
         
         int maxapps=0;
         maxapps = temp->numMaxApps;
         for(int nindex = 0; nindex < maxapps; nindex++)
         {
             if(temp->pUserAppData[nindex].pAppName != NULL)
             {
                 if(_tcscmp(temp->pUserAppData[nindex].pAppName, testAppName) == 0)
                 {
                     *found = TRUE;
                      break;
                 }
             }
         }
     }
     return found;
}

RFID_ListUserAppsA()

RFID_STATUS WINAPI RFID_ListUserAppsA	(	RFID_HANDLE32	readerManagementHandle,
		LPUSERAPP_LISTA	lpAppList
	)

This function lists all the user applications installed on the reader.

Parameters

[in]	readerManagementHandle	Handle to the RFID device.
[out]	lpAppList	Pointer to USERAPP_LIST structure.Contains the list of installed applications. The pointer is handled by the RFID3 API and the user is not expected to clean up the same.

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 parameters.
• RFID_API_CANNOT_ALLOC_MEM Out of memory.

Remarks

This function gets the list of all applications installed on the reader. If on successful return the appList variable is NULL then there are no applications installed.

See also

RFID_InstallUserApp, RFID_UninstallUserApp, RFID_StartUserApp, RFID_StopUserApp, RFID_GetUserAppRunStatus, RFID_SetUserAppAutoStart

Remarks

Example: See RFID_ListUserAppsW

RFID_SetUserAppAutoStartW()

RFID_STATUS WINAPI RFID_SetUserAppAutoStartW	(	RFID_HANDLE32	readerManagementHandle,
		WCHAR *	pAppName,
		BOOLEAN	Enable
	)

This function enables/disables autoStart of the applications specified by the reader.

Parameters

[in]	readerManagementHandle	Handle to the RFID device.
[in]	pAppName	Pointer to the name of the application.
[in]	Enable	Parameter specifying whether the appliaction autostart is to be enabled or disabled.

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 parameters.
• RFID_API_CANNOT_ALLOC_MEM Out of memory.

Remarks

This function enables the application start up on every boot if the Enable parameter is TRUE. Disables auto start otherwise.

See also

RFID_InstallUserApp, RFID_UninstallUserApp, RFID_StartUserApp, RFID_StopUserApp, RFID_GetUserAppRunStatus, RFID_ListUserApps

Remarks

Example: See

RFID_STATUS rfidStatus = RFID_API_SUCCESS;
 
rfidStatus = RFID_ SetUserAppAutoStart(GOOD_RM_HANDLE, “Sample_app”, true);
if(rfidStatus == RFID_API_SUCCESS)
{
return true;
}
else
return false;

RFID_SetUserAppAutoStartA()

RFID_STATUS WINAPI RFID_SetUserAppAutoStartA	(	RFID_HANDLE32	readerManagementHandle,
		CHAR *	pAppName,
		BOOLEAN	Enable
	)

RFID_SetCableLossCompensation()

RFID_STATUS WINAPI RFID_SetCableLossCompensation	(	RFID_HANDLE32	readerManagementHandle,
		UINT16	nTotalAntennasToSet,
		LPCABLE_LOSS_COMPENSATION *	lppCableLossCompensation
	)

This function sets the cable loss compensation settings.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[in]	nTotalAntennasToSet	Total no. of antennas to be set.
[in]	lppCableLossCompensation	array of Structure containing the cable loss compensation 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 Handle provided is invalid
• RFID_READER_FUNCTION_UNSUPPORTED Unsupported on Device-based readers like MC

See also

RFID_GetCableLossCompensation

Remarks

The cable loss compensation can be set for reader. User can set different parameters for different antennas, or can apply the same set of parameter over all antennas. Sending the antenna number as 0 in first set of parameter will apply the same settings over all antennas. If apart from first parameter set, any other parameter set has antenna ID as 0, is considered as invalid parameter and the operation will be canceled.

See also

Remarks

Example: See

CABLE_LOSS_COMPENSATION antenna1, antenna2;
LPCABLE_LOSS_COMPENSATION pCableLossCmpList[] = {&antenna1, &antenna2};
antenna1.antennaID = 1;
antenna1.cableLengthInFt = 22;
antenna1.cableLossPer100Ft = 0.22;
 
antenna2.antennaID = 3;
antenna2.cableLengthInFt = 33.3;
antenna2.cableLossPer100Ft = 0.33;
 
rfidStatus = RFID_SetCableLossCompensation(GOOD_RM_HANDLE, 2, pCableLossCmpList);
if(RFID_API_SUCCESS == rfidStatus)
    return true;
else 
    return false;

RFID_GetCableLossCompensation()

RFID_STATUS WINAPI RFID_GetCableLossCompensation	(	RFID_HANDLE32	readerManagementHandle,
		LPCABLE_LOSS_COMPENSATION	lpCableLossCompensation
	)

This function gets the cable loss compensation setting for given antenna ID.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[in]	lpCableLossCompensation	Pointer to a Structure containing the cable loss compensation info for the specified antenna

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 Device-based readers like MC

Remarks

The cable loss compensation settings can be retrieved for a given antenna ID. Pointer to CABLE_LOSS_COMPENSATION structure object holds the antenna ID, whom cable loss compensation setting has to be read.

See also

RFID_SetCableLossCompensation

Remarks

Example: See

CABLE_LOSS_COMPENSATION antennaCableLoss;
antennaCableLoss.antennaID = 3; // Get the Cable loss compensation setting for antenna ID 3
 
rfidStatus = RFID_GetCableLossCompensation(GOOD_RM_HANDLE, &antennaCableLoss);
if(RFID_API_SUCCESS == rfidStatus)
   return true;
else
   return false;

RFID_GetSupportedRegionListW()

RFID_STATUS WINAPI RFID_GetSupportedRegionListW	(	RFID_HANDLE32	readerManagementHandle,
		REGION_LISTW *	SupportedRegions
	)

This function gives list of supported regions on Reader.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[out]	SupportedRegions	Pointer to structure containg list of regions supported by reader

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

See also

RFID_GetSupportedRegionListW, RFID_GetRegionStandardListW, RFID_SetActiveRegionW, RFID_SetFrequencySetting, RFID_GetActiveRegionInfoW, RFID_GetActiveRegionStandardInfoW

Remarks

Example:

RFID_SetActiveRegionW

RFID_GetSupportedRegionListA()

RFID_STATUS WINAPI RFID_GetSupportedRegionListA	(	RFID_HANDLE32	readerManagementHandle,
		REGION_LISTA *	SupportedRegions
	)

RFID_GetRegionStandardListW()

RFID_STATUS WINAPI RFID_GetRegionStandardListW	(	RFID_HANDLE32	readerManagementHandle,
		WCHAR *	RegionName,
		STANDARD_INFO_LISTW *	RegionStds
	)

This function gives list of supported communication standards for a particular region.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[in]	RegionName	Name of region for which supported standards is required
[out]	RegionStds	List of standards supported by region

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

See also

RFID_GetSupportedRegionListW, RFID_GetRegionStandardListW, RFID_SetActiveRegionW, RFID_SetFrequencySetting, RFID_GetActiveRegionInfoW, RFID_GetActiveRegionStandardInfoW

Remarks

Example:

RFID_SetActiveRegionW

RFID_GetRegionStandardListA()

RFID_STATUS WINAPI RFID_GetRegionStandardListA	(	RFID_HANDLE32	readerManagementHandle,
		CHAR *	RegionName,
		STANDARD_INFO_LISTA *	RegionStds
	)

RFID_SetActiveRegionW()

RFID_STATUS WINAPI RFID_SetActiveRegionW	(	RFID_HANDLE32	readerManagementHandle,
		WCHAR *	RegionName,
		WCHAR *	CommunicationStandardName
	)

Set particular region as active region.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[in]	RegionName	Name of region which needs to be activated
[in]	CommunicationStandardName	Standard of region out of supported standard by given region

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

Default settings will be applied for activated region e.g. for ETSI – frequency hopping and all channels gets enabled by default. Re-initialization of LLRP happens after region is committed into reader. So application is required to call reader connect (RFID_Connect) again

See also

RFID_GetSupportedRegionListW, RFID_GetRegionStandardListW, RFID_SetActiveRegionW, RFID_SetFrequencySetting, RFID_GetActiveRegionInfoW, RFID_GetActiveRegionStandardInfoW

Remarks

Example:

RFID_HANDLE32   g_RMReaderHandle = NULL;
RFID_HANDLE32   g_ReaderHandle = NULL;
RFID_STATUS LoginToReader()
{
RFID_STATUS rfidStatus = RFID_API_SUCCESS;
LOGIN_INFO loginInfo;
BOOL secureMode=0;
_tcscpy(loginInfo.userName,TEXT("admin"));
_tcscpy(loginInfo.password,TEXT("change"));
_tcscpy(loginInfo.hostName,TEXT("169.254.10.1"));
loginInfo.forceLogin = true;
loginInfo.version = RFID_API3_5_5;
rfidStatus = RFID_Login(&g_RMReaderHandle,  &loginInfo, FX, secureMode, NULL);
return rfidStatus;
}
void TestRFDIAPI3RegulatorySupport()
{
RFID_STATUS rfidStatus = RFID_API_SUCCESS;
LoginToReader();
if(RFID_API_SUCCESS == rfidStatus)
{
REGION_LIST ReaderRegionList = {0};
rfidStatus = RFID_GetSupportedRegionList( g_RMReaderHandle,&ReaderRegionList);
if( rfidStatus == RFID_API_SUCCESS )
{
_tprintf(TEXT("Total number of Regions %d\r\n"), ReaderRegionList.numRegions);
_tprintf(TEXT("Regions #7 is %s\r\n"), ReaderRegionList.RegionNamesList[7]);
}
}
// Get region supported standards
STANDARD_INFO_LIST StdInfoList = {0};
rfidStatus = RFID_GetRegionStandardList( g_RMReaderHandle, TEXT("European Union"),&StdInfoList);
if( rfidStatus == RFID_API_SUCCESS )
{
_tprintf(TEXT("Region %s\r\n"), StdInfoList.StdsList[0].strRegionName);
_tprintf(TEXT("Number of Standards %d\r\n"), StdInfoList.numStds);
for(int j=0;j<StdInfoList.numStds;j++)
{
_tprintf(TEXT("StandardName %s\r\n"), StdInfoList.StdsList[j].strStandardName);
_tprintf(TEXT("NumChannels %d\r\n"), StdInfoList.StdsList[j].iNumChannels);
_tprintf(TEXT("IsHoppingConfigurable        %s\r\n"), StdInfoList.StdsList[j].bIsHoppingConfigurable?TEXT("Yes"):TEXT("No"));
if(StdInfoList.StdsList[j].bIsHoppingConfigurable)
for(int k=0;k<StdInfoList.StdsList[j].iNumChannels;k++)
_tprintf(TEXT("Channels index %d values %d KHz\r\n"), StdInfoList.StdsList[j].piChannelInfo[k],StdInfoList.StdsList[j].piChannelValueInfo[k]);
}
}
// Set paritcular region as active region
rfidStatus = RFID_SetActiveRegion(g_RMReaderHandle,TEXT("European Union"),TEXT("EU 302.208"));
if( rfidStatus == RFID_API_SUCCESS )
{
_tprintf(TEXT("SetActiveRegion successful\r\n"));
PrintRFDIAPI3ReaderCaps();
}
//
STANDARD_REGION_INFO ActvRegStdInfo = {0};
rfidStatus = RFID_GetActiveRegionStandardInfo(g_RMReaderHandle,&ActvRegStdInfo);
if( rfidStatus == RFID_API_SUCCESS )
{
_tprintf(TEXT("GetActiveRegionStandardInfo %s successful channels %d\r\n"), ActvRegStdInfo.strStandardName,ActvRegStdInfo.iNumChannels);
}
//
CHANNEL_LIST ChnlLst = {0};
// Allocate memory for number of channels supported by standard
ChnlLst.ChannelList = new UINT32[ActvRegStdInfo.iNumChannels];
// Set frequency hopping ON and number of channels limited to three
ChnlLst.iNumChannels = 2;
ChnlLst.ChannelList[0] = 2;
ChnlLst.ChannelList[1] = 3;
bool hopping = true;
rfidStatus = RFID_SetFrequencySetting(g_RMReaderHandle,hopping,&ChnlLst);
// Set in fixed frequency mode i.e hopping OFF and number of channels limited to one
ChnlLst.iNumChannels = 1;
hopping = false;
// Selecting fixed channel # three
ChnlLst.ChannelList[0] = 3;
rfidStatus = RFID_SetFrequencySetting(g_RMReaderHandle,hopping,&ChnlLst);
if( rfidStatus == RFID_API_SUCCESS )
{
_tprintf(TEXT("SetFrequencySetting channels:%d hopping:%s channel value %d successful\r\n"), ChnlLst.iNumChannels,hopping?TEXT("ON"):TEXT("OFF")
,ActvRegStdInfo.piChannelValueInfo[2]);
}
//
ACTIVE_REGION_INFO ActiveRegionInfo = {0};
rfidStatus = RFID_GetActiveRegionInfo(g_RMReaderHandle, &ActiveRegionInfo);
if( rfidStatus == RFID_API_SUCCESS )
{
_tprintf(TEXT("GetActiveRegionInfo %s successful hopping:%s channels %d \r\n"), ActiveRegionInfo.strRegionName
,ActiveRegionInfo.bIsHoppingOn?TEXT("ON"):TEXT("OFF"), ActiveRegionInfo.iNumChannels);
}
//
RFID_Logout(g_RMReaderHandle);
}
void PrintRFDIAPI3ReaderCaps()
{
CONNECTION_INFO info;
// Need to reconnect reader because of call to RFID_SetActiveRegion & RFID_SetFrequencySetting reintializes LLRP
RFID_STATUS rfidStatus = RFID_Connect(&g_ReaderHandle,  TEXT("169.254.10.1"), 5084, 2000, &info);
READER_CAPS readerCaps;
rfidStatus = RFID_GetReaderCaps(g_ReaderHandle, &readerCaps);
_tprintf(TEXT("CommunicationStandard: %d \r\n"), readerCaps.communicationStandard);
if(!readerCaps.hoppingEnabled)
{
_tprintf(TEXT("fixedFreqInfo numFreq: %d\r\n"), readerCaps.fixedFreqInfo.numFreq);
_tprintf(TEXT("fixedFreqInfo pFreqList: %d\r\n"), readerCaps.fixedFreqInfo.pFreqList[0]);
}
_tprintf(TEXT("freqHopInfo numTables: %d\r\n"), readerCaps.freqHopInfo.numTables);
_tprintf(TEXT("HoppingEnabled : %d\r\n"), readerCaps.hoppingEnabled);
}

RFID_SetActiveRegionA()

RFID_STATUS WINAPI RFID_SetActiveRegionA	(	RFID_HANDLE32	readerManagementHandle,
		CHAR *	RegionName,
		CHAR *	CommunicationStandardName
	)

RFID_SetFrequencySetting()

RFID_STATUS WINAPI RFID_SetFrequencySetting	(	RFID_HANDLE32	readerManagementHandle,
		BOOLEAN	bEnableFrequencyHopping,
		CHANNEL_LIST *	lpChannelTable
	)

Set freq-hopping with a list of supported channel indexes for active region.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[in]	bEnableFrequencyHopping	Enable or disable frequency hopping on reader
[in]	lpChannelTable	List of channels or single channel (fixed frequency mode)

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

The frequency hopping setting would be applied to all antennas of a reader If frequency hopping is enabled, the ChannelTable parameter must contain more than one supported channel index If frequency hopping is disabled,the ChannelTable parameter contains a single channel choice that would be selected for the fixed frequency mode on all antennas on the reader

See also

RFID_GetSupportedRegionListW, RFID_GetRegionStandardListW, RFID_SetActiveRegionW, RFID_SetFrequencySetting, RFID_GetActiveRegionInfoW, RFID_GetActiveRegionStandardInfoW

Remarks

Example: See

RFID_SetActiveRegionW

RFID_GetActiveRegionInfoW()

RFID_STATUS WINAPI RFID_GetActiveRegionInfoW	(	RFID_HANDLE32	readerManagementHandle,
		ACTIVE_REGION_INFOW *	ActiveRegionInfo
	)

Get region information which is currently active region and frequency settings.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[out]	ActiveRegionInfo	Pointer to Struture containg active region infomration

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 API only provides the information of the current frequency mode (is hopping on) and the list of enabled channel indexes which is also part of reader capabilities info For standrd configuration of region

See also

RFID_GetActiveRegionStandardInfoW

RFID_GetSupportedRegionListW, RFID_GetRegionStandardListW, RFID_SetActiveRegionW, RFID_SetFrequencySetting, RFID_GetActiveRegionInfoW, RFID_GetActiveRegionStandardInfoW

Remarks

Example: See

RFID_SetActiveRegionW

RFID_GetActiveRegionInfoA()

RFID_STATUS WINAPI RFID_GetActiveRegionInfoA	(	RFID_HANDLE32	readerManagementHandle,
		ACTIVE_REGION_INFOA *	ActiveRegionInfo
	)

RFID_GetActiveRegionStandardInfoW()

RFID_STATUS WINAPI RFID_GetActiveRegionStandardInfoW	(	RFID_HANDLE32	readerManagementHandle,
		STANDARD_REGION_INFOW *	CurrentActiveRegionStandardInfo
	)

Get active region standard information.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[out]	CurrentActiveRegionStandardInfo	Pointer to struture containg active region standard infomration

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 API provides list of supported channel indexes or if hopping/fixed-freq is supported by the current active region before configuring the frequency setting. For current configuration

See also

RFID_GetActiveRegionInfo

RFID_GetSupportedRegionListW, RFID_GetRegionStandardListW, RFID_SetActiveRegionW, RFID_SetFrequencySetting, RFID_GetActiveRegionInfoW, RFID_GetActiveRegionStandardInfoW

Remarks

Example: See

RFID_SetActiveRegionW

RFID_GetActiveRegionStandardInfoA()

RFID_STATUS WINAPI RFID_GetActiveRegionStandardInfoA	(	RFID_HANDLE32	readerManagementHandle,
		STANDARD_REGION_INFOA *	CurrentActiveRegionStandardInfo
	)

RFID_ChangePasswordW()

RFID_STATUS WINAPI RFID_ChangePasswordW	(	RFID_HANDLE32	readerManagementHandle,
		USER_INFOW *	lpUserInfo
	)

This function changes the password for the given user.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[out]	lpUserInfo	Contains the username,old_password and new_password

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

See also

Remarks

Example: See

RFID_ChangePasswordW

RFID_ChangePasswordA()

RFID_STATUS WINAPI RFID_ChangePasswordA	(	RFID_HANDLE32	readerManagementHandle,
		LPUSER_INFOA	lpUserInfo
	)

This function changes the password for the given user.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[out]	lpUserInfo	Contains the username,old_password and new_password

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

See also

Remarks

Example: See

RFID_ChangePasswordA

RFID_GetPowerNegotiationState()

RFID_STATUS WINAPI RFID_GetPowerNegotiationState	(	RFID_HANDLE32	readerManagementHandle,
		BOOLEAN *	lpPowerNegotiationState
	)

This function gets the power negotiation state of the RFID Reader.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[out]	lpPowerNegotiationState	Get Power Negotiation is enabled or not

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 Device-based readers like MC

Remarks

See also

RFID_SetPowerNegotiationState

Remarks

Example:

RFID_GetPowerNegotiationState

RFID_SetPowerNegotiationState()

RFID_STATUS WINAPI RFID_SetPowerNegotiationState	(	RFID_HANDLE32	readerManagementHandle,
		BOOLEAN	powerNegotiationState
	)

This function sets the power negotiation state of the RFID Reader.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[out]	powerNegotiationState	Sets Power Negotiate state to enable or not

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 Device-based readers like MC

Remarks

See also

RFID_SetPowerNegotiationState

Remarks

Example:

RFID_SetPowerNegotiationState

RFID_GetPowerNegotiationStatus()

RFID_STATUS WINAPI RFID_GetPowerNegotiationStatus	(	RFID_HANDLE32	readerManagementHandle,
		POWER_NEGOTIATION_STATUS *	lpPowerNegotiationStatus
	)

This function gets the Power Negotiation Status of the RFID reader.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[out]	lpPowerNegotiationStatus	Gets the current status of power negotiation

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

See also

Remarks

Example: See

RFID_GetPowerNegotiationStatus

RFID_SetNTPServerW()

RFID_STATUS WINAPI RFID_SetNTPServerW	(	RFID_HANDLE32	readerManagementHandle,
		LPTIME_SERVER_INFOW	lpTimeServerInfo
	)

This function sets the NTP Server configuration.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[out]	lpTimeServerInfo	Contains the NTP Server Host Name

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

See also

Remarks

Example: See

RFID_SetNTPServerA()

RFID_STATUS WINAPI RFID_SetNTPServerA	(	RFID_HANDLE32	readerManagementHandle,
		LPTIME_SERVER_INFOA	lpTimeServerInfo
	)

This function sets the NTP Server configuration.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[out]	lpTimeServerInfo	Contains the NTP Server Host Name

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

See also

Remarks

Example: See

RFID_GetNTPServerW()

RFID_STATUS WINAPI RFID_GetNTPServerW	(	RFID_HANDLE32	readerManagementHandle,
		LPTIME_SERVER_INFOW	lpTimeServerInfo
	)

This function gets the NTP Server configuration.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[out]	lpTimeServerInfo	Contains the NTP Server Host Name

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

See also

Remarks

Example: See

RFID_GetNTPServerA()

RFID_STATUS WINAPI RFID_GetNTPServerA	(	RFID_HANDLE32	readerManagementHandle,
		LPTIME_SERVER_INFOA	lpTimeServerInfo
	)

This function gets the NTP Server configuration.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[out]	lpTimeServerInfo	Contains the NTP Server Host Name

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

See also

Remarks

Example: See

RFID_SetSysLogServerW()

RFID_STATUS WINAPI RFID_SetSysLogServerW	(	RFID_HANDLE32	readerManagementHandle,
		LPSYSLOG_SERVER_INFOW	lpSysLogServerInfo
	)

This function sets the SysLog Server configuration.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[out]	lpSysLogServerInfo	Contains the SysLog Server Host Name, port and severity

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

See also

Remarks

Example: See

RFID_SetSysLogServerA()

RFID_STATUS WINAPI RFID_SetSysLogServerA	(	RFID_HANDLE32	readerManagementHandle,
		LPSYSLOG_SERVER_INFOA	lpSysLogServerInfo
	)

This function sets the SysLog Server configuration.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[out]	lpSysLogServerInfo	Contains the SysLog Server Host Name, port and severity

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

See also

Remarks

None.

RFID_SetWirelessNetworkW()

RFID_STATUS WINAPI RFID_SetWirelessNetworkW	(	RFID_HANDLE32	readerManagementHandle,
		LPWIRELESS_CONFIGURED_PARAMETERSW	lpWirelessConfiguredParameters
	)

This function sets the Wireless Network configuration.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[out]	lpWirelessConfiguredParameters	Contains the Wireless Network ssid, passkey and auto connection status

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

See also

Remarks

Example: See

RFID_SetWirelessNetworkA()

RFID_STATUS WINAPI RFID_SetWirelessNetworkA	(	RFID_HANDLE32	readerManagementHandle,
		LPWIRELESS_CONFIGURED_PARAMETERSA	lpWirelessConfiguredParameters
	)

This function sets the Wireless Network configuration.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[out]	lpWirelessConfiguredParameters	Contains the Wireless Network ssid, passkey and auto connection status

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

See also

Remarks

Example: See

RFID_SetNetworkInterfaceSettingsW()

RFID_STATUS WINAPI RFID_SetNetworkInterfaceSettingsW	(	RFID_HANDLE32	readerManagementHandle,
		LPREADER_NETWORK_INFOW	lpnetworkInfo
	)

This function sets the Network Interfcae Settings.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[out]	lpnetworkInfo	Contains the reader network information.

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

See also

Remarks

Example: See

RFID_SetNetworkInterfaceSettingsA()

RFID_STATUS WINAPI RFID_SetNetworkInterfaceSettingsA	(	RFID_HANDLE32	readerManagementHandle,
		LPREADER_NETWORK_INFOA	lpnetworkInfo
	)

This function sets the Network Interfcae Settings.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[out]	lpnetworkInfo	Contains the reader network information.

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

See also

Remarks

Example: See

RFID_GetSysLogServerW()

RFID_STATUS WINAPI RFID_GetSysLogServerW	(	RFID_HANDLE32	readerManagementHandle,
		LPSYSLOG_SERVER_INFOW	lpSysLogServerInfo
	)

This function gets the SysLog Server configuration.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[out]	lpSysLogServerInfo	Contains the SysLog Server Host Name, port and severity

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

See also

Remarks

Example: See

RFID_GetSysLogServerA()

RFID_STATUS WINAPI RFID_GetSysLogServerA	(	RFID_HANDLE32	readerManagementHandle,
		LPSYSLOG_SERVER_INFOA	lpSysLogServerInfo
	)

This function gets the SysLog Server configuration.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[out]	lpSysLogServerInfo	Contains the SysLog Server Host Name, port and severity

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

See also

Remarks

Example: See

RFID_GetWirelessConfigParametersA()

RFID_STATUS WINAPI RFID_GetWirelessConfigParametersA	(	RFID_HANDLE32	readerManagementHandle,
		LPWIRELESS_CONFIGURED_PARAMETERSA	lpWirelessConfiguredParameters
	)

This function gets the Wireless N/W Configuration Parameters.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[out]	lpWirelessConfiguredParameters	Contains the wireless network parameters

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

See also

Remarks

Example: See

RFID_GetWirelessConfigParametersW()

RFID_STATUS WINAPI RFID_GetWirelessConfigParametersW	(	RFID_HANDLE32	readerManagementHandle,
		LPWIRELESS_CONFIGURED_PARAMETERSW	lpWirelessConfiguredParameters
	)

This function gets the SysLog Server configuration.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[out]	lpWirelessConfiguredParameters	Contains the wireless network parameters

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

See also

Remarks

Example: See

RFID_GetTemperatureStatusW()

RFID_STATUS WINAPI RFID_GetTemperatureStatusW	(	RFID_HANDLE32	readerManagementHandle,
		LPTEMPERATURE_STATUSW	lpTemperatureStatus
	)

This function gets the Temperature Status of the RFID reader.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[out]	lpTemperatureStatus	Gets the current temperature

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

See also

Remarks

Example: See

RFID_GetTemperatureStatus

RFID_GetTemperatureStatusA()

RFID_STATUS WINAPI RFID_GetTemperatureStatusA	(	RFID_HANDLE32	readerManagementHandle,
		LPTEMPERATURE_STATUSA	lpTemperatureStatus
	)

This function gets the Temperature Status of the RFID reader.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login.
[out]	lpTemperatureStatus	Gets the current temperature

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

See also

Remarks

Example: See

RFID_GetTemperatureStatus

RFID_GetCountryCodeFromRegion()

RFID_STATUS WINAPI RFID_GetCountryCodeFromRegion	(	RFID_HANDLE32	readerManagementHandle,
		WCHAR *	RegionName,
		UINT32 *	CountryCode
	)

This function get the country code given the region name.

Parameters

[in]	readerManagementHandle	Handle returned by RFID_Login
[in]	RegionName	given region name
[in]	CountryCode	country code corresponding to region name

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

None.

See also

None.

Remarks

Example:

RFID_GenerateRegionsConfigFile()

RFID_STATUS WINAPI RFID_GenerateRegionsConfigFile

(

RFID_HANDLE32

readerManagementHandle

)

This function is used to generate regions config file in RE40.

Parameters

[in]

readerManagementHandle

Handle returned by RFID_Login.

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

None.

See also

None.

Remarks

pixie_re40_regionsConfig.csv file will be generated which contains regulatory information. Example:

rfidStatus = RFID_GenerateRegionsConfigFile(readerManagementHandle);
if (rfidStatus == RFID_API_SUCCESS)
      printf("\nRegions config file created successfully...\n");
else
     printf("\nFailed to create the regions config file...\n");