新中新身份证读卡器接口精编I使用手册.docx

1、新中新身份证读卡器接口精编I使用手册 Revised by Liu Jing on January 12, 2021新中新身份证读卡器接口精编I使用手册居民身份证验证读卡器接口API使用手册哈尔滨新中新电子股份有限公司2004年12月1端口类APIintSyn_OpenPort(intiPortID);说明:打开串口/USB口参数：iPortIDin整数，表示端口号。1-16（十进制）为串口，1001-1016（十进制）为USB口，缺省的一个USB设备端口号是1001。返回值：成功返回0，错误返回见6。intSyn_ClosePort(intiPortID);说明:关闭串口/USB口参数：iP

2、ortIDin整数，表示端口号。返回值：成功返回0，错误返回见6。intSyn_GetCOMBaud(intiComID,unsignedint*puiBaudRate);说明:查看串口的波特率参数：iPortin整数，表示端口号。此处端口号必须为1-16，表示串口，参见7.1。puiBaudRateout无符号整数指针，指向普通串口当前波特率,默认情况下为115200。返回值：成功返回0，错误返回见6。intSyn_SetCOMBaud(intiComID,unsignedintuiCurrBaud,unsignedintuiSetBaud);说明:设置串口的波特率参数：iPortin整数，

3、表示端口号。此处端口号必须为1-16，表示串口。uiCurrBaudin无符号整数，调用该API前已设置的业务终端与SAM_V通信的波特率(SAM_V出厂时默认,业务终端与SAM_V通信的波特率为115200)。业务终端以该波特率与SAM_V通信,发出设置SAM_V新波特率的命令。uiCurrBaud只能为下列数值之一：115200，57600，38400，19200，9600.如果uiCurrBaud数值不是这些值之一，函数返回0x21;如果已设置的波特率与uiCurrBaud不一致,则函数返回非零,表示不能设置,调用API不成功。uiSetBaudin符号整数，将要设置的SAM_V与业务终

4、端通信波特率。uiSetBaud只能取下列值之一:115200，57600，38400，19200，9600，如果输入uiSetBaud参数不是这些数值之一,函数返回非零,设置不成功,保持原来的波特率不变。返回值：成功返回0，错误返回见6。2.SAM类APIintSyn_GetSAMStatus(intiPortID,intiIfOpen);说明:对SAM_V进行状态检测参数：iPortin整数，表示端口号。参见7.1。iIfOpenin整数，参见7.2。返回值：成功返回0，错误返回见6。intSyn_ResetSAM(intiPortID,intiIfOpen);说明:对SAM_V复位参数：

5、iPortin整数，表示端口号。参见7.1。iIfOpenin整数，参见7.2。返回值：成功返回0，错误返回见6。intSyn_GetSAMID(intiPortID,unsignedchar*pucSAMID,intiIfOpen);说明:读取SAM_V的编号（十六进制）参数：iPortin整数，表示端口号。参见7.1。pucSAMIDout无符号字符串指针，SAM_V编号，16字节。iIfOpenin整数，参见7.2。返回值：成功返回0，错误返回见6。intSyn_GetSAMIDToStr(intiPortID,char*pcSAMID,intiIfOpen);说明:读取SAM_V的编号

6、（字符串格式）参数：iPortin整数，表示端口号。参见7.1。pcSAMIDout字符串指针，SAM_V编号。iIfOpenin整数，参见7.2。返回值：成功返回0，错误返回见6。3.身份证卡类APIintSyn_StartFindIDCard(intiPortID,unsignedchar*pucManaInfo,intiIfOpen);说明:开始找卡参数：iPortin整数，表示端口号。参见7.1。pucManaInfoout无符号字符指针，证/卡芯片管理号，4个字节。iIfOpenin整数，参见7.2。返回值：成功返回0，错误返回见6。intSyn_SelectIDCard(intiP

7、ortID,unsignedchar*pucManaMsg,intiIfOpen);说明:选卡参数：iPortin整数，表示端口号。参见7.1。pucManaMsgout无符号字符指针，证/卡芯片序列号，8个字节。iIfOpenin整数，参见7.2。返回值：成功返回0，错误返回见6。intSyn_ReadMsg(intiPortID,intiIfOpen,IDCardData*pIDCardData);说明:读取证/卡信息参数：iPortin整数，表示端口号。参见7.1。iIfOpenin整数，参见7.2。pIDCardDataoutIDCardData类型读出的数据，参见5。返回值：成功返回

8、0，错误返回见6。4.附加类APIintSyn_SendSound(intiCmdNo);说明:发送语音参数：iCmdNoin声音编号返回值：成功返回0，错误返回见6。voidSyn_DelPhotoFile();说明:删除临时照片文件参数：无返回值：成功返回0，错误返回见6。5.结构体声明typedefstructtagIDCardData charName32;/姓名 charSex4;/性别 charNation6;/名族 charBorn18;/出生日期 charAddress72;/住址 charIDCardNo38;/身份证号 charGrantDept32;/发证机关 charU

9、serLifeBegin18;/有效开始日期 charUserLifeEnd18;/有效截止日期 charreserved38;/保留 charPhotoFileName255;/照片路径IDCardData;6.函数返回值0操作成功或相片解码解码正确-1端口打开失败/端口尚未打开/端口号不合法-2证/卡中此项无内容-3PC接收超时，在规定的时间内未接收到规定长度的数据-4数据传输错误-5该SAM_V串口不可用，只在SDT_GetCOMBaud时才有可能返回-6接收业务终端数据的校验和错-7接收业务终端数据的长度错-8接收业务终端的命令错误，包括命令中的各种数值或逻辑搭配错误-9越权操作-10

10、无法识别的错误-11寻找证/卡失败-12选取证/卡失败-13调用sdtapi.dll错误-14相片解码错误-15授权文件不存在-16设备连接错误7.注意7.1系统支持的串行端口号：1-16,USB端口号：1001-10167.2iIfOpenin整数，0表示不在该函数内部打开和关闭串口，此时确保之前调用了Syn_OpenPort来打开端口，并且在不需要与端口通信时，调用Syn_ClosePort关闭端口；非0表示在API函数内部包含了打开端口和关闭端口函数，之前不需要调用Syn_OpenPort，也不用再调用Syn_ClosePort。7.3普通开发中只使用“端口类API”与“身份证卡类API

11、”与“附加类API”就能满足开发需要,使用方法见第10部分实例。7.4在使用Syn_SendSound函数时请先用Syn_ClosePort函数关闭打开的端口。7.5SDK包包含文件Syn_IDCardRead.dll、Syn_IDCardRead.lib、Syn_IDCardRead.h、sdtapi.dll、WltRS.dll8声音命令暂时未定1读身份证成功9.Syn_IDCardRead.h头文件:#ifdef_WIN32#defineSTDCALL_stdcall#else#defineSTDCALL#endif#ifndefSDTAPI_#defineSDTAPI_#ifdef_cp

12、lusplusexternC#endif#pragmapack(1)typedefstructtagIDCardData charName32; charSex4; charNation6; charBorn18; charAddress72; charIDCardNo38; charGrantDept32; charUserLifeBegin18; charUserLifeEnd18; charreserved38; charPhotoFileName255;IDCardData;#pragmapack()/*端口类API*/intSTDCALLSyn_GetCOMBaud(intiComI

13、D,unsignedint*puiBaud);intSTDCALLSyn_SetCOMBaud(intiComID,unsignedintuiCurrBaud,unsignedintuiSetBaud);intSTDCALLSyn_OpenPort(intiPortID);intSTDCALLSyn_ClosePort(intiPortID);/*SAM类API*/intSTDCALLSyn_GetSAMStatus(intiPortID,intiIfOpen);intSTDCALLSyn_ResetSAM(intiPortID,intiIfOpen);intSTDCALLSyn_GetSAM

14、ID(intiPortID,unsignedchar*pucSAMID,intiIfOpen);intSTDCALLSyn_GetSAMIDToStr(intiPortID,char*pcSAMID,intiIfOpen);/*身份证卡类API*/intSTDCALLSyn_StartFindIDCard(intiPortID,unsignedchar*pucManaInfo,intiIfOpen);intSTDCALLSyn_SelectIDCard(intiPortID,unsignedchar*pucManaMsg,intiIfOpen);intSTDCALLSyn_ReadMsg(in

15、tiPortID,intiIfOpen,IDCardData*pIDCardData);/*附加类API*/intSTDCALLSyn_SendSound(intiCmdNo);voidSTDCALLSyn_DelPhotoFile();#ifdef_cplusplus#endif#endif10.调用实例：10.1vc6.0调试通过voidCSampleDlg:OnButton1() /TODO:Addyourcontrolnotificationhandlercodehere intifOpen;intiPort;intiRet;unsignedcharpucIIN4;unsignedch

16、arpucSN8; IDCardDataCardMsg;ifOpen=0;/是否需要打开串口iPort=1; iRet=Syn_OpenPort(iPort); if(iRet=0) iRet=Syn_StartFindIDCard(iPort,pucIIN,ifOpen); if(iRet=0) iRet=Syn_SelectIDCard(iPort,pucSN,ifOpen); if(iRet=0) iRet=Syn_ReadMsg(iPort,0,&CardMsg); if(iRet=0) /显示读出的信息 UpdateData(true); m_name=CardMsg.Name; U

17、pdateData(false); Syn_SendSound(0); Syn_DelPhotoFile(); Syn_ClosePort(iPort);10.2delphi7.0调试通过首先将Syn_IDCardRead.h翻译为Delphi格式。procedureTForm1.Button4Click(Sender:TObject);varifOpen:integer;iPort:integer;iRet:integer;pucIIN:array0.3ofByte;pucSN:array0.7ofByte;CardMsg:TCard;beginIfOpen:=0;/是否需要打开串口iPor

18、t:=1;iRet:=Syn_OpenPort(iPort);ifiRet0thenbeginSyn_ClosePort(iPort);Exit;end;iRet:=Syn_StartFindIDCard(iPort,pucIIN,IfOpen);ifiRet=0thenbeginiRet:=Syn_SelectIDCard(iPort,pucSN,IfOpen); ifiRet=0thenbeginiRet:=Syn_ReadMsg(iPort,0,CardMsg);ifiRet=0thenbeginlabel1.Caption:=trim(CardMsg.Name);label2.Capt

19、ion:=trim(CardMsg.Sex);label3.Caption:=trim(CardMsg.Nation);label4.Caption:=trim(CardMsg.Born);label5.Caption:=trim(CardMsg.Address);label6.Caption:=trim(CardMsg.IDCardNo);label7.Caption:=trim(CardMsg.GrantDept);label8.Caption:=trim(CardMsg.UserLifeBegin);label9.Caption:=trim(CardMsg.UserLifeEnd);label10.Caption:=trim(CardMsg.reserved);:=True;:=Syn_SendSound(0);Syn_DelPhotoFile;end;end;end;Syn_ClosePort(iPort);end;