BIXOLON BXLLIBX.CAB, BXLLIB.DLL Api Manual

Page 1
API Manual
Label Printers
Rev. 2.0.0.1
http://www.bixolon.com
Page 2
BXLLIB.DLL / BXLIBX.CAB
Copyright © BIXOLON Co., Ltd.
1. C
onnectPrinter
The ConnectPrinter function connect to instance of printer which is installed in
system.
BOOL ConnectPrinter
(
LPCSTR szPrinterName
);
Parameters
szPrinterName
[in] Name of printer instance to connect
Return Values
If the function succeeds, the return value is 1 or TRUE. If the function fails, the return value is zero or FALSE.
2. DisconnectPrinter
The DisconnectPrinter function disconnect to instance of printer which is connected.
BOOL DisconnectPrinter();
Return Values
If the function succeeds, the return value is 1 or TRUE.
If the function fails, the return value is zero or FALSE.
3. StartLabel
The StartLabel function start to make label in printer.
BOOL StartLabel();
Return Values
If the function succeeds, the return value is 1 or TRUE. If the function fails, the return value is zero or FALSE.
Remarks
Must be called this function after call ConnectPrinterfunction.
Page 3
BXLLIB.DLL / BXLIBX.CAB
Copyright © BIXOLON Co., Ltd.
4. EndLabel
The EndLabel function stop to make label in printer.
void EndLabel();
Remarks
Must be called this function before call DisconnectPrinterfunction.
5. SetConfigOfPrinter
The SetConfigOfPrinter function set up properties of printer.
BOOL SetConfigOfPrinter(
int nSpeed, int nDensity, int nOrient
ation,
bool bAutoCut, int nCuttingPeriod
,
bool bBack
Fee
ding,
);
Parameters
nSpeed
[in] Printing
Speed
0: 2.5
ips
1: 3.0
ips
2: 4.0 ips 3: 5.0 ips 4: 6.0 ips 5: 7.0 ips
nDensity
[in] Printing Density (0 ~ 20)
nOrientation
[in] Printing Direction
0: Print from top to bottom 1: Print from bottom to top
bAutoCut
[in] Cut paper
0 or FALSE: Disable Cutter 1 or TRUE: Enable Cutter
nCuttingPeriod
[in] Cutting
period
bBackFeeding
[in] Backfeed paper when printing start first
0 or FALSE: Disable backfeeding 1 or TRUE: Enable backfeeding
Return Value
s
If the function succeeds, the return value is 1 or TRUE. If the function fails, the return value is zero or FALSE.
Page 4
BXLLIB.DLL / BXLIBX.CAB
Copyright © BIXOLON Co., Ltd.
6. SetPaper
The SetPaper function set up paper of printer.
BOOL SetPaper(
int nHorizontalMargin, int nVerticalMargin, int nPaperWidth
,
int nPaperLength
, int nMediaType, int nOffSe
t
int
nGapLengthORThicknessOfBlackLine
);
Parameters
nHorizontalMargin
[in] Horizontal margin
nVerticalMargin
[in] Vertical margin
nPaperWidth
[in] Paper width
nPaperHeight
[in] Paper height
nMediaType
[in] Media type
0:
Gap 1: Continues 2: Blackmark
nOffset
[in] Offset of gap or blackmark
nGapLengthORThicknessOfBlackLine
[in] Gap length or thickness of black line [dots]
Return Values
If the function succeeds, the return value is 1 or TRUE. If the function fails, the return value is zero or FALSE.
7. ClearBuffer
The ClearBuffer function clean up memory of printer.
BOOL ClearBuffer();
Return Values
If the function succeeds, the return value is 1 or TRUE. If the function fails, the return value is zero or FALSE.
Page 5
BXLLIB.DLL / BXLIBX.CAB
Copyright © BIXOLON Co., Ltd.
8. PrintDirect
The PrintDirect function send data to port directly.
BOOL PrintDirect(
LPCSTR pDirectDat
a,
);
Parameters
pDirectData
[in] Data to send
Return Values
If the function succeeds, the return value is 1 or TRUE. If the function fails, the return value is zero or FALSE.
9. Prints
The Prints function start to
print.
BOOL Prints(
int nLabelSet, int nCopiesOfEachlabel
);
Parameters
nLabelSet
[in] Number of label sets (1 ~ 65535)
nCopiesOfEachLabel
[in] Number of copies of each label.
Return Values
If the function succeeds, the return value is 1 or TRUE. If the function fails, the return value is zero or FALSE.
Page 6
BXLLIB.DLL / BXLIBX.CAB
Copyright © BIXOLON Co., Ltd.
10. PrintDeviceFont
The PrintDeviceFont function print the device font of printer.
BOOL PrintDeviceFont(
int nHorizontalPos
,
int nVerticalPos, int nFontName, int nHorizontalMulti
,
int nVerticalMulti
,
int nRotation
, bool bBold, LPCSTR szText
);
Parameters
nHorizontalPos
[in] Horizontal position
nVerticalPos
[in] Vertical position
nFontName
[in] Font Name
[0 ~ 9: EnglishFont] 0: Size 6 (9 x 15) 1: Size 8 (12 x 20) 2: Size 10 (16 x 25) 3: Size 12 (19 x 30) 4: Size 15 (24 x 38) 5: Size 20 (32 x 50) 6: Size 30 (48 x 76) 7: Size 14 (22 x 34) 8: Size 18 (28 x 44) 9: Size 24 (37 x 587) [a ~ f] Korean Font or Chinese Font a: Size 1 (16 x 16) b: Size 2 (24 x 24) c: Size 3 (20 x 20) d: Size 4 (26 x 26) e: Size 5 (38 x 38) m: GB2312 (24 x 24) n: BIG5 (24 x 24)
nHorizontalMulti
[in] Font width multiplier (1 ~ 4)
nVerticalMulti
[in] Font height
multiplier
nRotation
[in] Rotation type
0: No rotation 1: 90 degrees (Clockwise) 2: 180 degrees (Clockwise) 3: 270 degrees (Clockwise)
bBold
[in] Bold font
0 or FALSE: Normal 1 or TRUE: Bold
szText
[in] Text to print
Return Values
If the function succeeds, the return value is 1 or TRUE. If the function fails, the return value is zero or FALSE.
Page 7
BXLLIB.DLL / BXLIBX.CAB
Copyright © BIXOLON Co., Ltd.
11. PrintTrueFontLib
The PrintTrueFontLib function send data to port directly.
BOOL
PrintTrueFontLib( int nHorizontalPos, int nVerticalPos, LPCSTR strFontName, int nFontSize, int nRotaion, BOOL bItalic, BOOL bBold, BOOL bUnderline, LPCSTR strText
)
Parameters
nHorizontalPos
[in] Horizontal position
nVerticalPos
[in] Vertical position
strFontName
[in] Pointer to a null-terminated string that specifies the name of true font
nFontSize
[in] Number of the size of true font.
nRotation
[in] Roation type
0: No rotation 1: 90 degrees (Clockwise) 2: 180 degrees (Clockwise) 3: 270 degrees (Clockwise)
bItalic
[in] Italic font 0 or FALSE: Normal 1 or TRUE: Italic
bBold
[in] Bold font
0 or FALSE: Normal 1 or TRUE: Bold
bUnderline
[in] Underline font
0 or FALSE: Normal 1 or TRUE: Bold
szText
[in] Text to print
Return Values
If the function succeeds, the return value is 1 or TRUE. If the function fails, the return value is zero or FALSE.
Page 8
BXLLIB.DLL / BXLIBX.CAB
Copyright © BIXOLON Co., Ltd.
12. Print1DBarcode
The Print1DBarcode function print the 1D Barcode.
BOOL Print1DBarcode(
Int nHorizontalPos, int nVerticalPos, int nBarcodeType, int nNarrowBarWidth, int nWideBarWidth, int nBarcodeHeight, int nRotation, bool bHRI, LPCSTR pData
);
Parameters
nHorizontalPos
[in] Horizontal position
nVerticalPos
[in] Vertical position
nBarcodeType
[in] Barcode symbol type
nNarrowBarWidth
[in] Narrow bar width
nWideBarWidth
[in] Wide bar width
nBarcodeHeight
[in] Height of Barcode
nRotation
[in] Roation type
0: No rotation 1: 90 degrees (Clockwise) 2: 180 degrees (Clockwise) 3: 270 degrees (Clockwise)
bHRI
[in] Human Readable Interpretation
0: Not printed 1: Below the bar code (FontSize : 1) 2: Above the bar code (FontSize : 1) 3: Below the bar code (FontSize : 2) 4: Above the bar code (FontSize : 2) 5: Below the bar code (FontSize : 3) 6: Above the bar code (FontSize : 3) 7: Below the bar code (FontSize : 4) 8: Above the bar code (FontSize : 4)
pData
[in] Barcode data
Return Values
If the function succeeds, the return value is 1 or TRUE. If the function fails, the return value is zero or FALSE.
Page 9
BXLLIB.DLL / BXLIBX.CAB
Copyright © BIXOLON Co., Ltd.
13. PrintQRCode
The PrintQRCode function print the QRCode.
BOOL
PrintQRCode(
Int
nXPos
,
Int
nYPos,
Int
nModel
, Int nECCLevel, Int
nQRCodeSize,
Int nRotation, LPCSTR pData,
);
Parameters
nXPos
[in] Horizontal position (X) [dot]
nYPos
[in] Vertical position (Y) [dot]
nModel
[in] MODEL selection ( 1 or 2 )
nECCLevel
[in] ECC Level L : 7% M : 15% Q : 25% H : 30%
nQRCodeSize
[in] Barcode Size : 1~4
nRotation
[in] Rotation 0 : No Ratation 1 : 90 degrees 2 : 180 degrees 3 : 270 degrees
pData
[in] Barcode data
Return Values
If the function succeeds, the return value is 1 or TRUE. If the function fails, the return value is zero or FALSE.
Page 10
BXLLIB.DLL / BXLIBX.CAB
Copyright © BIXOLON Co., Ltd.
14. PrintBlock
The PrintBlock function draw line block.
BOOL PrintBlock(
int nHorizontalStartPos
, int nVerticalStartPos, int nHorizontalEndPos, int nVerticalEndPos, int nOption, int nThickness
);
Parameters
nHorizontalStartPostion
[in] Horizontal start position of line block
nVerticalStartPosition
[in] Vertical start position of line block
nHorizontalEndPosition
[in] Horizontal end position of line block
nVerticalEndPosition
[in] Vertical end position of line block
nOption
[in] Option of line
block 0: Line Overwriting 1: Line Exclusive OR 2: Line Delete 3: Slope 4: Box
nThickness
[in] Thickness of line block
Return Values
If the function succeeds, the return value is 1 or TRUE. If the function fails, the return value is zero or FALSE.
15. PrintCircle
The PrintCircle function draw circle.
BOOL Prin
tCircle(
int nHorizontalStartPos
, int nVerticalStartPos, int
nDiameter,
int
nMulti,
);
Parameters
nHorizontalStartPostion
[in] Horizontal start position of line block
nVerticalStartPosition
[in] Vertical start position of line block
nDiameter
[in] Circle diameter (1~6)
nMulti
[in] Circle
multiplier (1~4)
Return Values
If the function succeeds, the return value is 1 or TRUE. If the function fails, the return value is zero or FALSE.
Page 11
BXLLIB.DLL / BXLIBX.CAB
Copyright © BIXOLON Co., Ltd.
16. PrintImageLib
The PrintImageLib function print image from image file.
BOOL PrintImageLib(
int nHorizontalStartPos, int nVerticalStartPos, LPCSTR
pImageFilename,
int nDi t her
,
BOOL bWithRLE
);
Parameters
nHorizontalStartPostion
[in] Horizontal start position of line block
nVerticalStartPosition
[in] Vertical start position of line block
pImageFilename
[in] Pointer to a null-terminated string that specifies the name of the image file.
nDither
[in] Dither option ( -1, 0, 1, 6, 7 )
bWithRLE
[in] Data compressed
Return Values
If the function succeeds, the return value is 1 or TRUE. If the function fails, the return value is zero or FALSE.
Loading...