中控门禁类岳阳zkfinger reader sdk v

1、中控仪SDK 开发指南C API版本：2.1日期：2019 年 04 月1中控仪 SDK 开发指南Copyright ©ZKTeco Inc.2019s.Release history2日期版本备注2016 年 5 月 21 日1.0基础版2016 年 6 月 1 日1.1增加外部图像接口2016 年 9 月 17 日2.0更新为统一接口( 保留1.0 接口)2019 年 4 月 9 日2.1增加接口/参数说明目录1 概述42 隐私权说明43 系统需求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，在使用前请您先仔细阅读

4、本手册，以便您能更快地掌握并使用中控仪 SDK。2 隐私权说明本公司将本软件程序的使用权予您，但您必须向本公司作出如：不在本协议规定的条款之外，使用、拷贝、修改、租赁或转让获取其中的任一部分。3 系统需求1) 操作系统：Windows XP 及以上操作系统2) 适用开发语言 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 阈值参数代码2)4定义#define FP_THRESHOLD_CODE11:N 阈值参数代码3)定义#define FP_MTHRESHOLD_CODE25.2接口说明5.2.1 ZKFPM_Init函数int APICALL ZKFPM_Init();功能初始化参数无返回值0 表示，首先调用此接口其他表示失败(见附录)5.2.2 ZKFPM_Terminate函数int APICALL ZKFPM_Terminate();功能参数无返回值0 表示其他表示失败(

6、见附录)5.2.3 ZKFPM_GetDeviceCount函数int APICALL ZKFPM_GetDeviceCount();功能获取设备数参数无返回值>=0 表示设备数5<0表示调用失败(见附录)5.2.4 ZKFPM_OpenDevice函数HANDLE APICALL ZKFPM_OpenDevice(int index); 功能打开设备参数index设备索引返回设备操作实例句柄5.2.5 ZKFPM_CloseDevice函数int APICALL ZKFPM_CloseDevice(HANDLE hDevice);函数关闭设备参数hDevice设备操作实例句柄返回

7、值0 表示其他表示失败(见附录)5.2.6 ZKFPM_SetParameters函数int APICALL ZKFPM_SetParameters(HANDLE paramValue, unsigned int cbParamValue);功能hDevice,int nParamCode, unsigned char*设置参数hDevice器参数设备操作实例句柄nParamCode参数代码(详见参数代码表) paramValue参数值6cbParamValue参数数据长度返回值0 表示其他表示失败(见附录) 其他5.2.7 ZKFPM_GetParameters函数int APICALL Z

8、KFPM_GetParameters(HANDLE paramValue, unsigned int* cbParamValue);功能获取器参数参数hDevice设备操作实例句柄nParamCode参数代码(详见参数代码表)paramValueout返回参数值hDevice,intnParamCode,unsignedchar*cbParamValuein/outin paramValue 分配内存大小out 返回参数值数据大小返回值0 表示其他表示失败(见附录) 其他5.2.8 ZKFPM_AcquireFingerprint函数int APICALL ZKFPM_AcquireFinge

9、rprint(HANDLE hDevice, unsigned char* fpImage, unsigned int cbFPImage, unsigned char* fpTemplate, unsigned int* cbTemplate);功能，模板参数hDevice设备操作实例句柄fpImage out返回fpImage图像fpTemplate 内存大小7fpTemplate返回cbfpTemplateout模板in/outin, 预分配 fpTemplate 内存大小，建议值 MAX_TEMPLATE_SIZE(2048)out,实际返回返回值0 表示其他表示失败(见附录) 其他模

10、板数据大小5.2.9 ZKFPM_AcquireFingerprintImage函数int APICALL ZKFPM_AcquireFingerprintImage(HANDLE unsigned int cbFPImage);功能图像参数hDevice设备操作实例句柄fpImage outhDevice,unsignedchar*fpImage,返回cbFPImage图像fpImage 内存大小返回值0 表示其他表示失败(见附录) 其他5.2.10ZKFPM_DBInit函数HANDLE APICALL ZKFPM_DBInit();功能创建算法缓冲区参数无返回值缓冲区句柄85.2.11Z

11、KFPM_DBFree函数int APICALL ZKFPM_DBFree(HANDLE hDBCache);功能算法缓冲区参数缓冲区句柄返回值0 表示其他表示失败(见附录)5.2.12ZKFPM_DBMerge函数int APICALL ZKFPM_DBMerge(HANDLE hDBCache, unsigned char* temp1, unsigned char* temp2, unsigned char* temp3, unsigned char* regTemp, unsigned int* cbRegTemp) ;功能将 3 枚预登记模板合并为一枚登记参数hDBCache缓冲区句

12、柄temp1预登记temp2预登记temp3预登记regTempout登记模板模板 1模板 2模板 3cbRegTempin/outin, 预分配 fpTemplate 内存大小，建议值 MAX_TEMPLATE_SIZE(2048)out,实际返回模板数据大小返回值0 表示其他表示失败(见附录)5.2.13ZKFPM_DBAdd函数int APICALL ZKFPM_DBAdd(HANDLE hDBCache, unsigned int fid, unsigned char* fpTemplate,unsigned int cbTemplate);9功能添加登记参数hDBCache模板到缓冲

13、区缓冲区句柄fidID（>0 的 32 位无符号整数）fpTemplate登记模板cbTemplate模板长度返回值0 表示其他表示失败(见附录)5.2.14ZKFPM_DBDel函数int APICALL ZKFPM_DBDel(HANDLE hDBCache, unsigned int fid);功能从缓冲区删除指定ID 的登记模板参数hDBCache缓冲区句柄fidID返回值0 表示其他表示失败(见附录)5.2.15ZKFPM_DBClear函数int APICALL ZKFPM_DBClear(HANDLE hDBCache);功能清空缓冲区参数hDBCache缓冲区句柄返回值0

14、 表示其他表示失败(见附录)105.2.16ZKFPM_DBCount函数int APICALL ZKFPM_DBCount(HANDLE hDBCache, unsigned int* fpCount);功能获取缓冲区参数hDBCache数缓冲区句柄fpCount out数返回值0 表示其他表示失败(见附录) 其他5.2.17ZKFPM_DBIdentify函数int APICALL ZKFPM_DBIdentify(HANDLE hDBCache, unsigned char* fpTemplate, unsigned int cbTemplate, unsigned int* FID,

15、unsigned int* score);功能1:N 识别参数hDBCache缓冲区句柄fpTemplate模板cbfpTemplate模板数据长度FID out返回ScoreIDout返回比对分数返回值0 表示其他表示失败(见附录)5.2.18ZKFPM_DBMatch函数11int APICALL ZKFPM_DBMatch(HANDLE hDBCache, unsigned char* fpTemplate1, unsigned int cbfpTemplate1, unsigned char* fpTemplate2, unsigned int cbfpTemplate2);功能比对两

16、枚参数hDBCache是否匹配缓冲区句柄fpTemplate1模板 1 cbfpTemplate1模板 1 数据长度fpTemplate2模板 2 cbfpTemplate2模板 2 数据长度返回值>=0 比对分数<0 错误 (见附录)5.2.19ZKFPM_ExtractFromImage函数ZKINTERFACE int APICALL ZKFPM_ExtractFromImage(HANDLEhDBCache,const char*lpFilePathName, unsigned int DPI, unsigned char* fpTemplate, unsigned int

17、 *cbTemplate);功能从 BMP、JPG 文件提取模板参数hDBCache缓冲区句柄lpFilePathName文件全路径DPI图像 DPI fpTemplate模板cbfpTemplate模板 1 数据长度返回值0 表示其他表示失败(见附录) 其他仅标准版支持该功能125.2.20ZKFPM_Base64ToBlob函数ZKINTERFACE int APICALL ZKFPM_Base64ToBlob(const char* src, unsigned char* blob, unsigned int cbBlob);功能Base64 字符串转字节流参数srcBase64 字符串

18、blob字节流指针cbBlob字节流长度返回值0 表示其他表示失败(见附录) 其他5.2.21ZKFPM_BlobToBase64函数ZKINTERFACE int APICALL ZKFPM_BlobToBase64(const unsigned char* src, unsigned int cbSrc, char* base64Str, unsigned int cbBase64str);功能字节流转 Base64 字符串参数src字节流cbSrc字节流数据长度base64Str字符串缓冲区cbBase64str字符串缓冲区长度返回值0 表示其他表示失败(见附录) 其他135.2.22Z

19、KFPM_GetTemplateQuality函数ZKINTERFACE int APICALL ZKFPM_GetTemplateQuality(HANDLE char* fpTemplate, int cbFPTemplate);功能获取模板质量参数hDevice设备句柄fpTemplate模板数据cbFPTemplate模板长度返回值模板质量hDevice,unsigned5.2.23ZKFPM_DBSetParameter函数ZKINTERFACE int APICALL ZKFPM_DBSetParameter(HANDLE hDBCache, int nParamCode, int paramValue);功能设置算法参数(阈值) 参数hDBCache缓冲区句柄nParamCode参数代码(nParamCode=1, 1:1 阈值，默认 35；nParamCode=2, 1:N 阈值，默认55)paramValue0100返回值0 表示其他表示失败(见附录)146 附录6.1附录 1常用参数代码表6.2附录 2错误返回值描述15参数代码属性数据类型描述1只读Int图像宽2只读Int图像高3读写(目前只有LIVEID2