API - Revision history

Mahong: /* query_status */

2019-07-11T09:03:45Z

query_status

← Older revision		Revision as of 09:03, 11 July 2019
Line 56:		Line 56:
	! scope="row" colspan="2"\| Returns		! scope="row" colspan="2"\| Returns
	\|-		\|-
	\| int \|\| The result code, == 1, has paper; == 0, success; <0 [[Error_code\|error code]].		\| int \|\| The result code, '''== 1: has paper'''; '''== 0: success'''; <0 [[Error_code\|error code]].
	\|}		\|}


	===<big>write</big> ===		===<big>write</big> ===

Mahong at 09:29, 11 March 2019

2019-03-11T09:29:50Z

← Older revision		Revision as of 09:29, 11 March 2019
Line 18:		Line 18:
	===<big>begin</big> ===		===<big>begin</big> ===
	<syntaxhighlight lang="c">int printer_begin()</syntaxhighlight >		<syntaxhighlight lang="c">int printer_begin()</syntaxhighlight >
	Prepare to print, the app should print data after this ~~funciton~~.		Prepare to print, the app should print data after this function.
	{\|class="wizarpostable"		{\|class="wizarpostable"
	\|-		\|-
Line 29:		Line 29:
	===<big>end</big> ===		===<big>end</big> ===
	<syntaxhighlight lang="c">int printer_end()</syntaxhighlight >		<syntaxhighlight lang="c">int printer_end()</syntaxhighlight >
	End to print,the begin and end ~~apis~~ are pair operations.		End to print,the begin and end API are pair operations.
	{\|class="wizarpostable"		{\|class="wizarpostable"
	\|-		\|-
Line 40:		Line 40:
	=== <big>close</big> ===		=== <big>close</big> ===
	<syntaxhighlight lang="c">int printer_close()</syntaxhighlight >		<syntaxhighlight lang="c">int printer_close()</syntaxhighlight >
	Close the device.The open and close ~~apis~~ are pair operations. If you don’t want to use the device, you should call close to release the device.		Close the device.The open and close API are pair operations. If you don’t want to use the device, you should call close to release the device.
	{\|class="wizarpostable"		{\|class="wizarpostable"
	\|-		\|-
Line 51:		Line 51:
	=== <big>query_status</big> ===		=== <big>query_status</big> ===
	<syntaxhighlight lang="c">int printer_query_status()</syntaxhighlight >		<syntaxhighlight lang="c">int printer_query_status()</syntaxhighlight >
	Query the status of the printer.This ~~api~~ should be used inner open and close, but not inner begin and end.		Query the status of the printer.This API should be used inner open and close, but not inner begin and end.
	{\|class="wizarpostable"		{\|class="wizarpostable"
	\|-		\|-
Line 80:		Line 80:
	! scope="row" colspan="2"\| Returns		! scope="row" colspan="2"\| Returns
	\|-		\|-
	\| int \|\| The result code, >= 0, write success, the data length of ~~writed~~; <0 [[Error_code\|error code]].		\| int \|\| The result code, >= 0, write success, the data length of wrote; <0 [[Error_code\|error code]].
	\|}		\|}

	=== read ===		=== read ===
	=== query_voltage ===		=== query_voltage ===

Mahong: /* write */

2018-05-03T01:56:00Z

write

← Older revision		Revision as of 01:56, 3 May 2018
Line 80:		Line 80:
	! 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, write success, the data length of writed; <0 [[Error_code\|error code]].
	\|}		\|}

	=== read ===		=== read ===
	=== query_voltage ===		=== query_voltage ===

Mahong at 06:55, 2 May 2018

2018-05-02T06:55:44Z

← Older revision		Revision as of 06:55, 2 May 2018
Line 71:		Line 71:
	\| nDataLength\|\| '''int:'''Length of data		\| nDataLength\|\| '''int:'''Length of data
	\|}		\|}
			{\|
			\|-
			\|
			\|}

	{\|class="wizarpostable"		{\|class="wizarpostable"

Mahong at 06:35, 2 May 2018

2018-05-02T06:35:28Z

← Older revision		Revision as of 06:35, 2 May 2018
Line 4:		Line 4:
	* print content should be between [[#begin\|begin]] method and [[#end\|end]] method.		* print content should be between [[#begin\|begin]] method and [[#end\|end]] method.
	* [[#query_status\|query_status]] should be between [[#open\|open]] method and [[#close\|close]] method, but should not be between [[#begin\|begin]] method and [[#end\|end]] method		* [[#query_status\|query_status]] should be between [[#open\|open]] method and [[#close\|close]] method, but should not be between [[#begin\|begin]] method and [[#end\|end]] method
	=== open ===		=== <big>open</big> ===
	<syntaxhighlight lang="c">int printer_open()</syntaxhighlight >		<syntaxhighlight lang="c">int printer_open()</syntaxhighlight >

	Open the printer device.This operation should be used before other operations.		Open the printer device.This operation should be used before other operations.

	{\|class="wizarpostable"		{\|class="wizarpostable"
	\|-		\|-
Line 16:		Line 15:
	\|}		\|}

	===begin ===
			===<big>begin</big> ===
	<syntaxhighlight lang="c">int printer_begin()</syntaxhighlight >		<syntaxhighlight lang="c">int printer_begin()</syntaxhighlight >
	Prepare to print, the app should print data after this funciton.		Prepare to print, the app should print data after this funciton.

	{\|class="wizarpostable"		{\|class="wizarpostable"
	\|-		\|-
Line 27:		Line 26:
	\|}		\|}

	===end ===
			===<big>end</big> ===
	<syntaxhighlight lang="c">int printer_end()</syntaxhighlight >		<syntaxhighlight lang="c">int printer_end()</syntaxhighlight >
	End to print,the begin and end apis are pair operations.		End to print,the begin and end apis are pair operations.

	{\|class="wizarpostable"		{\|class="wizarpostable"
	\|-		\|-
Line 38:		Line 37:
	\|}		\|}

	=== close ===
			=== <big>close</big> ===
	<syntaxhighlight lang="c">int printer_close()</syntaxhighlight >		<syntaxhighlight lang="c">int printer_close()</syntaxhighlight >
	Close the device.The open and close apis are pair operations. If you don’t want to use the device, you should call close to release the device.		Close the device.The open and close apis are pair operations. If you don’t want to use the device, you should call close to release the device.

	{\|class="wizarpostable"		{\|class="wizarpostable"
	\|-		\|-
Line 49:		Line 48:
	\|}		\|}

	=== query_status ===
			=== <big>query_status</big> ===
	<syntaxhighlight lang="c">int printer_query_status()</syntaxhighlight >		<syntaxhighlight lang="c">int printer_query_status()</syntaxhighlight >
	Query the status of the printer.This api should be used inner open and close, but not inner begin and end.		Query the status of the printer.This api should be used inner open and close, but not inner begin and end.

	{\|class="wizarpostable"		{\|class="wizarpostable"
	\|-		\|-
Line 60:		Line 59:
	\|}		\|}

	===write ===
			===<big>write</big> ===
	<syntaxhighlight lang="c">int printer_write(unsigned char* pData, int nDataLength)</syntaxhighlight >		<syntaxhighlight lang="c">int printer_write(unsigned char* pData, int nDataLength)</syntaxhighlight >
	Write data to the device. The data can be String, Bitmap data or [[ESC Commands]].		Write data to the device. The data can be String, Bitmap data or [[ESC Commands]].

	{\| class="wizarpostable"		{\| class="wizarpostable"
	\|-		\|-
Line 72:		Line 71:
	\| nDataLength\|\| '''int:'''Length of data		\| nDataLength\|\| '''int:'''Length of data
	\|}		\|}


	{\|class="wizarpostable"		{\|class="wizarpostable"

Mahong at 01:54, 2 May 2018

2018-05-02T01:54:47Z

← Older revision		Revision as of 01:54, 2 May 2018
Line 1:		Line 1:
	==~~== Functions ==~~==		== API Overview ==
	The calling sequence is open>query_status>begin>write>end>close. Please notice that:		The calling sequence is open>query_status>begin>write>end>close. Please notice that:
	* [[#write\|write]] method is used for printing content.		* [[#write\|write]] method is used for printing content.
	* print content should be between [[#begin\|begin]] method and [[#end\|end]] method.		* print content should be between [[#begin\|begin]] method and [[#end\|end]] method.
	* [[#query_status\|query_status]] should be between [[#open\|open]] method and [[#close\|close]] method, but should not be between [[#begin\|begin]] method and [[#end\|end]] method		* [[#query_status\|query_status]] should be between [[#open\|open]] method and [[#close\|close]] method, but should not be between [[#begin\|begin]] method and [[#end\|end]] method
	===== open =====		=== open ===
	int printer_open()		<syntaxhighlight lang="c">int printer_open()</syntaxhighlight >

	Open the printer device.This operation should be used before other operations.		Open the printer device.This operation should be used before other operations.

	~~'''Parameters'''~~		{\|class="wizarpostable"
			\|-
	~~'''~~Returns~~'''~~		! scope="row" colspan="2"\| Returns
			\|-
	The result code, >= 0, success; <0 [[Error_code\|error code]].		\| int \|\| The result code, >= 0, success; <0 [[Error_code\|error code]].
			\|}

	===== begin =====		===begin ===
	int printer_begin()		<syntaxhighlight lang="c">int printer_begin()</syntaxhighlight >
	Prepare to print, the app should print data after this funciton.		Prepare to print, the app should print data after this funciton.

	~~'''Parameters'''~~		{\|class="wizarpostable"
			\|-
	~~'''~~Returns~~'''~~		! scope="row" colspan="2"\| Returns
			\|-
	The result code, >= 0, success; <0 [[Error_code\|error code]].		\| int \|\| The result code, >= 0, success; <0 [[Error_code\|error code]].
			\|}

	===== end =====		===end ===
	int printer_end()		<syntaxhighlight lang="c">int printer_end()</syntaxhighlight >
	End to print,the begin and end apis are pair operations.		End to print,the begin and end apis are pair operations.

	~~'''Parameters'''~~		{\|class="wizarpostable"
			\|-
	~~'''~~Returns~~'''~~		! scope="row" colspan="2"\| Returns
			\|-
	The result code, >= 0, success; <0 [[Error_code\|error code]].		\| int \|\| The result code, >= 0, success; <0 [[Error_code\|error code]].
			\|}

	===== close =====		=== close ===
	int printer_close()		<syntaxhighlight lang="c">int printer_close()</syntaxhighlight >
	Close the device.The open and close apis are pair operations. If you don’t want to use the device, you should call close to release the device.		Close the device.The open and close apis are pair operations. If you don’t want to use the device, you should call close to release the device.

	~~'''Parameters'''~~		{\|class="wizarpostable"
			\|-
	~~'''~~Returns~~'''~~		! scope="row" colspan="2"\| Returns
			\|-
	The result code, >= 0, success; <0 [[Error_code\|error code]].		\| int \|\| The result code, >= 0, success; <0 [[Error_code\|error code]].
			\|}

	===== query_status =====		=== query_status ===
	int printer_query_status()		<syntaxhighlight lang="c">int printer_query_status()</syntaxhighlight >
	Query the status of the printer.This api should be used inner open and close, but not inner begin and end.		Query the status of the printer.This api should be used inner open and close, but not inner begin and end.

			{\|class="wizarpostable"
			\|-
			! scope="row" colspan="2"\| Returns
			\|-
			\| int \|\| The result code, == 1, has paper; == 0, success; <0 [[Error_code\|error code]].
			\|}

	~~'''Parameters'''~~		===write ===
			<syntaxhighlight lang="c">int printer_write(unsigned char* pData, int nDataLength)</syntaxhighlight >
	~~'''Returns'''~~

	~~The result code, == 1, has paper; == 0, success; <0 [[Error_code\|error code]].~~

	==== write ====
	int printer_write(unsigned char* pData, int nDataLength)
	Write data to the device. The data can be String, Bitmap data or [[ESC Commands]].		Write data to the device. The data can be String, Bitmap data or [[ESC Commands]].


	~~'''Parameters'''~~
	{\| class="wizarpostable"		{\| class="wizarpostable"
	\|-		\|-
	\| '~~'pData~~'' \|\| unsigned char* \|\| data or ESC command		! scope="row" colspan="2"\| Parameters
			\|-
			\| pData \|\| '''unsigned char*:''' data or ESC command
	\|-		\|-
	\| ''~~nDataLength~~''~~\|\| int \|\|~~Length of data		\| nDataLength\|\| '''int:'''Length of data
	\|}		\|}
	~~'''Returns'''~~

	The result code, >= 0, success; <0 [[Error_code\|error code]].		{\|class="wizarpostable"
			\|-
	===== read =====		! scope="row" colspan="2"\| Returns
	===== query_voltage =====		\|-
			\| int \|\| The result code, >= 0, success; <0 [[Error_code\|error code]].
			\|}
			=== read ===
			=== query_voltage ===

Mahong: /* write */

2018-04-28T09:55:02Z

write

← Older revision		Revision as of 09:55, 28 April 2018
Line 56:		Line 56:
	The result code, == 1, has paper; == 0, success; <0 [[Error_code\|error code]].		The result code, == 1, has paper; == 0, success; <0 [[Error_code\|error code]].

	===== write =====		==== write ====
	int printer_write(unsigned char* pData, int nDataLength)		int printer_write(unsigned char* pData, int nDataLength)
	Write data to the device. The data can be String, Bitmap data or [[ESC Commands]].		Write data to the device. The data can be String, Bitmap data or [[ESC Commands]].

Admin: /* write */

2018-04-28T09:40:25Z

write

← Older revision		Revision as of 09:40, 28 April 2018
Line 62:		Line 62:

	'''Parameters'''		'''Parameters'''
	{\|		{\| class="wizarpostable"
	\|-		\|-
	\| ''pData'' \|\| unsigned char* \|\| data or ESC command		\| ''pData'' \|\| unsigned char* \|\| data or ESC command

Mahong: /* write */

2018-04-18T08:10:55Z

write

← Older revision		Revision as of 08:10, 18 April 2018
Line 64:		Line 64:
	{\|		{\|
	\|-		\|-
	\| ''pData'' \|\| data or ESC command		\| ''pData'' \|\| unsigned char* \|\| data or ESC command
	\|-		\|-
	\| ''nDataLength''\|\| Length of data		\| ''nDataLength''\|\| int \|\|Length of data
	\|}		\|}
	'''Returns'''		'''Returns'''

	The result code, >= 0, success; <0 [[Error_code\|error code]].		The result code, >= 0, success; <0 [[Error_code\|error code]].

	===== read =====		===== read =====
	===== query_voltage =====		===== query_voltage =====

Mahong: /* Functions */

2018-04-12T08:40:57Z

Functions

← Older revision		Revision as of 08:40, 12 April 2018
Line 1:		Line 1:
	==== Functions ====		==== Functions ====
	The calling sequence is open>query_status>begin>write>end>close. Please notice that:		The calling sequence is open>query_status>begin>write>end>close. Please notice that:
	* [[#write]] method is used for printing content.		* [[#write\|write]] method is used for printing content.
	* print content should be between [[#begin]] method and [[end]] method.		* print content should be between [[#begin\|begin]] method and [[#end\|end]] method.
	* [[query_status]] should be between [[open]] method and [[close]] method, but should not be between [[begin]] method and [[end]] method		* [[#query_status\|query_status]] should be between [[#open\|open]] method and [[#close\|close]] method, but should not be between [[#begin\|begin]] method and [[#end\|end]] method
	===== open =====		===== open =====
	int printer_open()		int printer_open()