中控門禁類岳陽zkfinger reader sdk v

1、中控儀SDK 開發(fā)指南C API版本：2.1日期：2019 年 04 月1中控儀 SDK 開發(fā)指南Copyright ©ZKTeco Inc.2019s.Release history2日期版本備注2016 年 5 月 21 日1.0基礎(chǔ)版2016 年 6 月 1 日1.1增加外部圖像接口2016 年 9 月 17 日2.0更新為統(tǒng)一接口( 保留1.0 接口)2019 年 4 月 9 日2.1增加接口/參數(shù)說明目錄1 概述42 隱私權(quán)說明43 系統(tǒng)需求44 安裝部署45 SDK 接口說明45.1 類型定義45.1.1 常量45.2 接口說明55.2.1 ZKFPM_Init55.2.

2、2 ZKFPM_Terminate55.2.3 ZKFPM_GetDeviceCount55.2.4 ZKFPM_OpenDevice65.2.5 ZKFPM_CloseDevice65.2.6 ZKFPM_SetParameters65.2.7 ZKFPM_GetParameters75.2.8 ZKFPM_AcquireFingerprint75.2.9 ZKFPM_AcquireFingerprintImage85.2.10 ZKFPM_DBInit85.2.11 ZKFPM_DBFree95.2.12 ZKFPM_DBMerge95.2.13 ZKFPM_DBAdd95.2.14 ZK

3、FPM_DBDel105.2.15 ZKFPM_DBClear105.2.16 ZKFPM_DBCount115.2.17 ZKFPM_DBIdentify115.2.18 ZKFPM_DBMatch115.2.19 ZKFPM_ExtractFromImage125.2.20 ZKFPM_Base64ToBlob135.2.21 ZKFPM_BlobToBase64135.2.22 ZKFPM_GetTemplateQuality145.2.23 ZKFPM_DBSetParameter14附錄15附錄 115附錄 21566.16.231 概述歡迎使用中控儀 SDK，在使用前請您先仔細(xì)閱讀

4、本手冊，以便您能更快地掌握并使用中控儀 SDK。2 隱私權(quán)說明本公司將本軟件程序的使用權(quán)予您，但您必須向本公司作出如：不在本協(xié)議規(guī)定的條款之外，使用、拷貝、修改、租賃或轉(zhuǎn)讓獲取其中的任一部分。3 系統(tǒng)需求1) 操作系統(tǒng)：Windows XP 及以上操作系統(tǒng)2) 適用開發(fā)語言 C+、C#、VB、Delphi 等4 安裝部署1) 安裝：安裝 ZKFinger SDK 5.x/ZKOnline SDK 5.x。5 SDK 接口說明5.1類型定義詳見 libzkfptype.h本 SDK 接口使用 stdcall.#ifdef _WIN32 #ifndef APICALL#define APICALL

5、 stdcall#endif5.1.1 常量1)模板最大長度定義#define MAX_TEMPLATE_SIZE 20481:1 閾值參數(shù)代碼2)4定義#define FP_THRESHOLD_CODE11:N 閾值參數(shù)代碼3)定義#define FP_MTHRESHOLD_CODE25.2接口說明5.2.1 ZKFPM_Init函數(shù)int APICALL ZKFPM_Init();功能初始化參數(shù)無返回值0 表示，首先調(diào)用此接口其他表示失敗(見附錄)5.2.2 ZKFPM_Terminate函數(shù)int APICALL ZKFPM_Terminate();功能參數(shù)無返回值0 表示其他表示失敗(

6、見附錄)5.2.3 ZKFPM_GetDeviceCount函數(shù)int APICALL ZKFPM_GetDeviceCount();功能獲取設(shè)備數(shù)參數(shù)無返回值>=0 表示設(shè)備數(shù)5<0表示調(diào)用失敗(見附錄)5.2.4 ZKFPM_OpenDevice函數(shù)HANDLE APICALL ZKFPM_OpenDevice(int index); 功能打開設(shè)備參數(shù)index設(shè)備索引返回設(shè)備操作實(shí)例句柄5.2.5 ZKFPM_CloseDevice函數(shù)int APICALL ZKFPM_CloseDevice(HANDLE hDevice);函數(shù)關(guān)閉設(shè)備參數(shù)hDevice設(shè)備操作實(shí)例句柄返回

7、值0 表示其他表示失敗(見附錄)5.2.6 ZKFPM_SetParameters函數(shù)int APICALL ZKFPM_SetParameters(HANDLE paramValue, unsigned int cbParamValue);功能hDevice,int nParamCode, unsigned char*設(shè)置參數(shù)hDevice器參數(shù)設(shè)備操作實(shí)例句柄nParamCode參數(shù)代碼(詳見參數(shù)代碼表) paramValue參數(shù)值6cbParamValue參數(shù)數(shù)據(jù)長度返回值0 表示其他表示失敗(見附錄) 其他5.2.7 ZKFPM_GetParameters函數(shù)int APICALL Z

8、KFPM_GetParameters(HANDLE paramValue, unsigned int* cbParamValue);功能獲取器參數(shù)參數(shù)hDevice設(shè)備操作實(shí)例句柄nParamCode參數(shù)代碼(詳見參數(shù)代碼表)paramValueout返回參數(shù)值hDevice,intnParamCode,unsignedchar*cbParamValuein/outin paramValue 分配內(nèi)存大小out 返回參數(shù)值數(shù)據(jù)大小返回值0 表示其他表示失敗(見附錄) 其他5.2.8 ZKFPM_AcquireFingerprint函數(shù)int APICALL ZKFPM_AcquireFinge

9、rprint(HANDLE hDevice, unsigned char* fpImage, unsigned int cbFPImage, unsigned char* fpTemplate, unsigned int* cbTemplate);功能，模板參數(shù)hDevice設(shè)備操作實(shí)例句柄fpImage out返回fpImage圖像fpTemplate 內(nèi)存大小7fpTemplate返回cbfpTemplateout模板in/outin, 預(yù)分配 fpTemplate 內(nèi)存大小，建議值 MAX_TEMPLATE_SIZE(2048)out,實(shí)際返回返回值0 表示其他表示失敗(見附錄) 其他模

10、板數(shù)據(jù)大小5.2.9 ZKFPM_AcquireFingerprintImage函數(shù)int APICALL ZKFPM_AcquireFingerprintImage(HANDLE unsigned int cbFPImage);功能圖像參數(shù)hDevice設(shè)備操作實(shí)例句柄fpImage outhDevice,unsignedchar*fpImage,返回cbFPImage圖像fpImage 內(nèi)存大小返回值0 表示其他表示失敗(見附錄) 其他5.2.10ZKFPM_DBInit函數(shù)HANDLE APICALL ZKFPM_DBInit();功能創(chuàng)建算法緩沖區(qū)參數(shù)無返回值緩沖區(qū)句柄85.2.11Z

11、KFPM_DBFree函數(shù)int APICALL ZKFPM_DBFree(HANDLE hDBCache);功能算法緩沖區(qū)參數(shù)緩沖區(qū)句柄返回值0 表示其他表示失敗(見附錄)5.2.12ZKFPM_DBMerge函數(shù)int APICALL ZKFPM_DBMerge(HANDLE hDBCache, unsigned char* temp1, unsigned char* temp2, unsigned char* temp3, unsigned char* regTemp, unsigned int* cbRegTemp) ;功能將 3 枚預(yù)登記模板合并為一枚登記參數(shù)hDBCache緩沖區(qū)句

12、柄temp1預(yù)登記temp2預(yù)登記temp3預(yù)登記regTempout登記模板模板 1模板 2模板 3cbRegTempin/outin, 預(yù)分配 fpTemplate 內(nèi)存大小，建議值 MAX_TEMPLATE_SIZE(2048)out,實(shí)際返回模板數(shù)據(jù)大小返回值0 表示其他表示失敗(見附錄)5.2.13ZKFPM_DBAdd函數(shù)int APICALL ZKFPM_DBAdd(HANDLE hDBCache, unsigned int fid, unsigned char* fpTemplate,unsigned int cbTemplate);9功能添加登記參數(shù)hDBCache模板到緩沖

13、區(qū)緩沖區(qū)句柄fidID（>0 的 32 位無符號(hào)整數(shù)）fpTemplate登記模板cbTemplate模板長度返回值0 表示其他表示失敗(見附錄)5.2.14ZKFPM_DBDel函數(shù)int APICALL ZKFPM_DBDel(HANDLE hDBCache, unsigned int fid);功能從緩沖區(qū)刪除指定ID 的登記模板參數(shù)hDBCache緩沖區(qū)句柄fidID返回值0 表示其他表示失敗(見附錄)5.2.15ZKFPM_DBClear函數(shù)int APICALL ZKFPM_DBClear(HANDLE hDBCache);功能清空緩沖區(qū)參數(shù)hDBCache緩沖區(qū)句柄返回值0

14、 表示其他表示失敗(見附錄)105.2.16ZKFPM_DBCount函數(shù)int APICALL ZKFPM_DBCount(HANDLE hDBCache, unsigned int* fpCount);功能獲取緩沖區(qū)參數(shù)hDBCache數(shù)緩沖區(qū)句柄fpCount out數(shù)返回值0 表示其他表示失敗(見附錄) 其他5.2.17ZKFPM_DBIdentify函數(shù)int APICALL ZKFPM_DBIdentify(HANDLE hDBCache, unsigned char* fpTemplate, unsigned int cbTemplate, unsigned int* FID,

15、unsigned int* score);功能1:N 識(shí)別參數(shù)hDBCache緩沖區(qū)句柄fpTemplate模板cbfpTemplate模板數(shù)據(jù)長度FID out返回ScoreIDout返回比對(duì)分?jǐn)?shù)返回值0 表示其他表示失敗(見附錄)5.2.18ZKFPM_DBMatch函數(shù)11int APICALL ZKFPM_DBMatch(HANDLE hDBCache, unsigned char* fpTemplate1, unsigned int cbfpTemplate1, unsigned char* fpTemplate2, unsigned int cbfpTemplate2);功能比對(duì)兩

16、枚參數(shù)hDBCache是否匹配緩沖區(qū)句柄fpTemplate1模板 1 cbfpTemplate1模板 1 數(shù)據(jù)長度fpTemplate2模板 2 cbfpTemplate2模板 2 數(shù)據(jù)長度返回值>=0 比對(duì)分?jǐn)?shù)<0 錯(cuò)誤 (見附錄)5.2.19ZKFPM_ExtractFromImage函數(shù)ZKINTERFACE int APICALL ZKFPM_ExtractFromImage(HANDLEhDBCache,const char*lpFilePathName, unsigned int DPI, unsigned char* fpTemplate, unsigned int

17、 *cbTemplate);功能從 BMP、JPG 文件提取模板參數(shù)hDBCache緩沖區(qū)句柄lpFilePathName文件全路徑DPI圖像 DPI fpTemplate模板cbfpTemplate模板 1 數(shù)據(jù)長度返回值0 表示其他表示失敗(見附錄) 其他僅標(biāo)準(zhǔn)版支持該功能125.2.20ZKFPM_Base64ToBlob函數(shù)ZKINTERFACE int APICALL ZKFPM_Base64ToBlob(const char* src, unsigned char* blob, unsigned int cbBlob);功能Base64 字符串轉(zhuǎn)字節(jié)流參數(shù)srcBase64 字符串

18、blob字節(jié)流指針cbBlob字節(jié)流長度返回值0 表示其他表示失敗(見附錄) 其他5.2.21ZKFPM_BlobToBase64函數(shù)ZKINTERFACE int APICALL ZKFPM_BlobToBase64(const unsigned char* src, unsigned int cbSrc, char* base64Str, unsigned int cbBase64str);功能字節(jié)流轉(zhuǎn) Base64 字符串參數(shù)src字節(jié)流cbSrc字節(jié)流數(shù)據(jù)長度base64Str字符串緩沖區(qū)cbBase64str字符串緩沖區(qū)長度返回值0 表示其他表示失敗(見附錄) 其他135.2.22Z

19、KFPM_GetTemplateQuality函數(shù)ZKINTERFACE int APICALL ZKFPM_GetTemplateQuality(HANDLE char* fpTemplate, int cbFPTemplate);功能獲取模板質(zhì)量參數(shù)hDevice設(shè)備句柄fpTemplate模板數(shù)據(jù)cbFPTemplate模板長度返回值模板質(zhì)量hDevice,unsigned5.2.23ZKFPM_DBSetParameter函數(shù)ZKINTERFACE int APICALL ZKFPM_DBSetParameter(HANDLE hDBCache, int nParamCode, int paramValue);功能設(shè)置算法參數(shù)(閾值) 參數(shù)hDBCache緩沖區(qū)句柄nParamCode參數(shù)代碼(nParamCode=1, 1:1 閾值，默認(rèn) 35；nParamCode=2, 1:N 閾值，默認(rèn)55)paramValue0100返回值0 表示其他表示失敗(見附錄)146 附錄6.1附錄 1常用參數(shù)代碼表6.2附錄 2錯(cuò)誤返回值描述15參數(shù)代碼屬性數(shù)據(jù)類型描述1只讀Int圖像寬2只讀Int圖像高3讀寫(目前只有LIVEID2