中琅可变数据软件外部程序调用接口(RIP相关)说明

1、接口初始化:

函数ZL_Initialization

功能:接口初始化

返回值:成功/失败。类型:eRET(详见附录一:返回值eRET

备注:在接口程序运行开始的时候运行一次。

参数说明

名称

类型

释义

备注

programDir

string

中琅条码标签打印软件程序目录

如:d:\中琅条码标签打印软件\


 2、打开文档

函数ZL_OpenDoc

功能:打开现有标签文档

返回值:成功/失败。类型:eRET(详见附录一:返回值eRET

备注:支持旧版标签文档。

参数说明

名称

类型

释义

备注

filePath

String

标签文档路径

后缀名:zhl 或 lp

password

String

标签文档打开密码

可以为null或空值

 

3、获取文档总页数:

函数ZL_GetTotalPages

功能:获取指定文档总页数。

返回值:总页数(-1为失败;其它为页数)。类型:int

备注:无。

参数说明

名称

类型

释义

备注

filePath

string

标签文档路径

后缀名:zhl 或 lp,为null或空值时仅打开软件主窗口

password

string

标签文档打开密码

可以为null或空值

 

4、获取文档尺寸:

函数ZL_GetPageSize

功能:按照指定DPI获取文档尺寸。

返回值:成功/失败。类型:eRET(详见附录一:返回值eRET

备注:无。

参数说明

名称

类型

释义

备注

xDPI

int

进纸方向DPI

 

yDPI

int

喷头方向DPI

 

width

int& [out]

文档宽度

单位:点

height

int& [out]

文档高度

单位:点

 

5、设置接收RIP数据的回调

设置回调ZL_SetRIPReadCallback

功能:接收RIP数据

返回值:成功/失败。类型:eRET(详见附录一:返回值eRET

备注:请在调用输出指令前一次性设置。

回调声明:

void (*pRIPReadFun)(byte* ripData, int dataLen, int lineByteWidth, int imageWidth, int imageHeight, int pageIndex, char* text, int effectPts);

回调备注:ripData行数据做了32bit对齐;pageIndex为当前输出页序列,不是页码。

回调参数说明

名称

类型

释义

备注

ripData

byte*

RIP数据数组

整图RIP数据

dataLen

int

RIP数据数组长度

 

lineByteWidth

int

32bit对齐后的每行宽度

单位:byte

imageWidth

int

图像宽度

单位:点

ImageHeight

int

图像高度

单位:点

pageIndex

int

当前输出页序列

从0开始

text

char*

当前标签数据内容

 

effectPts

int

有效点数量

当前页有效点数量

 

6、启动RIP输出

函数ZL_OutputToRIP

功能:启动RIP输出

返回值:成功/失败。类型:eRET(详见附录一:返回值eRET

备注:无。

参数说明

名称

类型

释义

备注

startPage

int

起始页码

从1开始,小于结束页码

endPage

int

结束页码

从1开始,大于起始页码

xDPI

int

进纸方向DPI

 

yDPI

int

喷头方向DPI

 

printUnitWidth

double

喷头宽度

单位:mm

colorCount

int

颜色种类

黑白:1;彩色:4

colorDepth

int

色深(bit)

可选值:1、2

threshold

int

颜色阈值

最小值0,最大值100

isCustomOutput

bool

自定义输出开关

true:允许程序修改某个图形的数据

flase:根据标签数据源输出。

 

7、设置接收RGB数据的回调

设置回调ZL_SetRGBReadCallback

功能:接收RGB数据

返回值:成功/失败。类型:eRET(详见附录一:返回值eRET

备注:请在调用输出指令前一次性设置。

回调声明:

void (*pRGBReadFun)(byte* rgbData, int dataLen, int imageWidth, int imageHeight, int pageIndex, char* text);

回调备注:rgbData行数据未做32bit对齐;pageIndex为当前输出页序列,不是页码。

回调参数说明

名称

类型

释义

备注

rgbData

byte*

RGB数据数组

整图RGB数据

dataLen

int

RGB数据数组长度

 

imageWidth

int

图像宽度

单位:点

ImageHeight

int

图像高度

单位:点

pageIndex

int

当前输出页序列

从0开始

text

char*

当前标签数据内容

 

 

8、启动RGB输出

函数ZL_OutputToRGB

功能:启动RGB输出

返回值:成功/失败。类型:eRET(详见附录一:返回值eRET

备注:无。

参数说明

名称

类型

释义

备注

startPage

int

起始页码

从1开始,小于结束页码

endPage

int

结束页码

从1开始,大于起始页码

xDPI

int

进纸方向DPI

 

yDPI

int

喷头方向DPI

 

isCustomOutput

bool

自定义输出开关

true:允许程序修改某个图形的数据

flase:根据标签数据源输出。

 

9、停止输出

函数ZL_StopOutput

功能:停止输出

返回值:成功/失败。类型:eRET(详见附录一:返回值eRET

备注:支持旧版标签文档。

参数说明:无参数

 

10、关闭文档

函数ZL_CloseDoc

功能:关闭标签文档

返回值:成功/失败。类型:eRET(详见附录一:返回值eRET

备注:非必须操作。

参数说明:无参数。

 

11、释放资源

函数ZL_Release

功能:释放接口占用资源

返回值:成功/失败。类型:eRET(详见附录一:返回值eRET

备注:在接口程序退出前运行一次。

参数说明:无参数。

 

附录一:返回值eRET

类型:enum

成员列表

名称

值(Int)

释义

备注

RET_OK

0

执行成功

 

RET_ERROR

-1

执行失败

 

标签:可变数据软件 , 外部程序调用接口 , RIP

共有条评论 网友评论

验证码: 看不清楚?