中琅条码标签打印软件的二次开发包,旨在为开发者提供专业的标签设计、排版、批量输出能力(支持输出到打印机、图片、PDF文档、TIFF文档)。通过此 SDK包,你可以轻松地打开标签模板、指定数据文件进行批量自动打印;可以灵活创建标签模板、通过程序逐个进行图形赋值并输出;还可以调 用PDF工具箱,感受强大高效的PDF拼版、拆分、合并等能力。
接口文件:LabelPaInter_SDK.dll(请连同hasp_windows_82155.dll一起放到您的主程序目录下)
支持语言:C、C++、C#、Java、VB、Delphi等。
备注:
1、本SDK仅限中琅条码标签打印软件v6.1及以上版本使用。
2、Java版本接口的所有函数无“ZL_”前缀,且首字母为小写。
3、本接口只允许在win32模式下运行;c++开发请使用“多字节字符集”。
4、接口运行期间日志文件存放路径:{中琅条码标签打印软件程序目录}\program\log.txt。
5、各语言版本请参考Demo文件夹中的样本例程。
函数总览:
附录
过程概览
函数说明
函数:ZL_Initialization
功能:接口初始化
返回值:成功/失败。类型:eRET(详见附录一:返回值 eRET)
备注:在接口程序运行之前只需运行一次。Java接口无此函数。
参数说明:
名称 | 类型 | 释义 | 备注 |
programDir | String | 中琅条码标签打印软件程序目录 | 如:d:\中琅条码标签打印软件\ |
函数:ZL_Release
功能:释放接口占用资源
返回值:成功/失败。类型:eRET(详见附录一:返回值 eRET)
备注:在接口程序运行完毕后只需运行一次。Java接口无此函数。
参数说明:无参数。
函数:ZL_OpenDoc
功能:打开现有标签文档
返回值:成功/失败。类型:eRET(详见附录一:返回值 eRET)
备注:支持旧版标签文档。
参数说明:
名称 | 类型 | 释义 | 备注 |
filePath | String | 标签文档路径 | 后缀名:zhl 或 lp |
password | String | 标签文档打开密码 | 可以为null或空值 |
函数:ZL_CreateDoc
功能:创建新的标签文档
返回值:成功/失败。类型:eRET(详见附录一:返回值 eRET)
备注:此函数调用后,通常需要使用ZL_SetLayout函数进行纸张布局设置。
参数说明:
名称 | 类型 | 释义 | 备注 |
paperWidth | Double | 纸张宽度 | 含标签宽度、水平间隙、纸张水平边距 |
paperHeight | Double | 纸张高度 | 含标签高度、竖直间隙、纸张竖直边距 |
函数:ZL_SaveDoc
功能:保存标签文档
返回值:成功/失败。类型:eRET(详见附录一:返回值 eRET)
备注:如果标签文档无改动,则无需保存。
参数说明:
名称 | 类型 | 释义 | 备注 |
filePath | String | 标签文档保存路径 | 请使用后缀名:zhl |
函数:ZL_CloseDoc
功能:关闭标签文档
返回值:成功/失败。类型:eRET(详见附录一:返回值 eRET)
备注:非必须操作。
参数说明:无参数。
函数:ZL_SetLayout
功能:纸张布局设置
返回值:成功/失败。类型:eRET(详见附录一:返回值 eRET)
备注:创建标签文档后请执行此函数。
参数说明:
名称 | 类型 | 释义 | 备注 |
margIntop | Double | 页面上边距 | 默认值:0.0,单位:mm |
marginRight | Double | 页面右边距 | 默认值:0.0,单位:mm |
marginBottom | Double | 页面下边距 | 默认值:0.0,单位:mm |
marginLeft | Double | 页面左边距 | 默认值:0.0,单位:mm |
numberOfRows | Int | 标签行数 | 默认值:5 |
numberOfColumns | Int | 标签列数 | 默认值:2 |
labelWidth | Double | 标签宽度 | 默认值:0.0,小于等于0为自动计算,单位:mm |
labelHeight | Double | 标签高度 | 默认值:0.0,小于等于0为自动计算,单位:mm |
labelSpanH | Double | 标签水平间隙 | 默认值:0.0,单位:mm |
labelSpanV | Double | 标签垂直间隙 | 默认值:0.0,单位:mm |
feedDirection | Int | 进纸方向 | 默认值:1(详见附录二:进纸方向) |
函数:ZL_SaveLabelImage
功能:将标签保存为位图图片
返回值:成功/失败。类型:eRET(详见附录一:返回值 eRET)
备注:根据提供的文件路径中的后缀名生成对应的图片格式。
参数说明:
名称 | 类型 | 释义 | 备注 |
savePath | String | 位图图片保存路径 | 后缀名支持gif、bmp、png、jpg、tiff |
函数:ZL_InsertLine
功能:插入线段
返回值:图形ID。类型:Int
备注:如果返回值小于0,则为失败。
参数说明:
名称 | 类型 | 释义 | 备注 |
pointXs | Double[] | x坐标数组 | 与pointYs对应,单位:mm |
pointYs | Double[] | y坐标数组 | 与pointXs对应,单位:mm |
pointCount | Int | 坐标点数量 | 坐标数组长度,必须大于等于2。Java接口无需此参数。 |
lineWidth | Double | 线宽 | 单位:mm |
lineStyle | Int | 线条样式 | (详见附录三:线条样式) |
lineColor | Int | 线条颜色 | RGB值 |
lineType | Int | 线条类别 | (详见附录四:线条类型) |
函数:ZL_InsertPolygon
功能:插入多边形
返回值:图形ID。类型:Int
备注:如果返回值小于0,则为失败。
参数说明:
名称 | 类型 | 释义 | 备注 |
pointXs | Double[] | x坐标数组 | 应与pointYs对应,单位:mm |
pointYs | Double[] | y坐标数组 | 应与pointXs对应,单位:mm |
pointCount | Int | 坐标点数量 | 坐标数组长度,必须大于等于3。Java接口无需此参数。 |
lineWidth | Double | 线宽 | 单位:mm |
lineStyle | Int | 线条样式 | (详见附录三:线条样式) |
lineColor | Int | 线条颜色 | RGB值 |
fillColor | Int | 填充颜色 | RGB值 |
angle | Double | 角度 | 图形旋转角度,单位:度 |
函数:ZL_InsertText
功能:插入文本
返回值:图形ID。类型:Int
备注:如果返回值小于0,则为失败。
参数说明:
名称 | 类型 | 释义 | 备注 |
x | Double | x坐标 | 单位:mm |
y | Double | y坐标 | 单位:mm |
width | Double | 文本区域宽度 | 单位:mm |
height | Double | 文本区域高度 | 单位:mm |
text | String | 文本内容 |
|
textMode | Int | 文本模式 | (详见附录五:文本模式) |
isMirror | Bool | 镜像开关 | 是否使用水平镜像 |
fontName | String | 字体名称 | 如:“宋体” |
fontSize | Double | 字体大小 | 单位:pt |
fontStyle | Int | 字体样式 | (详见附录六:字体样式) |
fontColor | Int | 字体颜色 | RGB值 |
alignment | Int | 对齐方式 | (详见附录七:对齐方式) |
wordSpacing | Double | 字间距 | 单位:mm |
rowSpacing | Double | 行间距 | 单位:mm |
angle | Double | 角度 | 图形旋转角度,单位:度 |
函数:ZL_InsertBarcode
功能:插入条码/二维码
返回值:图形ID。类型:Int
备注:如果返回值小于0,则为失败。
参数说明:
名称 | 类型 | 释义 | 备注 |
x | Double | x坐标 | 单位:mm |
y | Double | y坐标 | 单位:mm |
width | Double | 文本区域宽度 | 单位:mm |
height | Double | 文本区域高度 | 单位:mm |
data | String | 条码内容 |
|
textFormat | String | 文本格式化 | 占位符为问号,如:??? ??? ??? ???,只对条形码有效 |
barcodeType | Int | 条码类型 | (详见附录八:条码类型) |
codePage | Int | 编码类型 | (详见附录九:编码类型) |
moduleWidth | Double | 最小线宽 | 0为自动,否则将影响条码宽度,单位:mm |
optimize | Bool | 条码优化开关 | 是否根据打印机dpi自动调整线宽 |
isMirror | Bool | 镜像开关 | 是否使用水平镜像 |
barColor | Int | 条颜色 | RGB值 |
backgroundColor | Int | 背景色 | RGB值 |
fontName | String | 字体名称 | 只对条形码有效,如:“宋体” |
fontSize | Double | 字体大小 | 只对条形码有效,单位:pt |
fontStyle | Int | 字体样式 | 只对条形码有效(详见附录六:字体样式) |
fontColor | Int | 字体颜色 | 只对条形码有效,RGB值 |
alignment | Int | 对齐方式 | 只对条形码有效(详见附录七:对齐方式) |
wordSpacing | Double | 字间距 | 只对条形码有效,单位:mm |
angle | Double | 角度 | 图形旋转角度,单位:度 |
函数:ZL_InsertImage
功能:插入图片
返回值:图形ID。类型:Int
备注:如果返回值小于0,则为失败。
参数说明:
名称 | 类型 | 释义 | 备注 |
x | Double | x坐标 | 单位:mm |
y | Double | y坐标 | 单位:mm |
width | Double | 图片区域宽度 | 单位:mm |
height | Double | 图片区域高度 | 单位:mm |
imagePath | String | 图片路径 | 支持gif、bmp、png、jpg、tif、pdf等 |
scaleType | Int | 填充模式 | (详见附录十:图片填充方式) |
angle | Double | 角度 | 图形旋转角度,单位:度 |
函数:ZL_DeleteShape
功能:删除图形
返回值:成功/失败。类型:eRET(详见附录一:返回值 eRET)
备注:图形id可以在插入图形时获取,也可以用中琅条码标签打印软件打开查看获取。
参数说明:
名称 | 类型 | 释义 | 备注 |
shapeId | Int | 图形id |
|
函数:ZL_OutputToPrinter
功能:输出到打印机
返回值:成功/失败。类型:eRET(详见附录一:返回值 eRET)
备注:当参数isCustomOutput为真时是异步执行,为假时是同步执行。
参数说明:
名称 | 类型 | 释义 | 备注 |
printer | String | 打印机名称 |
|
txtFile | String | TXT数据文件路径 | 当isCustomOutput为真时无效 |
startPage | Int | 开始页码 | 大于等于1 |
endPage | Int | 结束页码 | 大于等于开始页码 |
isCustomOutput | Bool | 自定义输出开关 | 为真时需要结合setShapeData、ZL_StartOutputCustom、ZL_StopOutput使用,详见demo |
函数:ZL_OutputToPDF
功能:输出到PDF文档
返回值:成功/失败。类型:eRET(详见附录一:返回值 eRET)
备注:当参数isCustomOutput为真时是异步执行,为假时是同步执行。
参数说明:
名称 | 类型 | 释义 | 备注 |
savePath | String | 文件保存路径 | 后缀名为pdf |
useCMYK | Bool | CMYK颜色开关 | 是否使用CMYK颜色输出 |
txtFile | String | TXT数据文件路径 | 当isCustomOutput为真时无效 |
zipLevel | Int | 压缩方式 | (详见附录十一:压缩方式) |
startPage | Int | 开始页码 | 大于等于1 |
endPage | Int | 结束页码 | 大于等于开始页码 |
isCustomOutput | Bool | 自定义输出开关 | 为真时需要结合setShapeData、ZL_StartOutputCustom、ZL_StopOutput使用,详见demo |
函数:ZL_OutputToTIFF
功能:输出到TIFF文档
返回值:成功/失败。类型:eRET(详见附录一:返回值 eRET)
备注:当参数isCustomOutput为真时是异步执行,为假时是同步执行。
参数说明:
名称 | 类型 | 释义 | 备注 |
savePath | String | 文件保存路径 | 后缀名为tiff |
txtFile | String | TXT数据文件路径 | 当isCustomOutput为真时无效 |
colorType | Int | 颜色类型 | (详见附录十四:颜色类型) |
dpi | Int | 图片DPI | DPI与输出速度成反比,与清晰度成正比 |
startPage | Int | 开始页码 | 大于等于1 |
endPage | Int | 结束页码 | 大于等于开始页码 |
isCustomOutput | Bool | 自定义输出开关 | 为真时需要结合setShapeData、ZL_StartOutputCustom、ZL_StopOutput使用,详见demo |
函数:ZL_OutputToImage
功能:输出到位图图片集合
返回值:成功/失败。类型:eRET(详见附录一:返回值 eRET)
备注:当参数isCustomOutput为真时是异步执行,为假时是同步执行。
参数说明:
名称 | 类型 | 释义 | 备注 |
saveDir | String | 图片文件保存目录 | 每一张纸单独生成一个图片 |
extType | Int | 图片格式类型 | (详见附录十二:图片格式类型) |
dpi | Int | 图片DPI | DPI与输出速度成反比,与清晰度成正比 |
txtFile | String | TXT数据文件路径 | 当isCustomOutput为真时无效 |
startPage | Int | 开始页码 | 大于等于1 |
endPage | Int | 结束页码 | 大于等于开始页码 |
isCustomOutput | Bool | 自定义输出开关 | 为真时需要结合setShapeData、ZL_StartOutputCustom、ZL_StopOutput使用,详见demo |
函数:ZL_StartOutputCustom
功能:开始输出当前页面
返回值:成功/失败。类型:eRET(详见附录一:返回值 eRET)
备注:如需输出可变内容,请先执行setShapeData函数;否则为静态输出。详细请参考demo。
参数说明:无参数。
函数:ZL_SetDataCustom
功能:图形数据赋值
返回值:成功/失败/遇忙。类型:eRET(详见附录一:返回值 eRET)
备注:只有文字、条码/二维码、图片图形可以赋值。
参数说明:
名称 | 类型 | 释义 | 备注 |
shapeId | Int | 图形id | 文字、条码/二维码、图片的图形id |
data | String | 图形数据 |
|
函数:ZL_IsOutputing
功能:当前输出任务是否正在运行
返回值:是/否。类型:Bool
备注:正在输出为真;否则为假。
参数说明:无参数。
函数:ZL_StopOutput
功能:中止当前输出任务
返回值:成功/失败。类型:eRET(详见附录一:返回值 eRET)
备注:已经结束或者中止成功均为真;否则为假。
参数说明:无参数。
函数:ZL_PdfTool
功能:对PDF文档进行拆分、合并、叠加操作
返回值:成功/失败。类型:eRET(详见附录一:返回值 eRET)
备注:本操作为PDF无损、快速操作工具,清晰度高、速度快,不会造成PDF质量损失。
参数说明:
名称 | 类型 | 释义 | 备注 |
saveDirOrPath | String | 文件保存目录或路径 | 拆分是为目录,其它为路径 |
file1 | String | PDF文档1 | 最终效果与先后次序有关 |
file2 | String | PDF文档2 | 最终效果与先后次序有关 |
actionType | Int | 操作类型 | (详见附录十三:PDF工具操作类型) |
maximumPages | Bool | 页数最大化开关 | 是否尽可能多的输出页面数量 |
pagesPerBatch | Int | 每个文件页面数量 | 只对拆分操作有效 |
附录一:返回值eRET
类型:enum
成员列表:
名称 | 值(Int) | 释义 | 备注 |
RET_OK | 0 | 执行成功 |
|
RET_ERROR | -1 | 执行失败 |
|
RET_BUSY | -2 | 遇忙,稍后再试 | 只在自定义输出过程中,执行ZL_SetDataCustom函数时会出现。 |
附录二:进纸方向
类型:Int
值列表:
名称 | 值 | 备注 |
横向进纸 | 0 |
|
纵向进纸 | 1 |
|
附录三:线条样式
类型:Int
值列表:
名称 | 值 | 备注 |
实线 | 0 |
|
点线 | 1 |
|
划线 | 2 |
|
点划线 | 3 |
|
点点划线 | 4 |
|
附录四:线条类型
类型:Int
值列表:
名称 | 值 | 备注 |
线段 | 0 |
|
弧线 | 1 |
|
曲线 | 2 |
|
附录五:文本模式
类型:Int
值列表:
名称 | 值 | 备注 |
单行 | 0 |
|
多行 | 1 |
|
弧形 | 2 |
|
附录六:字体样式
类型:Int
值列表:
名称 | 值 | 备注 |
常规 | 0 |
|
粗体 | 1 |
|
斜体 | 2 |
|
粗斜体 | 3 |
|
附录七:对齐方式
类型:Int
值列表:
名称 | 值 | 备注 |
左对齐 | 0 |
|
右对齐 | 1 |
|
中间对齐 | 2 |
|
两端对齐 | 3 |
|
附录八:条码类型
类型:Int
值列表:
类型 | 值 | 类型 | 值 |
Code11 | 1 | AustralianPostReplyPaid | 66 |
Code2Of5Standard | 2 | AustralianPostRouting | 67 |
Code2Of5Interleaved | 3 | AustralianPostRedirection | 68 |
Code2Of5Iata | 4 | Isbn13 | 69 |
Code2Of5Matrix | 5 | RM4Scc | 70 |
Code2Of5DataLogic | 6 | DataMatrix | 71 |
Code2Of5Industry | 7 | Ean14 | 72 |
Code39 | 8 | VIN | 73 |
Code39Extended | 9 | CodablockF | 74 |
Ean8 | 10 | Nve18 | 75 |
Ean8With2Addon | 11 | JapanesePostal | 76 |
Ean8With5Addon | 12 | KoreanPostalAuthority | 77 |
Ean13 | 13 | Gs1DataBarTruncated | 78 |
Ean13With2Addon | 14 | Gs1DataBarStacked | 79 |
Ean13With5Addon | 15 | Gs1DataBarStackedOmnidirectional | 80 |
EanUcc128 | 16 | Gs1DataBarExpandedStacked | 81 |
Upc12 | 17 | Planet12 | 82 |
Codabar2 | 18 | Planet14 | 83 |
Codabar18 | 19 | MicroPdf417 | 84 |
Code128 | 20 | UspsIntelligentMail | 85 |
DeutschePostLeitcode | 21 | PlesseyBidirectional | 86 |
DeutschePostIdentcode | 22 | Telepen | 87 |
Isbn13With5Addon | 23 | GS1128 | 88 |
Ismn | 24 | ITF14 | 89 |
Code93 | 25 | KIX | 90 |
Issn | 26 | Code32 | 91 |
IssnWith2Addon | 27 | Aztec | 92 |
Flattermarken | 28 | DAFT | 93 |
Gs1DataBar | 29 | ItalianPostal2Of5 | 94 |
Gs1DataBarLimited | 30 | ItalianPostal3Of9 | 95 |
Gs1DataBarExpanded | 31 | DPD | 96 |
TelepenAlpha | 32 | MicroQRCode | 97 |
Ucc128 | 33 | HIBCLic128 | 98 |
UpcA | 34 | HIBCLic3OF9 | 99 |
UpcAWith2Addon | 35 | HIBCPas128 | 100 |
UpcAWith5Addon | 36 | HIBCPas3OF9 | 101 |
UpcE | 37 | HIBCLicDataMatrix | 102 |
UpcEWith2Addon | 38 | HIBCPasDataMatrix | 103 |
UpcEWith5Addon | 39 | HIBCLicQRCode | 104 |
UspsPostnet5 | 40 | HIBCPasQRCode | 105 |
UspsPostnet6 | 41 | HIBCLicPDF417 | 106 |
UspsPostnet9 | 42 | HIBCPasPDF417 | 107 |
UspsPostnet10 | 43 | HIBCLicMPDF417 | 108 |
UspsPostnet11 | 44 | HIBCPasMPDF417 | 109 |
UspsPostnet12 | 45 | HIBCLicCODABLOCKF | 110 |
Plessey | 46 | HIBCPasCODABLOCKF | 111 |
Msi | 47 | QRCodeISO | 112 |
Sscc18 | 48 | PZN8 | 113 |
Fim | 49 | Reserved_1 | 114 |
Logmars | 50 | DotCode | 115 |
PharmacodeOneTrack | 51 | HanXin | 116 |
PZN7 | 52 | USPSIMPackage | 117 |
PharmacodeTwoTrack | 53 | SwedishPostalShipmentId | 118 |
CEPNet | 54 | Mailmark_2D | 119 |
Pdf417 | 55 | UpuS10 | 120 |
Pdf417Truncated | 56 | Mailmark_4state | 121 |
Maxicode | 57 | HIBCLicAztec | 122 |
QRCodeJIS | 58 | HIBCPasAztec | 123 |
Code128SubsetA | 59 | PPN | 124 |
Code128SubsetB | 60 | NTIN | 125 |
Code128SubsetC | 61 | SwissQrCode | 126 |
Code93Extended | 62 |
|
|
AustralianPostCustom | 63 |
|
|
AustralianPostCustom2 | 64 |
|
|
AustralianPostCustom3 | 65 |
|
|
附录九:编码类型
类型:Int
值列表:
名称 | 值 | 名称 | 值 |
Default | 1 | ISO_8859_3 | 16 |
Ansi | 2 | ISO_8859_4 | 17 |
Windows1252 | 3 | ISO_8859_5 | 18 |
LatinI | 4 | ISO_8859_6 | 19 |
AsciiExtended | 5 | ISO_8859_7 | 20 |
Utf8 | 6 | ISO_8859_8 | 21 |
Korean | 7 | ISO_8859_9 | 22 |
JapaneseShiftJis | 8 | ISO_8859_10 | 23 |
SimplifiedChinese | 9 | ISO_8859_11 | 24 |
TraditionalChinese | 10 | ISO_8859_13 | 25 |
AnsiCyrillic | 11 | ISO_8859_14 | 26 |
RussianKoi8R | 12 | ISO_8859_15 | 27 |
Chinese_GB18030 | 13 | ISO_8859_16 | 28 |
MAC_Roman | 14 | Utf_16LE | 29 |
ISO_8859_2 | 15 | Utf_16BE | 30 |
附录十:图片填充方式
类型:Int
值列表:
名称 | 值 | 备注 |
按比例 | 0 |
|
铺满 | 1 |
|
附录十一:压缩方式
类型:Int
值列表:
名称 | 值 | 备注 |
最快 | 0 | 无压缩,速度最快 |
快速 | 1 | 压缩率低,速度较快 |
标准 | 2 | 压缩率一般,速度一般 |
较好 | 3 | 压缩率较高,速度较慢 |
最好 | 4 | 压缩率最高,速度最慢 |
附录十二:图片格式类型
类型:Int
值列表:
名称 | 值 | 备注 |
bmp | 0 |
|
gif | 1 |
|
jpg | 2 |
|
png | 3 |
|
tiff | 4 |
|
附录十三:PDF工具操作类型
类型:Int
值列表:
名称 | 值 | 备注 |
拆分 | 0 |
|
顺序合并 | 1 |
|
交叉合并 | 2 |
|
叠加合并 | 3 |
|
附录十四:颜色类型
类型:Int
值列表:
名称 | 值 | 备注 |
彩色 | 0 |
|
黑白 | 1 |
|
灰度 | 2 |
|
郑州易网科技有限公司
TEL:400-6666-086 Email:ew8cn@126.com
2018年4月20日
共有条评论 网友评论