首页
易打标
云防伪
云仓库
服务中心

易打标API文档

属性

属性名称 属性值 功能说明 应用场景 版本要求
Mode

Design:设计模式(默认)

Preview:预览模式

Print:打印模式

Bind:绑定模式

获取或设置功能模式 所有 Design、Preview、Print模式要求YDBCtrl.ocx 1.0或更高版本; Bind模式要求YDBCtrl.ocx 3.1或更高版本
LabelID 标签ID 设置打印标签ID 网页端打印模式 YDBCtrl.ocx 2.0或更高版本

标签鉴权类

IsLogin

函数功能 判断是否登录
函数原型 VARIANT_BOOL IsLogin(void);
参数说明
返回值

如果已登录,返回true。

如果未登录,返回false。

模式要求
版本要求 YDBCtrl.ocx 1.0或更高版本
应用场景 仅针对云端终端用户调用模式。

Login

函数功能 以应用ID、应用Key方式登录
函数原型 LONG Login(BSTR AppID, BSTR AppKey, VARIANT_BOOL IsAsync)
参数说明

AppID:应用ID

AppKey:应用密码

IsAsync:是否以异步方式调用,True为异步,False为同步

返回值

如果登录成功,返回零。

如果登录失败,返回一个非零值。要得到更多错误信息,请使用GetLastErrorMessage函数。

模式要求
版本要求 YDBCloudCtrl.ocx 3.6或更高版本
应用场景 仅针对云端开发者调用模式。

Connect

函数功能 以IP地址、端口号方式登录
函数原型 LONG Connect(BSTR IPaddr, SHORT Port, BSTR AppID, BSTR AppKey,VARIANT_BOOL IsAsync)
参数说明

IPaddr:IP地址

Port:端口号

AppID:应用ID

AppKey:应用密码

IsAsync:是否以异步方式调用,True为异步,False为同步

返回值

如果登录成功,返回零。

如果登录失败,返回一个非零值。要得到更多错误信息,请使用GetLastErrorMessage函数。

模式要求
版本要求 YDBCtrl.ocx 1.0或更高版本
应用场景 仅适用于易打标企业版本。。

SetOwner

函数功能 设置标签拥有者(如果设置了该值,那么用户创建的标签都将属于该Owner。PS:调用成功后会刷新标签列表)
函数原型 VARIANT_BOOL SetOwner(BSTR Owner);
参数说明 Owner:拥有者标志
返回值

如果设置成功,返回true。

如果设置失败,返回false。要得到更多错误信息,请使用GetLastErrorMessage函数。

模式要求 设计模式
版本要求 YDBCtrl.ocx 1.0或更高版本
应用场景 仅适用于易打标企业版本。

SetFilter

函数功能 过滤标签列表(如果设置了该值,那么用户只能查看此Filter创建的标签;如果不设置该值,可以查看该账号下所有的标签。该函数主要用于权限管控,一般与SetOwner配合使用。PS:调用成功后会刷新标签列表)
函数原型 VARIANT_BOOL SetFilter(BSTR Filter);
参数说明 Filter:拥有者标志(多个Owner用逗号(,)分隔)
返回值

如果设置成功,返回true。

如果设置失败,返回false。要得到更多错误信息,请使用GetLastErrorMessage函数。

模式要求 设计模式
版本要求 YDBCtrl.ocx 3.0或更高版本
应用场景 仅适用于易打标企业版本。。

标签装载类

OpenLabel

函数功能 根据标签ID加载标签
函数原型 LONG OpenLabel(BSTR sLabelID, VARIANT_BOOL IsAsync);
参数说明

sLabelID:标签ID

IsAsync:是否以异步方式调用,True为异步,False为同步

返回值

如果调用成功,返回零。

如果调用失败,返回一个非零值。要得到更多错误信息,请使用GetLastErrorMessage函数。

模式要求 设计模式
版本要求 YDBCtrl.ocx 1.0或更高版本

LoadLabel

函数功能 根据标签ID和版本号加载标签版本
函数原型 LONG LoadLabel(BSTR sLabelID, VARIANT_BOOL IsAsync);
参数说明

sLabelID:标签ID

IsAsync:是否以异步方式调用,True为异步,False为同步

返回值

如果调用成功,返回零。

如果调用失败,返回一个非零值。要得到更多错误信息,请使用GetLastErrorMessage函数。

模式要求 预览模式、打印模式
版本要求 YDBCtrl.ocx 1.0或更高版本

LoadLabelByCode

函数功能 根据标签编号和版本号加载标签版本
函数原型 LONG LoadLabelByCode(BSTR sLabelCode, VARIANT_BOOL IsAsync);
参数说明

sLabelID:标签编号

IsAsync:是否以异步方式调用,True为异步,False为同步

返回值

如果调用成功,返回零。

如果调用失败,返回一个非零值。要得到更多错误信息,请使用GetLastErrorMessage函数。

模式要求 预览模式、打印模式
版本要求 YDBCtrl.ocx 1.0或更高版本

LoadPrintData

函数功能 加载打印数据
函数原型 LONG LoadPrintData(BSTR pJsonData , VARIANT_BOOL boAdaptive);
参数说明

pJsonData:打印数据,以JSON数组格式打包,如:

[

{ “Name”: “张三”, “Age”: 20, “Hobby”: “滑冰、打篮球” },

{ “Name”: “李四”, “Age”: 18, “Hobby”: “上网、看书” }

]

boAdaptive:是否自适应序列化标签

返回值

如果调用成功,返回零。

如果调用失败,返回一个非零值。要得到更多错误信息,请使用GetLastErrorMessage函数。

模式要求 预览模式
版本要求 YDBCtrl.ocx 1.0或更高版本

LoadDbPrintData

函数功能 调用ado从数据库加载打印数据
函数原型 LONG LoadDbPrintData(BSTR sConnectString, BSTR sSQL , VARIANT_BOOL boAdaptive);
参数说明

sConnectString:ado连接字符串

sSQL:SQL查询命令

boAdaptive:是否自适应序列化标签

返回值

如果调用成功,返回零。

如果调用失败,返回一个非零值。要得到更多错误信息,请使用GetLastErrorMessage函数。

模式要求 预览模式
版本要求 YDBCtrl.ocx 1.0或更高版本

标签打印类

PrintToLPT

函数功能 打印到指定LPT端口
函数原型 LONG PrintToLPT(VARIANT_BOOL boPrintDefault, BSTR sJsonScript, BSTR sPortName);
参数说明

boPrintDefault:当数据件的数据源为空时是否打印默认值,True为打印,False为不打印。

sJsonScript:数据源,以JSON对象格式打包。

普通标签格式如下:

{ “产品名称”: “苹果”, “重量”: “1.8kg”, “条码”: “123456” }

序列化标签格式如下(1行2列):

[{ “产品名称”: “苹果”, “重量”: “1.8kg”, “条码”: “123456” },

{ “产品名称”: “橙子”, “重量”: “1.6kg”, “条码”: “9527” }]

sPortName:LPT端口号,如:LPT3

返回值

如果调用成功,返回零。

如果调用失败,返回一个非零值。要得到更多错误信息,请使用GetLastErrorMessage函数。

模式要求 打印模式
版本要求 YDBCtrl.ocx 1.0或更高版本

PrintToCOM

函数功能 打印到指定COM端口
函数原型 LONG PrintToCOM(VARIANT_BOOL boPrintDefault, BSTR sJsonScript, BSTR sPortName, LONG nRate, BYTE bByteSize, BYTE bParity, BYTE bStopBits);
参数说明

boPrintDefault:当数据件的数据源为空时是否打印默认值,True为打印,False为不打印。

sJsonScript:数据源,以JSON对象格式打包。

普通标签格式如下:

{ “产品名称”: “苹果”, “重量”: “1.8kg”, “条码”: “123456” }

序列化标签格式如下(1行2列):

[{ “产品名称”: “苹果”, “重量”: “1.8kg”, “条码”: “123456” },

{ “产品名称”: “橙子”, “重量”: “1.6kg”, “条码”: “9527” }]

sPortName:COM端口号,如:COM1

nRate:波特率

bByteSize:数据位

bParity:奇偶校验位

bStopBits:停止位

返回值

如果调用成功,返回零。

如果调用失败,返回一个非零值。要得到更多错误信息,请使用GetLastErrorMessage函数。

模式要求 打印模式
版本要求 YDBCtrl.ocx 1.0或更高版本

PrintToNetwork

函数功能 打印到指定TCP/IP端口
函数原型 LONG PrintToNetwork(VARIANT_BOOL boPrintDefault, BSTR sJsonScript, BSTR sIPAddress, USHORT nPort);
参数说明

boPrintDefault:当数据件的数据源为空时是否打印默认值,True为打印,False为不打印。

sJsonScript:数据源,以JSON对象格式打包。

普通标签格式如下:

{ “产品名称”: “苹果”, “重量”: “1.8kg”, “条码”: “123456” }

序列化标签格式如下(1行2列):

[{ “产品名称”: “苹果”, “重量”: “1.8kg”, “条码”: “123456” },

{ “产品名称”: “橙子”, “重量”: “1.6kg”, “条码”: “9527” }]

sIPAddress:IP地址,如:192.168.10.188

nPort:端口号

返回值

如果调用成功,返回零。

如果调用失败,返回一个非零值。要得到更多错误信息,请使用GetLastErrorMessage函数。

模式要求 打印模式
版本要求 YDBCtrl.ocx 1.0或更高版本

PrintToUSB

函数功能 打印到指定USB端口
函数原型 LONG PrintToUSB(VARIANT_BOOL boPrintDefault, BSTR sJsonScript, BSTR sPortName);
参数说明

boPrintDefault:当数据件的数据源为空时是否打印默认值,True为打印,False为不打印。

sJsonScript:数据源,以JSON对象格式打包。

普通标签格式如下:

{ “产品名称”: “苹果”, “重量”: “1.8kg”, “条码”: “123456” }

序列化标签格式如下(1行2列):

[{ “产品名称”: “苹果”, “重量”: “1.8kg”, “条码”: “123456” },

{ “产品名称”: “橙子”, “重量”: “1.6kg”, “条码”: “9527” }]

sPortName:USB端口名称

返回值

如果调用成功,返回零。

如果调用失败,返回一个非零值。要得到更多错误信息,请使用GetLastErrorMessage函数。

模式要求 打印模式
版本要求 YDBCtrl.ocx 1.0或更高版本

PrintToPrinter

函数功能 打印到指定本地打印机
函数原型 LONG PrintToPrinter(VARIANT_BOOL boPrintDefault, BSTR sJsonScript, BSTR sPrinterName, VARIANT_BOOL boAutoAdaptive);
参数说明

boPrintDefault:当数据件的数据源为空时是否打印默认值,True为打印,False为不打印。

sJsonScript:数据源,以JSON对象格式打包。

普通标签格式如下:

{ “产品名称”: “苹果”, “重量”: “1.8kg”, “条码”: “123456” }

序列化标签格式如下(1行2列):

[{ “产品名称”: “苹果”, “重量”: “1.8kg”, “条码”: “123456” },

{ “产品名称”: “橙子”, “重量”: “1.6kg”, “条码”: “9527” }]

sPrinterName:打印机名称

boAutoAdaptive:是否自适应纸张大小

返回值

如果调用成功,返回零。

如果调用失败,返回一个非零值。要得到更多错误信息,请使用GetLastErrorMessage函数。

模式要求 打印模式
版本要求 YDBCtrl.ocx 1.0或更高版本

PrintToBind

函数功能 打印到标签绑定的打印机 (在bind模式下进行标签与打印机的绑定)
函数原型 LONG PrintToBind(VARIANT_BOOL boPrintDefault, BSTR sJsonScript);
参数说明

boPrintDefault:当数据件的数据源为空时是否打印默认值,True为打印,False为不打印。

sJsonScript:数据源,以JSON对象格式打包。

返回值

如果调用成功,返回零。

如果调用失败,返回一个非零值。要得到更多错误信息,请使用GetLastErrorMessage函数。

模式要求 打印模式
版本要求 YDBCtrl.ocx 1.0或更高版本

Print

函数功能 打印到易打标打印设置已配置的端口或者打印机(该函数通常与PrintSetting函数配合使用)
函数原型 LONG Print(VARIANT_BOOL boPrintDefault, BSTR sJsonScript, BSTR sPortName);
参数说明

boPrintDefault:当数据件的数据源为空时是否打印默认值,True为打印,False为不打印。

sJsonScript:数据源,以JSON对象格式打包。

普通标签格式如下:

{ “产品名称”: “苹果”, “重量”: “1.8kg”, “条码”: “123456” }

序列化标签格式如下(1行2列):

[{ “产品名称”: “苹果”, “重量”: “1.8kg”, “条码”: “123456” },

{ “产品名称”: “橙子”, “重量”: “1.6kg”, “条码”: “9527” }]

sPrinterName:端口名称,空值时("")使用默认端口,否则使用指定端口。

返回值

如果调用成功,返回零。

如果调用失败,返回一个非零值。要得到更多错误信息,请使用GetLastErrorMessage函数。

模式要求 打印模式
版本要求 YDBCtrl.ocx 1.0或更高版本

MultiplePrintBeginToLPT

函数功能 开始打印序列化标签到指定LPT端口
函数原型 LONG MultiplePrintBeginToLPT(VARIANT_BOOL boPrintDefault, BSTR sPortName);
参数说明

boPrintDefault:当数据件的数据源为空时是否打印默认值,True为打印,False为不打印。

sPortName:LPT端口号,如:LPT3

返回值

如果调用成功,返回零。

如果调用失败,返回一个非零值。要得到更多错误信息,请使用GetLastErrorMessage函数。

模式要求 打印模式
版本要求 YDBCtrl.ocx 3.0或更高版本

MultiplePrintBeginToCOM

函数功能 开始打印序列化标签到指定COM端口
函数原型 LONG MultiplePrintBeginToCOM(VARIANT_BOOL boPrintDefault, BSTR sPortName, LONG nRate, BYTE bByteSize, BYTE bParity, BYTE bStopBits);
参数说明

boPrintDefault:当数据件的数据源为空时是否打印默认值,True为打印,False为不打印。

sPortName:COM端口号,如:COM1

nRate:波特率

bByteSize:数据位

bParity:奇偶校验位

bStopBits:停止位

返回值

如果调用成功,返回零。

如果调用失败,返回一个非零值。要得到更多错误信息,请使用GetLastErrorMessage函数。

模式要求 打印模式
版本要求 YDBCtrl.ocx 3.0或更高版本

MultiplePrintBeginToNetwork

函数功能 开始打印序列化标签到指定TCP/IP端口
函数原型 LONG MultiplePrintBeginToNetwork(VARIANT_BOOL boPrintDefault, BSTR sIPAddress, USHORT nPort);
参数说明

boPrintDefault:当数据件的数据源为空时是否打印默认值,True为打印,False为不打印。

sIPAddress:IP地址,如:192.168.10.188

nPort:端口号

返回值

如果调用成功,返回零。

如果调用失败,返回一个非零值。要得到更多错误信息,请使用GetLastErrorMessage函数。

模式要求 打印模式
版本要求 YDBCtrl.ocx 3.0或更高版本

MultiplePrintBeginToUSB

函数功能 开始打印序列化标签到指定USB端口
函数原型 LONG MultiplePrintBeginToUSB(VARIANT_BOOL boPrintDefault, BSTR sPortName);
参数说明

boPrintDefault:当数据件的数据源为空时是否打印默认值,True为打印,False为不打印。

sPortName:USB端口名称

返回值

如果调用成功,返回零。

如果调用失败,返回一个非零值。要得到更多错误信息,请使用GetLastErrorMessage函数。

模式要求 打印模式
版本要求 YDBCtrl.ocx 3.0或更高版本

MultiplePrintBeginToPrinter

函数功能 开始打印序列化标签到指定本地打印机
函数原型 LONG MultiplePrintBeginToPrinter(VARIANT_BOOL boPrintDefault, BSTR sPrinterName, VARIANT_BOOL boAutoAdaptive);
参数说明

boPrintDefault:当数据件的数据源为空时是否打印默认值,True为打印,False为不打印。

sPrinterName:打印机名称

boAutoAdaptive:是否自适应纸张大小

返回值

如果调用成功,返回零。

如果调用失败,返回一个非零值。要得到更多错误信息,请使用GetLastErrorMessage函数。

模式要求 打印模式
版本要求 YDBCtrl.ocx 3.0或更高版本

MultiplePrintBeginToBind

函数功能 开始打印序列化标签到标签绑定的打印机(前提是在Bind模式下将标签和打印机绑定)
函数原型 LONG MultiplePrintBeginToBind (VARIANT_BOOL boPrintDefault);
参数说明

boPrintDefault:当数据件的数据源为空时是否打印默认值,True为打印,False为不打印。

返回值

如果调用成功,返回零。

如果调用失败,返回一个非零值。要得到更多错误信息,请使用GetLastErrorMessage函数。

模式要求 打印模式
版本要求 YDBCtrl.ocx 3.0或更高版本

MultiplePrintBegin

函数功能 开始打印序列化标签到易打标打印设置已配置的端口或者打印机(该函数通常与PrintSetting函数配合使用)
函数原型 LONG MultiplePrintBegin (VARIANT_BOOL boPrintDefault, BSTR sPortName);
参数说明

boPrintDefault:当数据件的数据源为空时是否打印默认值,True为打印,False为不打印。

sPrinterName:端口名称,空值时("")使用默认端口,否则使用指定端口。

返回值

如果调用成功,返回零。

如果调用失败,返回一个非零值。要得到更多错误信息,请使用GetLastErrorMessage函数。

模式要求 打印模式
版本要求 YDBCtrl.ocx 3.0或更高版本

MultiplePrint

函数功能 打印序列化标签(执行此函数前要先调用MultiplePrintBegin***系列的函数)
函数原型 LONG MultiplePrint(BSTR sJsonScript);
参数说明

sJsonScript:数据源,以JSON对象格式打包,如:

{ “产品名称”: “苹果”, “重量”: “1.8kg”, “条码”: “123456” }

返回值

如果调用成功,返回零。

如果调用失败,返回一个非零值。要得到更多错误信息,请使用GetLastErrorMessage函数。

模式要求 打印模式
版本要求 YDBCtrl.ocx 3.0或更高版本

MultiplePrintFlush

函数功能 立刻打印缓存中的数据(例如:标签模板为3行2列的标签,完整标签需要6条数据,此时缓存中只有2条数据,调用此函数也会立即打印)
函数原型 LONG MultiplePrintFlush(void);
参数说明
返回值

如果调用成功,返回零。

如果调用失败,返回一个非零值。要得到更多错误信息,请使用GetLastErrorMessage函数。

模式要求 打印模式
版本要求 YDBCtrl.ocx 3.0或更高版本

MultiplePrintEnd

函数功能 将缓存中的数据打印并退出序列化标签打印
函数原型 LONG MultiplePrintEnd(void);
参数说明
返回值

如果调用成功,返回零。

如果调用失败,返回一个非零值。要得到更多错误信息,请使用GetLastErrorMessage函数。

模式要求 打印模式
版本要求 YDBCtrl.ocx 3.0或更高版本

MultiplePrintCancel

函数功能 退出序列化标签打印
函数原型 LONG MultiplePrintEnd(void);
参数说明
返回值

如果调用成功,返回零。

如果调用失败,返回一个非零值。要得到更多错误信息,请使用GetLastErrorMessage函数。

模式要求 打印模式
版本要求 YDBCtrl.ocx 3.0或更高版本

VerifyPrintData

函数功能 校验打印数据格式
函数原型 LONG VerifyPrintData(VARIANT_BOOL boPrintDefault, BSTR sJsonScript);
参数说明

boPrintDefault:当数据件的数据源为空时是否打印默认值,True为打印,False为不打印。

sJsonScript:数据源,以JSON对象格式打包。

普通标签正确格式如下:

{ “产品名称”: “苹果”, “重量”: “1.8kg”, “条码”: “123456” }

序列化标签正确格式如下(1行2列):

[{ “产品名称”: “苹果”, “重量”: “1.8kg”, “条码”: “123456” },

{ “产品名称”: “橙子”, “重量”: “1.6kg”, “条码”: “9527” }]

返回值 如果调用校验通过,返回零。否则格式不正确(例如一维码数据件传入中文参数)
模式要求 打印模式
版本要求 YDBCtrl.ocx 3.0或更高版本

标签工具类

GetLastErrorMessage

函数功能 获取最后一次异常详细信息
函数原型 BSTR GetLastErrorMessage(void);
参数说明
返回值 异常详细信息
模式要求
版本要求 YDBCtrl.ocx 1.0或更高版本

GetLastActionMessage

函数功能 获取最后一次事件源详细信息(该函数一般在OnActionResult事件中调用,例如删除标签事件时获取被删除的标签的详细信息)
函数原型 BSTR GetLastActionMessage(void);
参数说明
返回值 数据源详细信息
模式要求
版本要求 YDBCtrl.ocx 3.0或更高版本

GetLabelList

函数功能 获取某个云账号下,本用户的所有标签列表信息。
函数原型 BSTR GetLabelList(void);
参数说明
返回值 标签列表JSON数据
模式要求
版本要求 YDBCtrl.ocx 1.0或更高版本

PrintSetting

函数功能 调用易打标的打印设置界面(该函数通常与Print函数配合使用)
函数原型 BSTR PrintSetting(void);
参数说明
返回值 设置后的端口名称
模式要求
版本要求 YDBCtrl.ocx 1.0或更高版本

SetPrintPort

函数功能 设置打印端口
函数原型 LONG SetPrintPort(BSTR sPort);
参数说明 sPort:端口名称(该参数可通过PrintSetting函数获取)
返回值

如果调用成功,返回零。

如果调用失败,返回一个非零值。要得到更多错误信息,请使用GetLastErrorMessage函数。

模式要求 预览模式
版本要求 YDBCtrl.ocx 2.0或更高版本

SetPrintCount

函数功能 设置打印份数
函数原型 LONG SetPrintCount(LONG nCount);
参数说明 nCount:打印份数
返回值

如果调用成功,返回零。

如果调用失败,返回一个非零值。要得到更多错误信息,请使用GetLastErrorMessage函数。

模式要求 预览模式
版本要求 YDBCtrl.ocx 2.0或更高版本

SetAutoCode

函数功能 设置新建标签时是否自动生成GUID编码
函数原型 LONG SetAutoCode(VARIANT_BOOL boAutoCode);
参数说明 boAutoCode:是否自动编码
返回值

如果调用成功,返回零。

如果调用失败,返回一个非零值。要得到更多错误信息,请使用GetLastErrorMessage函数。

模式要求 设计模式
版本要求 YDBCtrl.ocx 3.0或更高版本

SetDataSource

函数功能 设置数据源选择项
函数原型 LONG SetDataSource(BSTR sDataSource);
参数说明

sDataSource:数据源选择项,以JSON数组格式打包。

普通标签格式如下:

[ “名称”, “重量”, “条码”]

返回值

如果调用成功,返回零。

如果调用失败,返回一个非零值。要得到更多错误信息,请使用GetLastErrorMessage函数。

模式要求 预览模式
版本要求 YDBCtrl.ocx 3.0或更高版本

事件

SetDataSource

事件描述 操作结果事件
事件原型 void OnActionResult(LONG type, LONG result);
参数说明

type:操作类型,数值如下:

1:登录;2:加载标签;3:打印。

result:操作结果

版本要求 YDBCtrl.ocx 3.0或更高版本

联系客服

销售热线:400-636-8516

技术咨询:18905926369

24on微公号