Smart Card API - Revision history

Mahong at 09:44, 11 March 2019

2019-03-11T09:44:23Z

← Older revision		Revision as of 09:44, 11 March 2019
Line 9:		Line 9:
	Open the specified slot of the smart card reader.		Open the specified slot of the smart card reader.
	This operation should be used before other operations.		This operation should be used before other operations.
	A notifier is registered after this ~~api~~ is called.		A notifier is registered after this API is called.

	{\|class="wizarpostable"		{\|class="wizarpostable"
Line 82:		Line 82:
	Query whether the smart card is existent in the selected slot.		Query whether the smart card is existent in the selected slot.
	Attention: not every slot can support this function.		Attention: not every slot can support this function.
	This ~~api~~ can be used before [[#open\|open]] operation.		This API can be used before [[#open\|open]] operation.
	{\|class="wizarpostable"		{\|class="wizarpostable"
	\|-		\|-
Line 224:		Line 224:
	<syntaxhighlight lang="c">int smart_card_power_off(int nHandle)</syntaxhighlight >		<syntaxhighlight lang="c">int smart_card_power_off(int nHandle)</syntaxhighlight >
	Power off the smart card in the slot opened before.		Power off the smart card in the slot opened before.
	This ~~api~~ should be used after power_on.		This API should be used after power_on.
	Power_on and power_off are pair operations.		Power_on and power_off are pair operations.

Line 248:		Line 248:
	<syntaxhighlight lang="c">int smart_card_transmit(int nHandle, unsigned char* pAPDU, unsigned int nAPDULength, unsigned char* pResponse, unsigned int *pResponseLength)</syntaxhighlight >		<syntaxhighlight lang="c">int smart_card_transmit(int nHandle, unsigned char* pAPDU, unsigned int nAPDULength, unsigned char* pResponse, unsigned int *pResponseLength)</syntaxhighlight >
	The function sends a command Application Protocol Data Unit(APDU) to a card and retrieve the response APDU, plus the status words SW1 and SW2.		The function sends a command Application Protocol Data Unit(APDU) to a card and retrieve the response APDU, plus the status words SW1 and SW2.
	~~his api~~ should be used between [[#power_on\|power_on]] and [[#power_off\|power_off]].		This API should be used between [[#power_on\|power_on]] and [[#power_off\|power_off]].
	If the inserted card is a CPU card, call [[#power_on\|power_on]], transmit, [[#power_off\|power_off]] after [[#open\|open]].		If the inserted card is a CPU card, call [[#power_on\|power_on]], transmit, [[#power_off\|power_off]] after [[#open\|open]].
	{\|class="wizarpostable"		{\|class="wizarpostable"

Mahong at 03:29, 3 May 2018

2018-05-03T03:29:41Z

← Older revision		Revision as of 03:29, 3 May 2018
Line 217:		Line 217:
	! 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; <0 [[Error_code\|error code]].
	\|}		\|}


	=== <big>power_off</big>===		=== <big>power_off</big>===
Line 327:		Line 328:
	\| int \|\| The result code, >= 0, success, the data length of read; <0 [[Error_code\|error code]].		\| int \|\| The result code, >= 0, success, the data length of read; <0 [[Error_code\|error code]].
	\|}		\|}


	=== <big>mc_write</big>===		=== <big>mc_write</big>===

Mahong: /* mc_write */

2018-05-03T03:28:47Z

mc_write

← Older revision		Revision as of 03:28, 3 May 2018
Line 355:		Line 355:
	! 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 written; <0 [[Error_code\|error code]].
	\|}		\|}

Mahong: /* mc_read */

2018-05-03T03:28:08Z

mc_read

← Older revision		Revision as of 03:28, 3 May 2018
Line 325:		Line 325:
	! 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 read; <0 [[Error_code\|error code]].
	\|}		\|}

Mahong: /* mc_read */

2018-05-03T03:27:36Z

mc_read

← Older revision		Revision as of 03:27, 3 May 2018
Line 309:		Line 309:
	\| nHandle \|\| '''int:''' Handle of this device, returned from open		\| nHandle \|\| '''int:''' Handle of this device, returned from open
	\|-		\|-
	\| nAreaType \|\| '''unsigned int:''' Area type: 0--main memory,1--protected memory,2--security momory		\| nAreaType \|\| '''unsigned int:''' Area type: 0-main memory; 1-protected memory; 2-security momory
	\|-		\|-
	\| pDataBuffer \|\| '''unsigned char*:''' Data buffer		\| pDataBuffer \|\| '''unsigned char*:''' Data buffer
Line 327:		Line 327:
	\| int \|\| The result code, >= 0, success; <0 [[Error_code\|error code]].		\| int \|\| The result code, >= 0, success; <0 [[Error_code\|error code]].
	\|}		\|}


	=== <big>mc_write</big>===		=== <big>mc_write</big>===

Mahong: /* power_on */

2018-05-03T03:26:04Z

power_on

← Older revision		Revision as of 03:26, 3 May 2018
Line 217:		Line 217:
	! 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; <=0 [[Error_code\|error code]].
	\|}		\|}


	=== <big>power_off</big>===		=== <big>power_off</big>===

Mahong: /* API Overview */

2018-05-03T03:24:34Z

API Overview

← Older revision		Revision as of 03:24, 3 May 2018
Line 21:		Line 21:
	\| pUserData \|\| '''void*:''' User data		\| pUserData \|\| '''void*:''' User data
	\|}		\|}
	typedef void (*SMART_CARD_NOTIFIER)		Definite is as follows:
	~~'''nEvent:'''~~		<syntaxhighlight lang="c">typedef void (*SMART_CARD_NOTIFIER)
	* ''define SMART_CARD_EVENT_INSERT_CARD 0''
	* ''define SMART_CARD_EVENT_REMOVE_CARD 1''
	* ''define SMART_CARD_EVENT_POWER_ON 2''
	* ''define SMART_CARD_EVENT_POWER_OFF 3''

			//nEvent:
			define SMART_CARD_EVENT_INSERT_CARD 0
			define SMART_CARD_EVENT_REMOVE_CARD 1
			define SMART_CARD_EVENT_POWER_ON 2
			define SMART_CARD_EVENT_POWER_OFF 3
			</syntaxhighlight >
	{\|		{\|
	\|-		\|-

Mahong at 09:54, 2 May 2018

2018-05-02T09:54:54Z

Show changes

Mahong at 08:15, 19 April 2018

2018-04-19T08:15:44Z

← Older revision		Revision as of 08:15, 19 April 2018
Line 14:		Line 14:
	{\|		{\|
	\|-		\|-
	\| ''nSlotIndex'' \|\|Slot index, from 0 to MAX - 1		\| ''nSlotIndex'' \|\| int \|\| Slot index, from 0 to MAX - 1
	\|-		\|-
	\| ''pNotify'' \|\| Notifier of smart card reader		\| ''pNotify'' \|\| SMART_CARD_NOTIFIER \|\| Notifier of smart card reader
	\|-		\|-
	\| ''pUserData'' \|\| User data		\| ''pUserData'' \|\| void* \|\| User data
	\|}		\|}
	typedef void (*SMART_CARD_NOTIFIER)		typedef void (*SMART_CARD_NOTIFIER)
Line 40:		Line 40:
	{\|		{\|
	\|-		\|-
	\| ''nHandle'' \|\| Handle of this device, returned from open		\| ''nHandle'' \|\| int \|\| Handle of this device, returned from open
	\|}		\|}
	'''Returns'''		'''Returns'''

Mahong: /* mc_write */

2018-04-16T08:49:18Z

mc_write

← Older revision		Revision as of 08:49, 16 April 2018
Line 256:		Line 256:
	The function is responsible for writing data to memory card.		The function is responsible for writing data to memory card.
	The [[#mc_read\|mc_read]] and [[#mc_write\|mc_write]] APIs are used after [[#mc_verify\|mc_verify]].		The [[#mc_read\|mc_read]] and [[#mc_write\|mc_write]] APIs are used after [[#mc_verify\|mc_verify]].
	If the inserted card is a memory card, call [[#mc_verify\|mc_verify]], [[#mc_read\|mc_read]], [[#mc_write\|mc_write]]after open		If the inserted card is a memory card, call [[#mc_verify\|mc_verify]], [[#mc_read\|mc_read]], [[#mc_write\|mc_write]] after open