root/campo-sirio
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
campo-sirio/ps/Command Library/PPLA/Doc/AWIN-API.txt

1376 lines
71 KiB
Plaintext
Raw Normal View History

Patch level : 4.0 667 Files correlati : Ricompilazione Demo : [ ] Commento : Riportata la versione 3.1 patch 766 git-svn-id: svn://10.65.10.50/trunk@14628 c028cbd2-c16b-5b4b-a496-9718f37d4682
2006-12-13 16:22:33 +00:00
/******************************************************************************
Module: API.TXT
All commands for PPLA in Dynamic Link Library under Windows
Notices: Copyright (c) 1998-2006 ARGOIMPREX
Version: 3.04AW 2006/02/15
******************************************************************************/
Contents
===============================================================================
A_Bar2d_Maxi() => Create the 2D barcode object - Maxicode.
A_Bar2d_Maxi_Ori() => Create the 2D barcode object - Maxicode with Orientation.
A_Bar2d_PDF417() => Create the 2D barcode object - PDF-417.
A_Bar2d_PDF417_Ori() => Create the 2D barcode object - PDF-417 with Orientation.
A_Bar2d_DataMatrix() => Create the 2D barcode object - DataMatrix.
A_Clear_Memory() => Clear resident memory - both RAM and Flash memory.
A_ClosePrn() => Stop printer operation.
A_CreatePrn() => Start printer opreation.
A_Del_Graphic() => Clean the stored "graphic data" in RAM or Flash memory.
A_Draw_Box() => Create a "box" object.
A_Draw_Line() => Create an "line" object.
A_Feed_Label() => Feed out one label from printer.
A_Get_DLL_Version() => Get or show this verison for library.
A_Get_DLL_VersionA() => Get or show this verison for library.
A_Get_Graphic() => Download graph data from PC into the printer's RAM
or Flash memory.
A_Get_Graphic_ColorBMP()=> Convert the colorBMP data from PC into mono graphic(
dithering pattern) and download it into printer's
RAM or Flash memory.
A_Initial_Setting() => Perform the initial paprameter setting (send the
command code into printer directly).
A_Load_Graphic() => Acquire the graphic data which stored in the RAM or
Flash memory.
A_Open_ChineseFont() => Open Chinese dot font file (16*15 and 24*24).
A_Print_Form() => Perform printing function. And acquire the form data
which stored in RAM or Flash memory.
A_Print_Out() => Perform printing function.
A_Prn_Barcode() => Create a "barcode" object.
A_Prn_Text() => Create a "text" object.
A_Prn_Text_Chinese() => Create a "text" object with Chinese dot font file
(16*15 or 24*24).
A_Prn_Text_TrueType() => Create a "True Type Font" text object.
A_Prn_Text_TrueType_W() => Create a "True Type Font" text object with Height and Width.
A_Set_Backfeed() => Setup the "back feed" function.
A_Set_BMPSave() => Save Image File.
A_Set_Cutting() => Setup the "cutting" function.
A_Set_Darkness() => Setup the "darkness" function (heating level).
A_Set_DebugDialog() => Enable Debug Message Dialog.
A_Set_Feed() => Setup the "label feeding" speed.
A_Set_Form() => Download a form from PC into printers RAM or Flash memory.
A_Set_Margin() => Setup the top and left margin.
A_Set_Prncomport() => Setup the serial port for printer.
A_Set_Prncomport_PC() => Setup the serial port for PC.
A_Set_Sensor_Mode() => Setup the "sensoring" mode (gap, black mark, continuous).
A_Set_Speed() => Setup the "print speed".
A_Set_Syssetting() => Other function setup e.g. printing type, cutter and
dispenser configuration, label length, slash zero mark,
pause function ....
A_Set_Unit() => Setup measurement unit (metric or inches).
A_Set_Gap() => Set the distance of gap.
A_Set_Logic() => Set logic image mode
A_Set_ProcessDlg() => Set the Process Dialog.
A_Set_LabelVer() => Set Vertical Center. (For R400)
A_GetUSBBufferLen() => Get USB port data length
A_EnumUSB() => Enum USB port
A_CreateUSBPort() => Open USB port
*******************************************************************************
Attention
===============================================================================
1.Please set up execute path as:
\\Windows\system\winppla.dll or current path.
2.All sample descriptions are based on the syntax of Visual C++.
*******************************************************************************
A_GetUSBBufferLen()
A_EnumUSB()
===============================================================================
PURPOSE Preper to Open USB port
SYNTAX int A_GetUSBBufferLen();
int A_EnumUSB(char *buf);
PARAMETER char *buf; To save the USB port data
RETURN
A_GetUSBBufferLen() return the USB data buffer length;
A_EnumUSB(char *buf) 0 -> OK.
Reference AW-Error.txt file.
EXAMPLE
char *buf;
int nLen = A_GetUSBBufferLen()+1;
buf = malloc(nLen);
memset(buf, 0, nLen);
A_EnumUSB(buf);
REMARK Above functions shall co-work together. While request for USB data,
first to call A_GetUSBBufferLen() to get the length, then share the
memory to buf. After that, call A_EnumUSB(), to split each data with
("0x0d0x0a"). e.q. A-200(0x0d)(0x0a)R-400ZIP stands for two printers
are connected to PC, port 1 is A-200 and port 2 is R-400Zip
*******************************************************************************
A_CreatePrn()
A_CreateUSBPort()
===============================================================================
PURPOSE Start printer opreation.
SYNTAX int A_CreatePrn(int selection, LPCTSTR filename);
int A_CreateUSBPort(int nPort);
PARAMETER int selection; To select the printer port.
0 -> print to file.
1 -> lpt1, 2 -> lpt2, 3 -> lpt3
4 -> com1, 5 -> com2, 6 -> com3
10 -> net
LPCTSTR filename; If selection is 0 , print to file.
If selection is 10,filename is the path.
The "file name" can be under current
directory or full directory path or NULL.
int nPort; USB port
RETURN 0 -> OK.
Reference AW-Error.txt file.
EXAMPLE A_CreatePrn(1,NULL); or A_CreatePrn(0,"C:\TEMP\out.prn");
A_CreatePrn(10,"\\allen\Label"); or A_CreateUSBPort(1);
REMARK The A_CreatePrn and A_CreateUSBPort function will activate a valid
printer port or "print to file" path. This function must be performed
before all commands.
A_CreatePrn and A_CreateUSBPort must use one of it at once.
*******************************************************************************
A_ClosePrn()
===============================================================================
PURPOSE Stop printer operation.
SYNTAX void A_ClosePrn(void);
EXAMPLE A_ClosePrn();
REMARK The A_ClosePrn function will access the port that you choiced or
close file. The function must be performed after all commands placed.
*******************************************************************************
A_Bar2d_Maxi()
A_Bar2d_Maxi_Ori()
===============================================================================
PURPOSE Create the 2D barcode object - Maxicode.
SYNTAX int A_Bar2d_Maxi(int x, int y, long int primary, int secondary,
int country, int service, char mode, int numeric,
LPCTSTR data);
int A_Bar2d_Maxi_Ori(int x,int y,int ori,long int primary,int secondary,
int country,int service,char mode,int numeric,
LPCTSTR data);
PARAMETER int x; X coordinate.
int y; Y coordinate.
int ori; Orientation or print direction.
Value: 1,2,3,4
long int primary; A 5-digit primary zip code.
int secondary; A 4-digit secondary zip code.
int country; A 3-digit country code.
int service; A 3-digit service code.
char mode; Add function as follows:
+----+-------------------------------------+
|mode| REMARK |
+----+-------------------------------------+
| A |Make auto increment for numeric. |
+----+-------------------------------------+
| B |Make auto increment for alphanumeric.|
+----+-------------------------------------+
| C |Make auto decrement for numeric. |
+----+-------------------------------------+
| D |Make auto decrement for alphanumeric.|
+----+-------------------------------------+
| T |Change End character. |
+----+-------------------------------------+
| N |Disable. |
+----+-------------------------------------+
int numeric; Automatically increment or decrement the
filed value. Value:0~99.
LPCTSTR data; Data string. Up to 84 characters.
RETURN 0 -> OK.
Reference AW-Error.txt file.
EXAMPLE A_Bar2d_Maxi(155,0,32987,444,40,55,'n',2,"TO 123");
*******************************************************************************
A_Bar2d_PDF417()
A_Bar2d_PDF417_Ori()
===============================================================================
PURPOSE Create the 2D barcode object - PDF-417.
SYNTAX int A_Bar2d_PDF417(int x, int y, int narrow, int width, char normal,
int security, int aspect, int row, int column,
char mode, int numeric, LPCTSTR data);
int A_Bar2d_PDF417_Ori(int x,int y,int ori,int narrow,int width,
char normal,int security,int aspect,int row,
int column,char mode,int numeric,LPCTSTR data);
PARAMETER int x; X coordinate.
int y; Y coordinate.
int ori; Orientation or print direction.
Value: 1,2,3,4
int narrow; define the narrow bar width from 1 to 24.
int width; define the wide bar width from 1 to 24.
char normal; F: normal, T: truncated.
int security; 0~8: security level.
int aspect; 0~99: aspect ratio, 0 stands for 1:2.
int row; 3~90: row number, 0 for best fit.
int column; 1~30: column number,0 for best fit.
char mode; Add function as follows:
+----+-------------------------------------+
|mode| REMARK |
+----+-------------------------------------+
| A |Make auto increment for numeric. |
+----+-------------------------------------+
| B |Make auto increment for alphanumeric.|
+----+-------------------------------------+
| C |Make auto decrement for numeric. |
+----+-------------------------------------+
| D |Make auto decrement for alphanumeric.|
+----+-------------------------------------+
| T |Change End character. |
+----+-------------------------------------+
| N |Disable. |
+----+-------------------------------------+
int numeric; Automatically increment or decrement the
filed value. Value:0~99.
If mode is "T", the numeric is end character value
(Decimal ASCII).
LPCTSTR data; Data string.
RETURN 0 -> OK.
Reference AW-Error.txt file.
EXAMPLE A_Bar2d_PDF417(260,0,0,0,'f',0,0,10,2,'b',1,"ARGOXINFO");
*******************************************************************************
A_Bar2d_DataMatrix()
===============================================================================
PURPOSE Create the 2D barcode object - DataMatrix.
SYNTAX int A_Bar2d_DataMatrix(int x, int y,int rotation,int hor_mul,
int ver_mul,int ECC,int data_format,int num_rows,int num_col,
char mode,int numeric,LPCTSTR data);
PARAMETER int x; X coordinate.
int y; Y coordinate.
int rotation; Orientation or print direction.
Value: 1,2,3,4
int hor_mul; module size horizontal multiplier.
int ver_mul; module size vertical multiplier.
hor_mul,ver_mul value : 1 ~ 24
int ECC; error correction level;
it must be fixed: 200
int data_format data format.
it must be fixed: 0
int num_rows even number of rows.
int num_col even number of columns.
num_rows,num_col value : 10,12,14,16,18,20,22,24,26,32,36,
40,44,,48,52,64,72,80,88,96,104,120,132,144
char mode; Add function as follows:
+----+-------------------------------------+
|mode| REMARK |
+----+-------------------------------------+
| A |Make auto increment for numeric. |
+----+-------------------------------------+
| B |Make auto increment for alphanumeric.|
+----+-------------------------------------+
| C |Make auto decrement for numeric. |
+----+-------------------------------------+
| D |Make auto decrement for alphanumeric.|
+----+-------------------------------------+
| T |Change End character. |
+----+-------------------------------------+
| N |Disable. |
+----+-------------------------------------+
int numeric; Automatically increment or decrement the
filed value. Value:0~99.
LPCTSTR data; Data string.
RETURN 0 -> OK.
Reference AW-Error.txt file.
EXAMPLE A_Bar2d_DataMatrix(100,100,1,8,8,200,0,24,24,'n',2,"DATAMATRIX");
*******************************************************************************
A_Clear_Memory()
===============================================================================
PURPOSE Clear resident memory - both RAM and Flash memory.
SYNTAX void A_Clear_Memory(void);
EXAMPLE A_Clear_Memory();
REMARK The A_Clear_Memory function will clear all the graphics and soft
fonts which stored in the printers memory(both RAM and flash
memory). Normally this function is sent before the A_Print_Out().
Otherwise the graphics and fonts will be accumulated, and cause
memory overflow. When "memory full" occurs, the printer will erase
the first-in graphics or fonts. To avoid memory full and save
processing time, you may send this function before the A_Print_Out().
*******************************************************************************
A_Del_Graphic()
===============================================================================
PURPOSE Clean the stored "graphic data" in RAM or Flash memory.
SYNTAX int A_Del_Graphic(int mem_mode,char graphic[10]);
PARAMETER int mem_mode; Memory mode, 1 => RAM
2 => Flash Memory
char graphic[10]; Maximum 9 characters for the graghic data name.
RETURN 0 -> OK.
Reference AW-Error.txt file.
EXAMPLE A_Del_Graphic(1,"AA");
REMARK The A_Del_Graphic function will delete the graphics data which
already stored in printers RAM or flash memory. If certain gragics
data was deleted, it will not be retrieved and printed unless be
reloaded.
*******************************************************************************
A_Draw_Box()
===============================================================================
PURPOSE Create a "box" object.
SYNTAX int A_Draw_Box(char mode, int x, int y, int width, int height,
int top, int side);
PARAMETER char mode; Set logical OR or XOR operation.
A for XOR, N for OR.
int x; X coordinate.
int y; X coordinate.
int width; Specifies the width of box. 0 ~ 9999.
int height; Specifies the height of box. 0 ~ 9999.
int top; Specifies the thickness of top and
bottom box edges. Value:0 ~ 9999.
int side; Specifies the thickness of side edges.
Value:0 ~ 9999.
RETURN 0 -> OK.
Reference AW-Error.txt file.
EXAMPLE A_Draw_Box('N',260,30,130,105,4,4);
REMARK The A_Draw_Box function will draw a box by "OR" or "XOR" operation.
*******************************************************************************
A_Draw_Line()
===============================================================================
PURPOSE Create an "line" object.
SYNTAX int A_Draw_Line(char mode,int x,int y,int width,int height);
PARAMETER char mode; Set logical OR or XOR operation.
A for XOR, N for OR.
int x; X coordinate.
int y; X coordinate.
int width; Specifies the width of line from 0~9999.
int height; Specifies the height of line from 0~9999.
RETURN 0 -> OK.
Reference AW-Error.txt file.
EXAMPLE A_Draw_Line('a',285,77,2,30);
REMARK The Draw_Line function will draw a line by "OR" or "XOR" operation.
*******************************************************************************
A_Feed_Label()
===============================================================================
PURPOSE Feed out one label from printer.
SYNTAX void A_Feed_Label(void);
EXAMPLE A_Feed_Label();
REMARK This function will feed out a label till its gap was detected.
If the paper is in continuous type, it will feed a prefixed length
and perform the same operation when pressing the "Feed" button.
******************************************************************************
A_Get_DLL_Version()
A_Get_DLL_VersionA()
==============================================================================
PURPOSE Get or show this verison for library.
SYNTAX char* A_Get_DLL_Version(int nShowMessage);
int A_Get_DLL_VersionA(int nShowMessage);
PARAMETER int nShowMessage; 0 -> The message dailog isn't showed.
1 -> The message dailog is showed.
RETURN A_Get_DLL_Version() -> Library verison string, if fail return null.
A_Get_DLL_VersionA() -> return version value.
EXAMPLE A_Get_DLL_Version(1);
REMARK The A_Get_DLL_Version function is used to get or show this
verison for library.
*******************************************************************************
A_Get_Graphic()
===============================================================================
PURPOSE Download graph data from PC into the printer's RAM or Flash memory.
SYNTAX int A_Get_Graphic(int x, int y, int mem_mode, char format,
LPCTSTR filename);
PARAMETER int x; X coordinate.
int y; Y coordinate.
int mem_mode; Memory mode, 1 => RAM
2 => Flash Memory
char format; Image file format.
+------+---------------------+---------+
|format|Image File Format |Direction|
+------+---------------------+---------+
| B |8-bit BMP file format|flipped |
+------+---------------------+---------+
| b |8-bit BMP file format| |
+------+---------------------+---------+
| I |8-bit IMG file format|flipped |
+------+---------------------+---------+
| i |8-bit IMG file format| |
+------+---------------------+---------+
| P |8-bit PCX file format|flipped |
+------+---------------------+---------+
| p |8-bit PCX file format| |
+------+---------------------+---------+
LPCTSTR filename; File name of graphic data with path.
The format is XXXXXXXX.XXX or X:\XXX\XXX.XXX
RETURN 0 -> OK.
Reference AW-Error.txt file.
EXAMPLE A_Get_Graphic(275,50,1,'B',"bb.bmp");
REMARK The Get_Graphic function will store graphic object in RAM memory.
*******************************************************************************
A_Get_Graphic_ColorBMP()
===============================================================================
PURPOSE Convert the colorBMP data from PC into mono graphic (dithering
pattern) and download it into printer's RAM or Flash memory.
SYNTAX int A_Get_Graphic_ColorBMP(int x, int y, int mem_mode, char format,
LPCTSTR filename);
PARAMETER int x; X coordinate.
int y; Y coordinate.
int mem_mode; Memory mode, 1 => RAM
2 => Flash Memory
char format; Image file format.
+------+------------+---------+
|format|Image Format|Direction|
+------+------------+---------+
| B | BMP format |flipped |
+------+------------+---------+
| b | BMP format | |
+------+------------+---------+
LPCTSTR filename; File name of graphic with path.
The format is XXXXXXXX.XXX or X:\XXX\XXX.XXX
RETURN 0 -> OK.
Reference AW-Error.txt file.
EXAMPLE A_Get_Graphic_ColorBMP(30,20,1,'B',"girl.bmp");
REMARK The A_Get_Graphic_ColorBMP function will convert color file into mono
file for data Storing and Printing.But you must install Window's
Driver for Dr.200 or Dr.300 first. And adjust the darkness. This
function will first search the Windows driver (Dr.200 or Dr.300)
from PCs existing default driver. If the default driver is for
other printer, it will sreach Dr.200 and then Dr.300.
*******************************************************************************
A_Initial_Setting()
===============================================================================
PURPOSE Perform the initial paprameter setting (send the command code into
printer directly).
SYNTAX int A_Initial_Setting(int Type,LPCTSTR Source);
PARAMETER int Type; To choose type to input.
The value is 0 -> to import a string.
The value is 1 -> to import a file.
LPCTSTR Source; The data source is string or file name
in path.
RETURN 0 -> OK.
Reference AW-Error.txt file.
EXAMPLE LPCTSTR aa = "ZT\r\n\0"; A_Initial_Setting(0,aa);
or
A_Initial_Setting(1,"initfile.txt");
REMARK The A_Initial_Setting function is prescored to send some commands
defined by user. The function will send a string with some commands
or a file. The command should be placed after the A_Create_Prn() function.
*******************************************************************************
A_Load_Graphic()
===============================================================================
PURPOSE Acquire the graphic data which stored in the RAM or Flash memory.
SYNTAX int A_Load_Graphic(int x, int y, char graphic_name[10]);
PARAMETER int x; X coordinate.
int y; Y coordinate.
char graphic_name[10]; Graph name with a maximum of 9 characters.
RETURN 0 -> OK.
Reference AW-Error.txt file.
EXAMPLE A_Load_Graphic(265,35,"AB");
REMARK The A_Load_Graphic() function will print a graphic data which has
been downloaded into the printer.
*******************************************************************************
A_Open_ChineseFont()
===============================================================================
PURPOSE Open Chinese dot font file (16*15 and 24*24).
SYNTAX int A_Open_ChineseFont(char* path);
PARAMETER char* path; The Chinese dot font file source path.
RETURN 0 -> OK.
Reference AW-Error.txt file.
EXAMPLE A_Open_ChineseFont("C:\\ET3");
REMARK The A_Open_ChineseFont function will open Chinese dot font file.
And give Prn_Text_Chinese function to used.
*******************************************************************************
A_Print_Form()
===============================================================================
PURPOSE Perform printing function. And acquire the form data which stored
in RAM or Flash memory.
SYNTAX int A_Print_Form(int width, int height, int copies, int amount,
LPTSTR form_name);
PARAMETER int width; Width - 1 or 2.
int height; Height - 1, 2 or 3.
int copies; Specifies the label quantity. Value:1 ~ 9999.
int amount; Specifies the number of labels which will be
generated before incrementing / decrementing
the fields. Value:1 ~ 99.
LPTSTR form_name; Input form's name. Use "," to differentiate
string form.
RETURN 0 -> OK.
Reference AW-Error.txt file.
EXAMPLE A_Print_Form(1,1,1,1,"demo");
REMARK The A_Print_Form function access data of all commands in the form.
First used A_set_form() to store a form in printer. The command
have to be placed after all commands. Befor A_ClosePrn(). The width
and height parameter is setting width and height pixel size.
You can set the pixel size except the smallest one by this function.
Reducing the resolution will causes the image pixel to be amplified
and generate zigzag output phenomenon. The amount parameter can be
used to increment or decrement field values more than one label
which can be set only once during label formatting mode.
*******************************************************************************
A_Print_Out()
===============================================================================
PURPOSE Perform printing function.
SYNTAX int A_Print_Out(int width, int height, int copies, int amount);
PARAMETER int width; Width - 1 or 2.
int height; Height - 1, 2 or 3.
int copies; Specifes the label quantity. Value:1 ~ 9999.
int amount; Specifies the number of labels to be
generated before incrementing/decrementing
the fields. Value:1 ~ 99.
RETURN 0 -> OK.
Reference AW-Error.txt file.
EXAMPLE A_Print_Out(1,1,3,1);
REMARK The A_Print_Out function access data of all commands. This command has
to be placed after all function and before A_ClosePrn().The width and
height parameter is setting width and height pixel size. You can set
the pixel size except the smallest one by this function. Reducing
the resolution will causes the image pixel to be amplified and
generate the zigzag output. The amount parameter can be used to
incrementing or decrementing field values more than one label which
can be set only once during label formatting mode.
*******************************************************************************
A_Prn_Barcode()
===============================================================================
PURPOSE Create a "barcode" object.
SYNTAX int A_Prn_Barcode(int x, int y, int ori, char type, int narrow,
int width, int height, char mode, int numeric, LPTSTR data);
PARAMETER int x; X coordinate.
int y; Y coordinate.
int ori; Orientation or print direction.
Value: 1,2,3,4
char type; Bar code type as follows:
+==========================================================================+
|Bar code |Length |Check|Type for|Type for |Valid |Bar ratio|
| | |sum |readable|nonreadable|codes | |
| | | |string |string | | |
+============+==========+=====+========+===========+=============+=========+
|Code 3 of 9 |variable |no |'A' |'a' |0~9,A~Z,$%*+-|2:1~ |
| | | | | |./and space |3:1 |
+------------+----------+-----+--------+-----------+-------------+---------+
|UPC-A |12 digis |yes |'B' |'b' |0~9 |2:3:4 |
| |(11+1) | | | | | |
+------------+----------+-----+--------+-----------+-------------+---------+
|UPC-E |7 digits |yes |'C' |'c' |0~9 |2:3:4 |
| |(6+1) | | | | | |
+------------+----------+-----+--------+-----------+-------------+---------+
|Interleaved |variable |no |'D' |'d' |0~9 |2:1~ |
|2 of 5 (I25)| | | | | |3:1 |
+------------+----------+-----+--------+-----------+-------------+---------+
|Code 128 |variable |yes |'E' |'e' |form code 0 |2:3:4 |
| | | | | |to 127 | |
+------------+----------+-----+--------+-----------+-------------+---------+
|EAN-13 |13 digits |yes |'F' |'f' |0~9 |2:3:4 |
| |(12+1) | | | | | |
+------------+----------+-----+--------+-----------+-------------+---------+
|ENA-8 |8 digits |yes |'G' |'g' |0~9 |2:3:4 |
| |(7+1) | | | | | |
+------------+----------+-----+--------+-----------+-------------+---------+
|HBIC |variable |yes |'H' |'h' |0~9,A~Z,$%*+-|2:1~ |
| | | | | |./and space |3:1 |
+------------+----------+-----+--------+-----------+-------------+---------+
|Coda bar |at least 3|no |'I' |'i' |0~9,A~Z,$+-. |2:1~ |
| |characters| | | |And / |3:1 |
+------------+----------+-----+--------+-----------+-------------+---------+
|Interleaved |variable |yes |'J' |'j' |0~9 |2:1~ |
|2 of 5 with +----------+ | | | |3:1 |
|a modulo 10 checksum | | | | | |
+-----------------------+-----+--------+-----------+-------------+---------+
|Plessey |1~14 |yes |'K' |'k' |0~9 |2:1~ |
| |digits | | | | |3:1 |
+------------+----------+-----+--------+-----------+-------------+---------+
|Interleaved |variable |yes |'L' |'l' |0~9 |2:1~ |
|2 of 5 with +----------+-----+--------+-----------+ |3:1 |
|a modulo 10 checksum and shipping bearer bars | | |
+------------+----------+-----+--------+-----------+-------------+---------+
|UPC2 |2 digits |no |'M' |'m' |0~9 |2:3:4 |
+------------+----------+-----+--------+-----------+-------------+---------+
|UPC5 |5 digits |no |'N' |'n' |0~9 |2:3:4 |
+------------+----------+-----+--------+-----------+-------------+---------+
|Code 93 |variable |no |'O' |'o' |0~9,A~Z,$%*+-|2:3:4 |
| | | | | |./and space | |
+------------+----------+-----+--------+-----------+-------------+---------+
|Postnet |variable |yes |not |'p' |0~9 | |
| | | |defined | | | |
+------------+----------+-----+--------+-----------+-------------+---------+
|UCC/EAN Code|20 digits |yes |'Q' |'q' |0~9 |2:3:4 |
|128 |(19+1) | | | | | |
+------------+----------+-----+--------+-----------+-------------+---------+
|UCC/EAN Code|18 digits |yes |'R' |'r' |0~9 |2:3:4 |
|128 k-MART | | | | | | |
+------------+----------+-----+--------+-----------+-------------+---------+
|Matrix 2 5 |variable |no |'S' |'s' |0~9 |2:1~ |
| | | | | | |3:1 |
+------------+----------+-----+--------+-----------+-------------+---------+
|Telepen |variable |yes |'T' |'t' |form code 0 |2:3:4 |
| | | | | |to 127 | |
+------------+----------+-----+--------+-----------+-------------+---------+
|FIM |1 |no |not |'v' |A,B,C and D | |
| |character | |defined | | | |
+------------+----------+-----+--------+-----------+-------------+---------+
Note: See Programmer Manual P.63~76.
int narrow; Define the narrow bar width from 0 ~ 24.
int width; Define the wide bar width from 0 ~ 24.
int height; Bar code height. Value:0 ~ 999.
char mode; Add function as follows:
+----+-------------------------------------+
|mode| REMARK |
+----+-------------------------------------+
| A |Make auto increment for numeric. |
+----+-------------------------------------+
| B |Make auto increment for alphanumeric.|
+----+-------------------------------------+
| C |Make auto decrement for numeric. |
+----+-------------------------------------+
| D |Make auto decrement for alphanumeric.|
+----+-------------------------------------+
| N |Disable. |
+----+-------------------------------------+
int numeric; Automaticall increment or decrement the filed
value. Value:0 ~ 99.
LPTSTR data; Data string.
RETURN 0 -> OK.
Reference AW-Error.txt file.
EXAMPLE A_Prn_Barcode(150,20,4,'A',0,0,20,'b',1,"ABCD");
*******************************************************************************
A_Prn_Text()
===============================================================================
PURPOSE Create a "text" object.
SYNTAX int A_Prn_Text(int x, int y, int ori, int font, int type, int hor_factor,
int ver_factor, char mode, int numeric, LPCTSTR data);
PARAMETER int x; X coordinate.
int y; Y coordinate.
int ori; Orientation or print direction.
Value: 1,2,3,4
int font; Font type as follows:
Note:Refer to the font tables in User's
Manual.
int type; As follows:
+--------------+-----+---------------------------+
|font |type |Font Type |
+--------------+-----+---------------------------+
|0,1,2,3,4,5,6,|0 |font 0~font 8 respectively.|
|7,8 | | |
+--------------+-----+---------------------------+
|9 |0~7 |ASD smooth fonts. |
| | |0:4points, 1:6points, |
| | |2:8points, 3:10points, |
| | |4:12points, 5:14points, |
| | |6:18points. |
+--------------+-----+---------------------------+
|11 |0~7 |Courier fonts,(0 represents|
| | |symbol set) |
| | |0:Roman-8, 1:ECMA-94, |
| | |2:PC set, 3:PC set A, |
| | |4:PC set B, 5:Legal, |
| | |6:Greek, 7:Russian. |
+--------------+-----+---------------------------+
|12 |0 |Font selection form font |
| | |board. |
+--------------+-----+---------------------------+
int hor_factor; Horizontal scale factor. Value:1 ~ 24
int ver_factor; Vertical scale factor. Value:1 ~ 24
char mode; Add function as follows:
+----+-------------------------------------+
|mode| REMARK |
+----+-------------------------------------+
| A |Make auto increment for numeric. |
+----+-------------------------------------+
| B |Make auto increment for alphanumeric.|
+----+-------------------------------------+
| C |Make auto decrement for numeric. |
+----+-------------------------------------+
| D |Make auto decrement for alphanumeric.|
+----+-------------------------------------+
| M |Toggle the mirror mode. |
+----+-------------------------------------+
| N |Disable. |
+----+-------------------------------------+
int numeric; Automaticall increment or decrement the
filed value. Value:0 ~ 99.
LPCTSTR data; Data string.
RETURN 0 -> OK.
Reference AW-Error.txt file.
EXAMPLE A_Prn_Text(310,35,1,9,0,1,1,'n',2,"PPLA COMMAND");
*******************************************************************************
A_Prn_Text_Chinese()
===============================================================================
PURPOSE Create a "text" object with Chinese dot font file (16*15 or 24*24).
SYNTAX int A_Prn_Text_Chinese(int x,int y,int fonttype,LPCTSTR id_name,
LPCTSTR data,int mem_mode);
PARAMETER int x; X coordinates.
int y; Y coordinates.
int fonttype; Select Chinese dot font file.
0 -> 16*15<31>B1 -> 24*24.
LPCTSTR id_name; To give a id name to store in printer after
calling text by Load_Pcx().
LPCTSTR data; A text string.
int mem_mode; Memory mode, 1 => RAM
2 => Flash Memory
RETURN 0 -> OK.
Reference AW-Error.txt file.
EXAMPLE A_Open_ChineseFont("C:\\ET3");
A_Prn_Text_Chinese(100, 100, 0,"A01","<22><><EFBFBD>a<EFBFBD>Q<EFBFBD>q<EFBFBD><71><EFBFBD>e<EFBFBD>Ϣ<EFBFBD><CFA2>Ѣ<EFBFBD><D1A2>Ң<EFBFBD>", 1);
REMARK The A_Prn_Text_Chinese function is able to print a text for Chinese
dot font file (16*15 or 24*24).
But you must install Window's Driver for Dr.200 or Dr.300
first. And adjust the darkness. This function will first search the
Windows driver (Dr.200 or Dr.300) from PCs existing default driver.
If the default driver is for other printer, it will sreach Dr.200
and then Dr.300.
*******************************************************************************
A_Prn_Text_TrueType()
A_Prn_Text_TrueType_W()
===============================================================================
PURPOSE Create a "True Type Font" text object.
SYNTAX int A_Prn_Text_TrueType(int x, int y, int FSize, LPCTSTR FType,
int Fspin, int FWeight, int FItalic, int FUnline,
int FStrikeOut, LPCTSTR id_name, LPCTSTR data,
int mem_mode);
int A_Prn_Text_TrueType_W(int x, int y, int FHeight, int FWidth,
LPCTSTR FType, int Fspin, int FWeight, int FItalic,
int FUnline, int FStrikeOut, LPCTSTR id_name,
LPCTSTR data, int mem_mode);
PARAMETER int x; X coordinates.
int y; Y coordinates.
int FSize; TrueType font size,unit is (dot).
FSize = (dpi * point) / 72.
int FHeight; Font Height, unit is (dot).
FHeight = (dpi * point) / 72.
int FWidth; Font Width, unit is (dot).
FWidth = (dpi * point) / 72.
LPCTSTR FType; TrueType font type name.
int Fspin; TrueType font to rotate.
1 -> 0, 2 -> 90, 3 -> 180, 4 -> 270
int FWeight; TrueType font thickness bellow:
0 and NULL and 400 -> standard,
100 -> special thin,200 -> very thin,
300 -> thin ,500 -> middle,
600 -> half thick ,700 -> thick,
800 -> special thick,900 ->blackbody.
int FItalic; TrueType font italic.
0 -> FALSE, 1 -> TRUE.
int FUnline; TrueType font underline.
0 -> FALSE, 1 -> TRUE.
int FStrikeOut; TrueType font StrikeOut.
0 -> FALSE, 1 -> TRUE.
LPCTSTR id_name; To give a id name to store in printer after
calling text by Load_Pcx().
LPCTSTR data; A text string.
int mem_mode; Memory mode, 1 => RAM
2 => Flash Memory
RETURN 0 -> OK.
Reference AW-Error.txt file.
EXAMPLE A_Prn_Text_TrueType(30,35,40,"Times New Roman",4,400,0,0,0,"AA","ABCDEF",1);
A_Prn_Text_TrueType_W(30,35,40,50,"Times New Roman",4,400,0,0,0,"AA","ABCDEF",1);
REMARK The A_Prn_Text_TrueType function is able to print a text for True
Type Font, But you must install Window's Driver for Dr.200 or Dr.300
first. And adjust the darkness. This function will first search the
Windows driver (Dr.200 or Dr.300) from PCs existing default driver.
If the default driver is for other printer, it will sreach Dr.200
and then Dr.300.
*******************************************************************************
A_Set_Backfeed()
===============================================================================
PURPOSE Setup the "back feed" function.
SYNTAX int A_Set_Backfeed(int back);
PARAMETER int back; Stop position. Value:220 ~ 999
Note: 1 = 0.01 inches.
RETURN 0 -> OK.
Reference AW-Error.txt file.
EXAMPLE A_Set_Backfeed(320); // Feed back for one inch.
REMARK The A_Set_Backfeed() function enables the label to be fed a little
bit ahead after printing which user could tear it off easily.
And the label roll will be withdraw to proper position before
the next label printed.
Back-feed will not be activated if the value less than 220.
Under multi-copy or countinuous printing, this command is vaild
only for the first label.
*******************************************************************************
A_Set_BMPSave()
===============================================================================
PURPOSE Save Image File.
SYNTAX int A_Set_BMPSave(int nSave, char *pstrBMPFName);
PARAMETER int nSave; 1 -> Save Image.
0 -> Don't Save Image.
char *pstrBMPFName; File Name.
RETURN 0 -> OK.
Reference AW-Error.txt file.
EXAMPLE A_Set_BMPSave(1, "C:\TempBMP.bmp");
REMARK The A_Set_BMPSave function can decide to save image to file.
*******************************************************************************
A_Set_Cutting()
===============================================================================
PURPOSE Setup the "cutting" function.
SYNTAX int A_Set_Cutting(int cutting);
PARAMETER int cutting; Specified count number of label to be cut.
Value: 0 ~ 9999.
RETURN 0 -> OK.
Reference AW-Error.txt file.
EXAMPLE A_Set_Cutting(12);
REMARK The A_Set_Cutting function is available only when the cutter is
installed. Set "cutting" after the specified count number of labels.
*******************************************************************************
A_Set_Darkness();
===============================================================================
PURPOSE Setup the "darkness" function (heating level).
SYNTAX int A_Set_Darkness(int heat);
PARAMETER int heat; Set heat value.(0 ~ 20)
Default value 10.
RETURN 0 -> OK.
Reference AW-Error.txt file.
EXAMPLE A_Set_Darkness(12);
REMARK Heat value will define the image's darkness. To get a printout with
better quality, you should consider following factors i.e. media
material, ribbon types(wax,semi-resin and resin) and image pattern
itself.
*******************************************************************************
A_Set_DebugDialog()
===============================================================================
PURPOSE Enable Debug Message Dialog.
SYNTAX int A_Set_DebugDialog(int nEnable);
PARAMETER int nEnable; 1 -> Enable.
0 -> Disable.
RETURN 0 -> OK.
Reference AW-Error.txt file.
EXAMPLE A_Set_DebugDialog(1);
REMARK The A_Set_DebugDialog function set debug message dialog.
*******************************************************************************
A_Set_Feed()
===============================================================================
PURPOSE Feed out one label from printer.
SYNTAX int A_Set_Feed(char rate);
PARAMETER char rate; Set feed speed as follows:(A~K)
+---+-------+---+-------+---+-------+---+-------+---+-------+---+-------+
| A |1.0 ips| B |1.5 ips| C |2.0 ips| D |2.5 ips| E |3.0 ips| F |3.5 ips|
+---+-------+---+-------+---+-------+---+-------+---+-------+---+-------+
| G |4.0 ips| H |4.5 ips| I |5.0 ips| J |5.5 ips| K |6.0 ips| | |
+---+-------+---+-------+---+-------+---+-------+---+-------+---+-------+
+----------+-----------+
| Printer |Speed Range|
+----------+-----------+
|OS-214/204| A~E |
+----------+-----------+
| OS-314 | A~C |
+----------+-----------+
| X-1000 | A~G |
+----------+-----------+
| X-2000 | A~I |
+----------+-----------+
| X-3000 | A~K |
+----------+-----------+
RETURN 0 -> OK.
Reference AW-Error.txt file.
EXAMPLE A_Set_Feed('E');
REMARK The A_Set_Feed function will define the feed speed.
Every time you press the button or send Feed_Label function,
the motor speed will follow the parameter.
*******************************************************************************
A_Set_Form()
===============================================================================
PURPOSE Download a form from PC into printers RAM or Flash memory.
SYNTAX int A_Set_Form(LPCTSTR formfile, LPCTSTR form_name, int mem_mode);
PARAMETER LPCTSTR formfile; File name for form. The form must use
DOS's drive make a form in PPLA utility
of Driver Disk.
LPCTSTR form_name; The form name is stored in printer.
int mem_mode; Memory mode, 1 => RAM
2 => Flash Memory
RETURN 0 -> OK.
Reference AW-Error.txt file.
EXAMPLE A_Set_Form("demo.prn","demo",1);
REMARK The A_Set_Form function activates a form store sequence to be printed.
The function is used befor Print_Form().
*******************************************************************************
A_Set_Margin()
===============================================================================
PURPOSE Setup the top and left margin.
SYNTAX int A_Set_Margin(int position,int margin);
PARAMETER int position; Set start print position.Value 0 ~ 9999.
Format: 220 + position.(100 = one inch)
int margin; Set left margin.Value 0 ~ 9999.
(100 = one inch)
RETURN 0 -> OK.
Reference AW-Error.txt file.
EXAMPLE A_Set_Margin(100,100);
REMARK The A_Set_Margin function used to set the offset value for initial
printing position and sets the left margin or column offset.
The default 220 makes the leading end of label under the TPH(print
head)line. You may change it to meet the specific paper and margin
settings. Different margin value will makes image to shift left or
right.
*******************************************************************************
A_Set_Prncomport()
===============================================================================
PURPOSE Setup the serial port for printer.
SYNTAX int A_Set_Prncomport(int baud,int parity,int data,int stop);
PARAMETER int baud; Baud, List:
0 -> 9600, 1 -> 2400
2 -> 2400, 3 -> 19200
4 -> 4800, 5 -> 38400
6 -> 2400, 7 -> 9600
int parity; Parity, List:
0 -> none parity
1 -> even parity
2 -> odd parity
int data; Data bit number:
7 -> 7-bit data
8 -> 8-bit data
int stop; Stop bit number:
1 -> 1 stop bit
2 -> 2 stop bits
RETURN 0 -> OK.
Reference AW-Error.txt file.
EXAMPLE A_Set_Prncomport(0, 0, 8, 1);
<20>@REMARK The fuction of A_Set_Prncomport is to setup the value of printer
serial Port. For successful communication between PC and Printer,
this value should be commanded in accrodance with the setting
value of PC. Besides, this command should be set before
A_Print_Out() executed.
*******************************************************************************
A_Set_Prncomport_PC()
===============================================================================
PURPOSE Setup the serial port for PC.
SYNTAX int A_Set_Prncomport_PC(int nBaudRate, int nByteSize, int nParity,
int nStopBits, int nDsr, int nCts, int nXonXoff);
PARAMETER int nBaudRate; Baud rate:
1 -> 110 9 -> 19200
2 -> 300 10 -> 38400
3 -> 600 11 -> 56000
4 -> 1200 12 -> 57600
5 -> 2400 13 -> 115200
6 -> 4800 14 -> 128000
7 -> 9600 15 -> 256000
8 -> 14400 0 -> 9600
int nByteSize; Data bit number:
0 -> 7-bit data
7 -> 7-bit data
8 -> 8-bit data
int nParity; Parity:
0 -> none parity
1 -> even parity
2 -> odd parity
int nStopBits; Stop bit number:
0 -> 1 stop bit
1 -> 1 stop bit
2 -> 2 stop bits
int nDsr; Setup hardware flow control
1 -> DTR CONTROL HANDSHAKE;
0 -> DTR CONTROL ENABLE;
int nCts; Setup hardware flow control
1 -> RTS CONTROL HANDSHAKE;
0 -> RTS CONTROL ENABLE;
int nXonXoff; Setup software flow control
0 -> Enable;
1 -> Disable;
RETURN 0 -> OK.
Reference AW-Error.txt file.
EXAMPLE A_Set_Prncomport_PC(0, 0, 0, 0, 1, 1, 1);
<20>@REMARK The fuction of A_Set_Prncomport_PC is to setup the value of PC
serial Port. For successful communication between PC and Printer,
this value should be commanded in accrodance with the setting
value of printer. Besides, this command should be set before
A_Print_Out() executed.
*******************************************************************************
A_Set_Sensor_Mode()
===============================================================================
PURPOSE Setup the "sensoring" mode (gap, black mark, continuous).
SYNTAX int A_Set_Sensor_Mode(char type,int continuous);
PARAMETER char type;
int continuous;
+----+-----------+---------------------------------+
|TYPE|continuous |REMARK |
+----+-----------+---------------------------------+
| e | 0 |Select edge sensor (Default) |
+----+-----------+---------------------------------+
| r | 0 |Select reflective sensor for gap |
+----+-----------+---------------------------------+
| c |0~9999 inch|Set continuous paper type |
+----+-----------+---------------------------------+
(100 = one inch)
RETURN 0 -> OK.
Reference AW-Error.txt file.
EXAMPLE A_Set_Sensor_Mode('c',300);
REMARK Use "e" (see-through sensoring) for gap media .
Use "r" (reflective sensoring) for black mark media.
Use "c" for continuous media.
*******************************************************************************
A_Set_Speed()
===============================================================================
PURPOSE Setup the "print speed".
SYNTAX int A_Set_Speed(char speed);
PARAMETER char speed; Set print speed as follows:(A~K)
+---+-------+---+-------+---+-------+---+-------+---+-------+---+-------+
| A |1.0 ips| B |1.5 ips| C |2.0 ips| D |2.5 ips| E |3.0 ips| F |3.5 ips|
+---+-------+---+-------+---+-------+---+-------+---+-------+---+-------+
| G |4.0 ips| H |4.5 ips| I |5.0 ips| J |5.5 ips| K |6.0 ips| L |7.0 ips|
+---+-------+---+-------+---+-------+---+-------+---+-------+---+-------+
+----------+-----------+
| Printer |Speed Range|
+----------+-----------+
|OS-214/204| A~E |
+----------+-----------+
| OS-314 | A~C |
+----------+-----------+
| X-1000 | A~G |
+----------+-----------+
| X-2000 | A~I |
+----------+-----------+
| X-3000 | A~L |
+----------+-----------+
RETURN 0 -> OK.
Reference AW-Error.txt file.
EXAMPLE A_Set_Speed('E');
*******************************************************************************
A_Set_Syssetting()
===============================================================================
PURPOSE Other function setup e.g. printing type, cutter and dispenser
configuration, label length, slash zero mark, pause function ....
SYNTAX int A_Set_Syssetting(int transfer,int cut_peel,int length,
int zero,int pause);
PARAMETER int transfer; Set transfer type as follows:
+----------+------------------+
| transfer | REMARK |
+----------+------------------+
| 0 | Disabel |
+----------+------------------+
| 1 | Direct thermal |
+----------+------------------+
| 2 | Thermal transfer |
+----------+------------------+
int cut_peel; Set cutter and dispenser configuration
as follows:
+----------+-----------------------------+
| cut_peel | REMARK |
+----------+-----------------------------+
| 9 | Disable |
+----------+-----------------------------+
| 0 | No cutter and peel function |
+----------+-----------------------------+
| 1 | Cutter engaged |
+----------+-----------------------------+
| 4 | Peel engaged |
+----------+-----------------------------+
int length; Set maximum label length.(1~1200)
You set '0' is disable.(100 = one inch)
int zero; Change slash zero to normal zero.
'0' is disable.
'1' makes you use the normal zero.
int pause; Set pause for each printed label as
follows: +-------+-------------+
| pause | REMARK |
+-------+-------------+
| 0 | Disabel |
+-------+-------------+
| 1 | Set pause |
+-------+-------------+
| 2 | Cancel pause|
+-------+-------------+
RETURN 0 -> OK.
Reference AW-Error.txt file.
EXAMPLE A_Set_Syssetting(2,4,1200,1,2);
REMARK The A_Set_Syssetting function is importance for the configuration.
*******************************************************************************
A_Set_Unit()
===============================================================================
PURPOSE Setup measurement unit (metric or inches).
SYNTAX int A_Set_Unit(char unit);
PARAMETER char unit; The value of unit as follows:
+------+---------------------------+
| unit | REMARK |
+------+---------------------------+
| m | Set measurement in metric |
+------+---------------------------+
| n | Set measurement in inches |
+------+---------------------------+
RETURN 0 -> OK.
Reference AW-Error.txt file.
EXAMPLE A_Set_Unit('n');
REMARK The A_Set_Unit function is used to set measurement in metric or
inches.
*******************************************************************************
A_Set_Gap()
===============================================================================
PURPOSE Setup the distance of gap.
SYNTAX int A_Set_Gap(int gap);
PARAMETER int gap; Range: 0 ~ 36 mm.
RETURN 0 -> OK.
Reference AW-Error.txt file.
EXAMPLE A_Set_Gap(0);
REMARK The A_Set_Gap function is used to set the distance of gap.
*******************************************************************************
A_Set_Logic()
===============================================================================
PURPOSE Set logic image printing mode.
SYNTAX int A_Set_Logic(int Logic);
PARAMETER int Logic; 0:Printer default.
1:Logical XOR.
2:Logical OR.
RETURN 0 -> OK.
Reference AW-Error.txt file.
EXAMPLE A_Set_Logic(1);
REMARK The A_Set_Logic function is used to set logic image printing mode.
*******************************************************************************
A_Set_ProcessDlg()
===============================================================================
PURPOSE Set the Process bar.
SYNTAX int A_Set_ProcessDlg(int nShow);
PARAMETER int nShow; 0:Close Process bar.
1:Open Process bar.
RETURN 0 -> OK.
Reference AW-Error.txt file.
EXAMPLE A_Set_ProcessDlg(1);
REMARK The A_Set_ProcessDlg function is used to open or close the Process
bar Dialog.
*******************************************************************************
A_Set_LabelVer()
===============================================================================
PURPOSE Set the Vertical Center. (For R400)
SYNTAX int A_Set_LabelVer(int centiInch);
PARAMETER int centiInch; Label Width;
unit : 0.01 Inch.
RETURN 0 -> OK.
Reference AW-Error.txt file.
EXAMPLE A_Set_LableVer(400);
REMARK The A_Set_LabelVer function is used to set the Vertical Center
for R400.
*******************************************************************************
Reference in New Issue Copy Permalink