API: Difference between revisions

Latest revision as of 09:03, 11 July 2019

API Overview

The calling sequence is open>query_status>begin>write>end>close. Please notice that:

write method is used for printing content.
print content should be between begin method and end method.
query_status should be between open method and close method, but should not be between begin method and end method

open

int printer_open()

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

Returns
int	The result code, >= 0, success; <0 error code.

begin

int printer_begin()

Prepare to print, the app should print data after this function.

Returns
int	The result code, >= 0, success; <0 error code.

end

int printer_end()

End to print,the begin and end API are pair operations.

Returns
int	The result code, >= 0, success; <0 error code.

close

int printer_close()

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.

Returns
int	The result code, >= 0, success; <0 error code.

query_status

int printer_query_status()

Query the status of the printer.This API should be used inner open and close, but not inner begin and end.

Returns
int	The result code, == 1: has paper; == 0: success; <0 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.

Parameters
pData	*unsigned char:** data or ESC command
nDataLength	int:Length of data

Returns
int	The result code, >= 0, write success, the data length of wrote; <0 error code.

@@ Line 1: / Line 1: @@
-==== Functions ====
+== API Overview ==
 The calling sequence is open>query_status>begin>write>end>close. Please notice that:
 * [[#write|write]] method is used for printing content.
 * 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
-===== open =====
+=== <big>open</big> ===
-   int printer_open()
+   <syntaxhighlight lang="c">int printer_open()</syntaxhighlight >
 Open the printer device.This operation should be used before other operations.
+{|class="wizarpostable"
-'''Parameters'''
+|-
+!  scope="row" colspan="2"| Returns
-'''Returns'''
+|-
+| int || The result code, >= 0, success; <0 [[Error_code|error code]].
-The result code, >= 0, success; <0 [[Error_code|error code]].
+|}
-===== begin =====
-  int printer_begin()
-Prepare to print, the app should print data after this funciton.
-'''Parameters'''
+===<big>begin</big> ===
+  <syntaxhighlight lang="c">int printer_begin()</syntaxhighlight >
+Prepare to print, the app should print data after this function.
+{|class="wizarpostable"
+|-
+!  scope="row" colspan="2"| Returns
+|-
+| int || The result code, >= 0, success; <0 [[Error_code|error code]].
+|}
-'''Returns'''
-The result code, >= 0, success; <0 [[Error_code|error code]].
+===<big>end</big> ===
+  <syntaxhighlight lang="c">int printer_end()</syntaxhighlight >
+End to print,the begin and end API are pair operations.
+{|class="wizarpostable"
+|-
+!  scope="row" colspan="2"| Returns
+|-
+| int || The result code, >= 0, success; <0 [[Error_code|error code]].
+|}
-===== end =====
-  int printer_end()
-End to print,the begin and end apis are pair operations.
-'''Parameters'''
+=== <big>close</big> ===
+  <syntaxhighlight lang="c">int printer_close()</syntaxhighlight >
+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"
+|-
+!  scope="row" colspan="2"| Returns
+|-
+| int || The result code, >= 0, success; <0 [[Error_code|error code]].
+|}
-'''Returns'''
-The result code, >= 0, success; <0 [[Error_code|error code]].
+=== <big>query_status</big> ===
+  <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.
+{|class="wizarpostable"
+|-
+!  scope="row" colspan="2"| Returns
+|-
+| int || The result code, '''== 1: has paper'''; '''== 0: success'''; <0 [[Error_code|error code]].
+|}
-===== close =====
+===<big>write</big> ===
-  int printer_close()
+   <syntaxhighlight lang="c">int printer_write(unsigned char* pData, int nDataLength)</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.
-'''Parameters'''
-'''Returns'''
-The result code, >= 0, success; <0 [[Error_code|error code]].
-===== query_status =====
-   int printer_query_status()
-Query the status of the printer.This api should be used inner open and close, but not inner begin and end.
-'''Parameters'''
-'''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]].
+{| class="wizarpostable"
+|-
+!  scope="row" colspan="2"| Parameters
+|-
+| pData || '''unsigned char*:''' data or ESC command
+|-
+| nDataLength|| '''int:'''Length of data
+|}
+{|
+|-
+|
+|}
+{|class="wizarpostable"
-'''Parameters'''
-{|
 |-
-| ''pData'' || unsigned char* || data or ESC command
+!  scope="row" colspan="2"| Returns
 |-
-| ''nDataLength''|| int ||Length of data
+| int || The result code, >= 0, write success, the data length of wrote; <0 [[Error_code|error code]].
 |}
-'''Returns'''
-The result code, >= 0, success; <0 [[Error_code|error code]].
-===== read =====
+=== read ===
-===== query_voltage =====
+=== query_voltage ===