OCX接口说明V4

1.概述

精伦电子股份有限公司开发的二代身份证读卡系列机具适用于相关行业的联机型应用。产品提供了完善的二次软件开发接口（API）。本手册针对提供的ActiveX控件，对开发接口的文件组成、方法定义格式、调用方法及返回值等进行了详细的说明。

2.接口文件说明

接口文件包括：

IdrControl.ocx

Dewlt.dll

Savephoto.dll

Wltrs.dll

适用开发语言：

网络脚本开发

第一次使用时，需要以管理员身份运行SetupOCX.exe对控件进行安装注册。

更新说明：

V4.0.1.0增加对编码设备支持，可设置日志文件。

V4.0.0.6增加RepeatRead 方法，可设置后进行连续读身份证。

V4.0.0.0增加对210-P的支持。

V3.4.1.4解决和13002相关在20130726的读卡体管理号问题。

V3.4.1.3解决一个潜在导致内存泄漏的问题。

V3.4.1.2增加GetCardPhotobuf方法，用于获取身份证正反面图片JPG格式Base64编码信息。

V3.4.1.0增加ExportPhoto方法，可在读卡结束后生成指定照片和卡图片文件名。

3.接口方法说明

3.1. 身份证方法

3.1.1.读身份证方法

原型：short ReadCard(long iPort,BSTR PhotoPath)

说明：本方法将打开端口、找卡、读卡等功能进行了集成，可用于打开串口或USB口并读取二代证卡内信息。

参数：

1、iPort：设置串口、USB或iDR210免驱动USB-HID。

普通串口 1 – 16(十进制) 例如：

1：串口1(COM1)

2：串口2(COM2)

USB USB-HID (iDR210) 1001 例如：

1001：USB

2、PhotoPath：生成图片文件的绝对路径，包括生成的照片文件photo.bmp,photo.jpg和指定文件名的照片文件，和身份证正反面图片card.jpg。该参数为""时，默认将照片文件保存到Windows系统临时文件目录(GetTempPath())。也可自行设置保存的路径，比如："d:\\photos\\photo.bmp"，注意文件参数必须设置正确，才能正确地将相片文件放在指定位置(相片文件夹若不存在，将会自动生成新文件夹)。

返回值：

值说明

1 正确

-1 端口初始化失败

-2 卡认证失败（请重新将

卡放到读卡器）

-3 读取数据失败

-4 生成照片文件失败（请

检查设定路径和磁盘空

间）

注：如果读卡机具连接的端口是确定的，可以直接使用相应端口号调用本方法。否则，可以采用循环查找的方式调用本方法。

3.1.2.端口初始化方法

原型：short InitComm(long iPort)

说明：本方法用于打开串口或USB并检测读卡设备是否就绪。

参数：iPort：设置串口或USB（目前串口和USB都只支持16个，即串口1～16和USB1001-1016）

普通串口 1 – 16(十进制) 例如：

1：串口1(COM1)

2：串口2(COM2)

USB USB-HID (iDR210) 1001 例如：

1001：USB

返回值：

值意义

1 正确

其它错误

注：如果读卡机具连接的端口是确定的，可以直接使用相应端口号调用本方法。否则，可以采用循环查找的方式调用本方法。

3.1.3.端口关闭接口

原型：int CloseComm(void)

说明：本方法用于关闭已打开的端口，一般在调用InitComm成功并完成读卡任务后调用。

参数：无

返回值：

值意义

1 正确

其它错误

3.1.

4.卡认证接口

原型：short Authenticate (void)

说明：本方法用于发现身份证卡并选择卡。

参数：无

返回值：

值意义

1 正确

0 错误

注：认证卡时，需要将身份证放置于读卡机具上方并做稍许时间的停留。如果方法返回错误表示没有发现卡或者卡停留时间太短。

3.1.5.读卡信息接口

原型：short ReadBaseMsg()；

说明：本函数用于读取卡中基本信息，包括文字信息与图像信息。

返回值：

值意义

1 正确

-1 错误，缺少照片解码

DLL库文件

-2 生成wlt文件错

-4 读基本信息错

-5 照片解码错

注：读卡基本信息时，需要将身份证置于读卡机具上方做稍许时间的停留。调用返回正确后，可进行下一步获取身份证个人姓名、性别等信息获取调用，照片文件photo.bmp放置在当前系统的临时文件目录（GetTempPath()）。

3.1.6.读卡信息并设定照片文件接口

原型：short ReadBaseMsgP(BSTR photopath)；

说明：本函数用于读取卡中基本信息，包括文字信息与图像信息。

参数：BSTR photopath 放置照片信息绝对路径名

返回值：

值意义

1 正确

-1 缺少照片解码DLL库

文件

-2 生成wlt文件错

-3 照片文件名错

-4 读基本信息错

-5 照片解码错

-6 缺少生成正反面图片

DLL库文件

-7 生成正反面图片错

注：和ReadBaseMsg功能相仿(读卡实现中两个函数只需调用一个)，参数为相片信息文件绝对路径名，可根据开发人员需要放置相片为指定目录文件，如"d:\\photos\\photo.bmp"，注意文件参数必须设置正确，才能正确地将相片文件放在指定位置(相片文件夹若不存在，将会自动生成新文件夹)

3.1.7.获得身份证信息个人姓名

原型：BSTR GetName()；

说明：本方法用于获取身份证个人姓名信息。

返回值：个人姓名信息

注：必须在读卡方法或读卡信息方法调用并返回正确的情况下方能正确获得身份证个人姓名信息