代证终端API使用说明.docVIP

二代证系统终端API 使用说明最新07/1/1 上海普天邮通科技股份有限公司 2007年01月 二代证系统终端API 使用说明 版　本 出版日期 2007年01月 著作权注意事项 　　本书版权为上海普天邮通科技股份有限公司所有。未经上海普天邮通科技股份有限公司书面同意，任何公司、单位或个人，不得用任何手段复制本手册的部分或全部内容。 对印刷错误的更正，所述信息谬误的勘误，以及产品的改进，均由上海邮电通信设备股份有限公司随时作出解释，恕不预先通知，修正内容将编入再版说明书中。 1.前言 本应用程序接口(API)用于二代证验证系统的验证终端应用系统的开发。 2.系统要求 使用本API的PC机，必须满足下列条件： Windows 98，Windows 2000 Pro,Windows 2000 Server,WinXP 至少32兆内存（32M RAM or Larger） 至少10兆空闲硬盘空间（10M Free Hard Disk Space or Larger） 至少一个空闲普通串口或USB口（视用户需求而定）。 3.API列表 应用函数开发包含下列文件： cardapi.lib API函数的VC开发包 cardapi.h API函数声明 cardapi.dll API函数的动态联接库 stdapi.dll cardapi.dll的依赖动态联接库 WltRS.dll cardapi.dll的依赖动态联接库 序号 函数名 功能描述 checkCardReaderValid 检查读卡器是否可以正常工作 getImagePath 获取保存照片文件的路径 getPersonMsg 获取身份证的基本信息 getNewAddress 获取更新地址信息 resetCardReader 复位读卡器 4.API详细说明 4.1 checkCardReaderValid 检查读卡器是否可以正常工作。 char* checkCardReaderValid (int iPort); 参数说明： int iPort 0为自动检测 1-16为串口1-16口 1001-1016为USB1-16口 返回值：字符串 第一个字符为’1’，表示读卡器可以正常工作； 第一个字符为’0’，表示检测失败； 第一个字符后紧接检测成功或失败的中文描述。 4.2 getImagePath 从card.ini中获取获取保存照片文件的路径。 char* getImagePath (); 参数说明：无 返回值：字符串 保存照片文件目录的路径。 4.3 getPersonMsg 读取身份证的基本信息。 char* getPersonMsg (int iPort); 参数说明： int iPort 0为自动检测 1-16为串口1-16口 1001-1016为USB1-16口 返回值：字符串 第一个字符为’1’，表示成功获取到身份证信息，其后紧接身份证信息； 第一个字符为’0’，表示获取身份证信息失败，其后紧接失败原因的中文描述； 身份证信息包括：姓名|性别|民族|出生年月(格式为YYYY-MM-DD)|身份证号码|地址|签发机构|有效起始时间（YYYY-MM-DD）|有效终止时间（YYYY-MM-DD或长期），信息项以字符’|’分隔。 4.4 getNewAddress 读取更新地址信息。 char* getNewAddress (int iPort); 参数说明： int iPort 0为自动检测 1-16为串口1-16口 1001-1016为USB1-16口 返回值：字符串 第一个字符为’1’，表示成功获取到更新地址信息，其后紧接地址信息； 第一个字符为’0’，表示获取更新地址信息失败，其后紧接失败原因的中文描述； 4.5 resetCardReader 复位读卡器。当身份证停留在身份证读卡器的有效阅读范围，此时而需要连续读取身份证信息或更新地址信息，则需要在两次读取操作之间插入复位操作。 Void resetCardReader (int iPort); 参数说明： int iPort 0为自动检测 1-16为串口1-16口 1001-1016为USB1-16口返回值：无 5.API调用说明 5.1 API调用顺序 请首先调用检测读卡器接口checkCardReaderValid ()，读卡器接口会自动检测当前设备所指定的端口。成功后再调用读取身份证信息接口getPersonMsg()。 5.2