MSR API - Revision history

Mahong at 09:36, 11 March 2019

2019-03-11T09:36:02Z

← Older revision		Revision as of 09:36, 11 March 2019
Line 54:		Line 54:
	<syntaxhighlight lang="c">int msr_unregister_notifier()</syntaxhighlight >		<syntaxhighlight lang="c">int msr_unregister_notifier()</syntaxhighlight >
	Unregister a notifier.		Unregister a notifier.
	If you have register a notifier and you don’t want to monitor swing, you can call this ~~api~~ to unregister the notifier.		If you have register a notifier and you don’t want to monitor swing, you can call this API to unregister the notifier.
	{\|class="wizarpostable"		{\|class="wizarpostable"
	\|-		\|-
Line 68:		Line 68:
	The track index should be 0, 1, 2.		The track index should be 0, 1, 2.

	After the notifier found a card, if you want to get information from the selected track of the card, you should firstly call this ~~api~~. If the result value is more than 0, the following ~~apis~~ can be called.		After the notifier found a card, if you want to get information from the selected track of the card, you should firstly call this API. If the result value is more than 0, the following API can be called.
	{\|class="wizarpostable"		{\|class="wizarpostable"
	\|-		\|-

Mahong at 02:40, 3 May 2018

2018-05-03T02:40:51Z

← Older revision		Revision as of 02:40, 3 May 2018
Line 108:		Line 108:
	\| int \|\| The result code, >= 0, success, the data length of track data; <0 [[Error_code\|error code]].		\| int \|\| The result code, >= 0, success, the data length of track data; <0 [[Error_code\|error code]].
	\|}		\|}


	=== <big>get_track_data</big>===		=== <big>get_track_data</big>===

Mahong: /* get_track_data_length */

2018-05-03T02:40:10Z

get_track_data_length

← Older revision		Revision as of 02:40, 3 May 2018
Line 106:		Line 106:
	! scope="row" colspan="2"\| Returns		! scope="row" colspan="2"\| Returns
	\|-		\|-
	\| int \|\| The result code, >= 0, success; <0 [[Error_code\|error code]].		\| int \|\| The result code, >= 0, success, the data length of track data; <0 [[Error_code\|error code]].
	\|}		\|}


	=== <big>get_track_data</big>===		=== <big>get_track_data</big>===

Mahong: /* API Overview */

2018-05-03T02:38:37Z

API Overview

← Older revision		Revision as of 02:38, 3 May 2018
Line 49:		Line 49:
	\| int \|\| The result code, >= 0, success; <0 [[Error_code\|error code]].		\| int \|\| The result code, >= 0, success; <0 [[Error_code\|error code]].
	\|}		\|}


	=== <big>unregister_notifier</big>===		=== <big>unregister_notifier</big>===
Line 85:		Line 86:
	\| int \|\| The result code, >= 0, success, no error; <0 [[Error_code\|error code]].		\| int \|\| The result code, >= 0, success, no error; <0 [[Error_code\|error code]].
	\|}		\|}


	=== <big>get_track_data_length</big>===		=== <big>get_track_data_length</big>===

Mahong: /* get_track_error */

2018-05-03T02:37:58Z

get_track_error

← Older revision		Revision as of 02:37, 3 May 2018
Line 83:		Line 83:
	! scope="row" colspan="2"\| Returns		! scope="row" colspan="2"\| Returns
	\|-		\|-
	\| int \|\| The result code, >= 0, success; <0 [[Error_code\|error code]].		\| int \|\| The result code, >= 0, success, no error; <0 [[Error_code\|error code]].
	\|}		\|}


	=== <big>get_track_data_length</big>===		=== <big>get_track_data_length</big>===

Mahong: /* register_notifier */

2018-05-03T02:36:50Z

register_notifier

← Older revision		Revision as of 02:36, 3 May 2018
Line 37:		Line 37:
	\| pUserData \|\| '''void*:''' User data.		\| pUserData \|\| '''void*:''' User data.
	\|}		\|}
			Define it as follows:
	<syntaxhighlight lang="c">typedef void (MSR_NOTIFIER)(void pUserData)</syntaxhighlight >		<syntaxhighlight lang="c">typedef void (MSR_NOTIFIER)(void pUserData)</syntaxhighlight >
	{\|		{\|

Mahong: /* register_notifier */

2018-05-02T09:20:19Z

register_notifier

← Older revision		Revision as of 09:20, 2 May 2018
Line 48:		Line 48:
	\| int \|\| The result code, >= 0, success; <0 [[Error_code\|error code]].		\| int \|\| The result code, >= 0, success; <0 [[Error_code\|error code]].
	\|}		\|}


	=== <big>unregister_notifier</big>===		=== <big>unregister_notifier</big>===

Mahong at 09:19, 2 May 2018

2018-05-02T09:19:28Z

Mahong at 07:45, 2 May 2018

2018-05-02T07:45:38Z

← Older revision		Revision as of 07:45, 2 May 2018
Line 33:		Line 33:
	! scope="row" colspan="2" \| Parameters		! scope="row" colspan="2" \| Parameters
	\|-		\|-
	\| ''~~pNotifier~~'' ~~\|\| MSR_NOTIFIER \|\|~~ Notifier of MSR card reader.		\| pNotifier \|\| '''MSR_NOTIFIER:''' Notifier of MSR card reader.
	\|-		\|-
	\| '~~'pUserData~~'' \|\| void* \|\| User data.		\| pUserData \|\| '''void*:''' User data.
	\|}		\|}
	typedef void (MSR_NOTIFIER)(void pUserData)		typedef void (MSR_NOTIFIER)(void pUserData)
Line 72:		Line 72:
	! scope="row" colspan="2" \| Parameters		! scope="row" colspan="2" \| Parameters
	\|-		\|-
	\| ''~~nTrackIndex~~'' ~~\|\| int \|\|~~ Track index		\| nTrackIndex \|\| '''int:''' Track index
	\|}		\|}
	{\|		{\|
Line 95:		Line 95:
	! scope="row" colspan="2" \| Parameters		! scope="row" colspan="2" \| Parameters
	\|-		\|-
	\| ''~~nTrackIndex~~'' ~~\|\| int \|\|~~ Track index		\| nTrackIndex \|\| '''int:''' Track index
	\|}		\|}
	{\|		{\|
Line 116:		Line 116:
	! scope="row" colspan="2" \| Parameters		! scope="row" colspan="2" \| Parameters
	\|-		\|-
	\| ''~~nTrackIndex~~'' ~~\|\| int \|\|~~ Track index		\| nTrackIndex \|\| '''int:''' Track index
	\|-		\|-
	\| '~~'pTrackData~~'' \|\| unsigned char* \|\| Data buffer		\| pTrackData \|\| '''unsigned char*:''' Data buffer
	\|-		\|-
	\| ''~~nLength~~'' ~~\|\| int \|\|~~ Length of data buffer		\| nLength \|\| '''int:''' Length of data buffer
	\|}		\|}
	{\|		{\|

Mahong at 07:42, 2 May 2018

2018-05-02T07:42:40Z

Show changes

← Older revision		Revision as of 09:19, 2 May 2018
Line 2:		Line 2:
	The calling sequence is [[#open\|open]]>[[#register_notifier \|register_notifier ]]>[[#get_track_error\|get_track_error]]>[[#get_track_data_length\|get_track_data_length]]>[[#get_track_data\|get_track_data]]>[[#close\|close ]]		The calling sequence is [[#open\|open]]>[[#register_notifier \|register_notifier ]]>[[#get_track_error\|get_track_error]]>[[#get_track_data_length\|get_track_data_length]]>[[#get_track_data\|get_track_data]]>[[#close\|close ]]
	=== <big>open</big> ===		=== <big>open</big> ===
	int msr_open()		<syntaxhighlight lang="c">int msr_open()</syntaxhighlight >
	Open the MSR reader device. If success, the device object establishes a connection with the MSR so that it can carry out the following operations.		Open the MSR reader device. If success, the device object establishes a connection with the MSR so that it can carry out the following operations.
	This operation should be used before other operations in this chapter.		This operation should be used before other operations in this chapter.
Line 14:		Line 14:

	=== <big>close</big> ===		=== <big>close</big> ===
	int msr_close ()		<syntaxhighlight lang="c">int msr_close ()</syntaxhighlight >
	Close the opened MSR reader device. If you want to call other APIs, you should open the device again.		Close the opened MSR reader device. If you want to call other APIs, you should open the device again.
	Open and close are pair operations. If you don’t want to use the device, you should call close to release the device.		Open and close are pair operations. If you don’t want to use the device, you should call close to release the device.
Line 26:		Line 26:

	=== <big>register_notifier</big> ===		=== <big>register_notifier</big> ===
	int msr_register_notifier(MSR_NOTIFIER pNotifier, void* pUserData)		<syntaxhighlight lang="c">int msr_register_notifier(MSR_NOTIFIER pNotifier, void* pUserData)</syntaxhighlight >
	Register a notifier. As soon as data is ready, this notifier will be called.		Register a notifier. As soon as data is ready, this notifier will be called.
	This operation can be called if you want to monitor the swing card information after opening the device.		This operation can be called if you want to monitor the swing card information after opening the device.
Line 37:		Line 37:
	\| pUserData \|\| '''void*:''' User data.		\| pUserData \|\| '''void*:''' User data.
	\|}		\|}
	typedef void (MSR_NOTIFIER)(void pUserData)		<syntaxhighlight lang="c">typedef void (MSR_NOTIFIER)(void pUserData)</syntaxhighlight >
	{\|		{\|
	\|-		\|-
Line 51:		Line 51:

	=== <big>unregister_notifier</big>===		=== <big>unregister_notifier</big>===
	int msr_unregister_notifier()		<syntaxhighlight lang="c">int msr_unregister_notifier()</syntaxhighlight >
	Unregister a notifier.		Unregister a notifier.
	If you have register a notifier and you don’t want to monitor swing, you can call this api to unregister the notifier.		If you have register a notifier and you don’t want to monitor swing, you can call this api to unregister the notifier.
Line 63:		Line 63:

	=== <big>get_track_error</big>===		=== <big>get_track_error</big>===
	int msr_get_track_error(int nTrackIndex)		<syntaxhighlight lang="c">int msr_get_track_error(int nTrackIndex)</syntaxhighlight >
	Get error information from the selected track.		Get error information from the selected track.
	The track index should be 0, 1, 2.		The track index should be 0, 1, 2.
Line 88:		Line 88:

	=== <big>get_track_data_length</big>===		=== <big>get_track_data_length</big>===
	int msr_get_track_data_length(int nTrackIndex)		<syntaxhighlight lang="c">int msr_get_track_data_length(int nTrackIndex)</syntaxhighlight >
	Get the length information from the selected track.		Get the length information from the selected track.
	You can allocate the memory space for the information in the selected track which is used in the following api.		You can allocate the memory space for the information in the selected track which is used in the following api.
Line 110:		Line 110:

	=== <big>get_track_data</big>===		=== <big>get_track_data</big>===
	int msr_get_track_data (int nTrackIndex, unsigned char* pTrackData, int nLength)		<syntaxhighlight lang="c">int msr_get_track_data (int nTrackIndex, unsigned char* pTrackData, int nLength)</syntaxhighlight >
	Get the data information from the selected track.		Get the data information from the selected track.
	{\|class="wizarpostable"		{\|class="wizarpostable"