Helper

Functions
RFID_STATUS WINAPI	RFID_SetTraceLevel (RFID_HANDLE32 readerHandle, UINT32 traceLevel)
	This function sets the trace level for debugging purpose. More...
TCHAR *WINAPI	RFID_GetErrorDescriptionW (RFID_STATUS errorCode)
	This function gets the error description for the specified error code. More...
CHAR *WINAPI	RFID_GetErrorDescriptionA (RFID_STATUS errorCode)
RFID_STATUS WINAPI	RFID_GetLastErrorInfoW (RFID_HANDLE32 readerHandle, LPERROR_INFO lpErrorInfo)
	This function gets the error information for the last function call. More...
RFID_STATUS WINAPI	RFID_GetLastErrorInfoA (RFID_HANDLE32 readerHandle, LPERROR_INFOA lpErrorInfo)
RFID_STATUS WINAPI	RFID_ComPortsDiscoveryA (CONNECTION_INFO connectionInfo, LPComPortsA avialablePorts, RE_SUPPORTED_BAUDRATE baudRate)
	This function discovers the com ports to which pixie modules are commected for a given baudrate. More...
RFID_STATUS WINAPI	RFID_ComPortsDiscoveryW (CONNECTION_INFO connectionInfo, LPComPortsW avialablePorts, RE_SUPPORTED_BAUDRATE baudRate)
	This function discovers the com ports to which pixie modules are commected for a given baudrate. More...

Detailed Description

Function Documentation

RFID_SetTraceLevel()

RFID_STATUS WINAPI RFID_SetTraceLevel	(	RFID_HANDLE32	readerHandle,
		UINT32	traceLevel
	)

This function sets the trace level for debugging purpose.

Based on the trace level set, the logs are traced in the text file.

Parameters

[in]	readerHandle	Handle to the RFID device
[in]	traceLevel	Trace level (of type TRACE_LEVEL) to be set. Levels can be ORed.

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 can be used to set the trace-level of generic interface or reader management interface in which case readerHandle should be passed as returned by RFID_Connect/RFID_AcceptConnection OR RFID_Login respectively.

See also

Remarks

Example: See

RFID_Connect

RFID_GetErrorDescriptionW()

TCHAR* WINAPI RFID_GetErrorDescriptionW

(

RFID_STATUS

errorCode

)

This function gets the error description for the specified error code.

Parameters

[in]

errorCode

Error code.

Returns

Pointer to TCHAR having the Error Description. NULL if errorCode is invalid

Remarks

See also

RFID_GetLastErrorInfo

Remarks

Example: See

RFID_AddPreFilter

RFID_GetErrorDescriptionA()

CHAR* WINAPI RFID_GetErrorDescriptionA

(

RFID_STATUS

errorCode

)

RFID_GetLastErrorInfoW()

RFID_STATUS WINAPI RFID_GetLastErrorInfoW	(	RFID_HANDLE32	readerHandle,
		LPERROR_INFO	lpErrorInfo
	)

This function gets the error information for the last function call.

Parameters

[in]	readerHandle	Handle to the RFID device .
[out]	lpErrorInfo	Pointer to ERROR_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_API_PARAM_ERROR

Remarks

This API can be used to get the error information of generic interface or reader management interface in which case readerHandle should be passed as returned by RFID_Connect/RFID_AcceptConnection OR RFID_Login respectively.

See also

Remarks

Example: See RFID_Read

RFID_GetLastErrorInfoA()

RFID_STATUS WINAPI RFID_GetLastErrorInfoA	(	RFID_HANDLE32	readerHandle,
		LPERROR_INFOA	lpErrorInfo
	)

RFID_ComPortsDiscoveryA()

RFID_STATUS WINAPI RFID_ComPortsDiscoveryA	(	CONNECTION_INFO	connectionInfo,
		LPComPortsA	avialablePorts,
		RE_SUPPORTED_BAUDRATE	baudRate
	)

This function discovers the com ports to which pixie modules are commected for a given baudrate.

Parameters

[in]	connectionInfo	holds connection infromation.
[in]	avialablePorts	holds information about connected comports.ASCII version
[in]	baudRate	baud rate at which discovery happens,configured baudrate has to be used

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

ASCII version version which is part of connectionInfo should be greater than equla to RFID_API3_5_7. when function returns avialablePorts contain connected comports informations.

See also

None.

Remarks

Example:

RE_SUPPORTED_BAUDRATE baudRate;
printf("Choose Baud rate to discover com ports 1: 115200  2: 230400  3: 460800  4: 921600\n");
scanf_s(" %d", &br);
switch (br)
{
   case 1:
       baudRate = RE_BUADRATE_115200;
       break;
   case 2:
       baudRate = RE_BUADRATE_230400;
       break;
   case 3:
       baudRate = RE_BUADRATE_460800;
       break;
   case 4:
       baudRate = RE_BUADRATE_921600;
       break;
   default:
       printf("Choose the correct one ...Exiting from the application\n");
       break;
}
ComPortsA avialablePorts;
connectionInfo.version = RFID_API3_5_7;
printf("Discovering com ports for %d baudrate\n", (int) baudRate);
rfidStatus = RFID_ComPortsDiscovery(connectionInfo, &avialablePorts, baudRate);
printf("Number of Ports discovered %d\n", avialablePorts.numberOfComPorts);
printf("Available Com Ports are :\n");
for (uint32_t k = 0; k < avialablePorts.numberOfComPorts; k++)
{
      printf("%S\n", avialablePorts.ComPortsConnected[k]);
}      

RFID_ComPortsDiscoveryW()

RFID_STATUS WINAPI RFID_ComPortsDiscoveryW	(	CONNECTION_INFO	connectionInfo,
		LPComPortsW	avialablePorts,
		RE_SUPPORTED_BAUDRATE	baudRate
	)

This function discovers the com ports to which pixie modules are commected for a given baudrate.

Parameters

[in]	connectionInfo	holds connection infromation.
[in]	avialablePorts	holds information about connected comports.Unicode version
[in]	baudRate	baud rate at which discovery happens,configured baudrate has to be used

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

Unicode version. version which is part of connectionInfo should be greater than equla to RFID_API3_5_7. when function returns avialablePorts contain connected comports informations.

See also

None.

Remarks

Example:

RE_SUPPORTED_BAUDRATE baudRate;
printf("Choose Baud rate to discover com ports 1: 115200  2: 230400  3: 460800  4: 921600\n");
scanf_s(" %d", &br);
switch (br)
{
   case 1:
       baudRate = RE_BUADRATE_115200;
       break;
   case 2:
       baudRate = RE_BUADRATE_230400;
       break;
   case 3:
       baudRate = RE_BUADRATE_460800;
       break;
   case 4:
       baudRate = RE_BUADRATE_921600;
       break;
   default:
       printf("Choose the correct one ...Exiting from the application\n");
       break;
}
ComPortsW avialablePorts;
connectionInfo.version = RFID_API3_5_7;
printf("Discovering com ports for %d baudrate\n", (int) baudRate);
rfidStatus = RFID_ComPortsDiscovery(connectionInfo, &avialablePorts, baudRate);
printf("Number of Ports discovered %d\n", avialablePorts.numberOfComPorts);
printf("Available Com Ports are :\n");
for (uint32_t k = 0; k < avialablePorts.numberOfComPorts; k++)
{
      printf("%S\n", avialablePorts.ComPortsConnected[k]);
}