中瑯可變數據軟件外部程序調用接口(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 | 執行失敗 |
|
共有條評論 網友評論