(新中新)二代证SDK开发包开发说明.doc

（新中新）二代证SDK开发包开发说明一、 系统的基本要求a) Windows 98，Windows 2000 Pro,Windows 2000 Server,WinXP，Windows Vista，Windows7b) 至少32兆内存（32M RAM or Larger）c) 至少10兆空闲硬盘空间（10M Free Hard Disk Space or Larger）d) 至少一个空闲普通串口或USB口（视用户需求而定）。二、 SDK函数说明（一）端口类API：Syn_SetMaxRFByte 设置射频适配器最大通信字节数int Syn_SetMaxRFByte (int iPort, unsigned charucByte,int bIfOpen );参数说明：iPortin 整数，表示端口号。串口0001至0016，USB1001至1016ucBytein 无符号字符，24-255，表示射频适配器最大通信字节数。iIfOpenin 整数，非0表示在API函数内部包含了打开端口和关闭端口函数，0表示在API函数内部不包含了打开端口和关闭端口函数返回值：0成功其他失败（具体含义参见返回码表）Syn_GetCOMBaud 查看串口当前波特率(该函数只用于SAM采用RS232串口的情形，如果采用USB接口则不支持该API)。int Syn_GetCOMBaud (int iPort, unsigned int * puiBaudRate);参数说明：iPortin 整数，表示端口号。此处端口号必须为1-16，表示串口puiBaudRateout 无符号整数指针，指向普通串口当前波特率, 默认情况下为115200。返回值：0成功0X01端口打开失败/端口号不合法0X05无法获得该SAM的波特率，该SAM串口不可用。Syn_GetCOMBaudEx 查看串口当前波特率(该函数只用于SAM采用RS232串口的情形，如果采用USB接口则不支持该API)。int Syn_GetCOMBaudEx (int iPort, );参数说明：iPortin 整数，表示端口号。此处端口号必须为1-16，表示串口返回值：0失败 其他为读卡器当前波特率Syn_SetCOMBaud 设置SAM的串口的波特率(该函数只用于SAM采用RS232串口的情形，如果采用USB接口则不支持该API)，设置成功后，在该SAM和主机注册表中都记录设置后的波特率，保证在SAM重新启动和该套API被重新调用时采用设置后的波特率。该函数调用成功后，需要延时5毫秒，然后才能继续与SAM通信。int Syn_SetCOMBaud (int iPort, unsigned intuiCurrBaud,unsigned int uiSetBaud);参数说明：iPortin 整数，表示端口号。此处端口号必须为1-16，表示串口。uiCurrBaudin 无符号整数，调用该API前已设置的业务终端与SAM通信的波特率(SAM出厂时默认,业务终端与SAM通信的波特率为115200).业务终端以该波特率与SAM通信,发出设置SAM新波特率的命令.。uiCurrBaud只能为下列数值之一：115200，57600，38400，19200，9600.如果uiCurrBaud数值不是这些值之一，函数返回0X21;如果已设置的波特率与uiCurrBaud不一致, 则函数返回0X02,表示不能设置,调用API不成功。uiSetBaudin 无符号整数，将要设置的SAM与业务终端通信波特率。uiSetBaud只能取下列值之一:：115200，57600，38400，19200，9600，如果输入uiSetBaud参数不是这些数值之一,，函数返回0X21,设置不成功,保持原来的波特率不变。返回值：0成功0X01端口打开失败/端口号不合法。0X02超时，设置不成功。0X21uiCurrBaud 、uiSetBaud输入参数数值错误。Syn_OpenPort 打开端口int Syn_OpenPort(int iPort );参数说明：iPortin 整数，表示端口号。1-16（十进制）为串口，1001-1016（十进制）为USB口，USB的端口设置参看“USB设备配置使用手册”。返回值：0打开端口成功0X01打开端口失败/端口号不合法Syn_ClosePort 关闭端口int Syn_ClosePort (int iPort);参数说明：iPortin 整数，表示端口号。返回值：0关闭端口成功。0x01端口号不合法（二）SAM类API：Syn_ResetSAM对SAM复位int Syn_ResetSAM (int iPort,intiIfOpen);参数说明：iPortin 整数，表示端口号。根据SAM使用的接口不同(分为普通串口SAM和USB口SAM)，分别使用不同的端口号（目前串口和USB都只支持16个，即串口0001-0016和USB1001-1016）：普通串口SAM0001 0016(十进制)例如：0001：串口1(COM1)0002：串口2(COM2)USB口SAM1001 1016(十进制)例如：1001：USB11002：USB2iIfOpenin 整数，0表示不在该函数内部打开和关闭串口，此时确保之前调用了Syn_OpenPort来打开端口，并且在不需要与端口通信时，调用Syn_ClosePort关闭端口；非0表示在API函数内部包含了打开端口和关闭端口函数，之前不需要调用Syn_OpenPort，也不用再调用Syn_ClosePort。返回值：0成功其他失败（具体含义参见返回码表）Syn_GetSAMStatus 对SAM进行状态检测。int Syn_GetSAMStatus (int iPort,intiIfOpen);参数说明：iPortin 整数，表示端口号。参见Syn_ResetSAM。iIfOpenin 整数，参见Syn_ResetSAM。返回值：0SAM正常0x60自检失败，不能接收命令其他命令失败（具体含义参见返回码表）Syn_GetSAMID 读取SAM的编号。int Syn_GetSAMID (int iPort,unsigned char *pucSAMID,intiIfOpen);参数说明：iPortin 整数，表示端口号。参见Syn_ResetSAM。pucSAMIDout 无符号字符串指针，指向读到的SAM编号， 16字节。返回值：0成功其他失败（具体含义参见返回码表）Syn_GetSAMIDToStr 读取SAM的编号。int Syn_GetSAMIDToStr (int iPort,char *pcSAMID，intiIfOpen);参数说明：iPortin 整数，表示端口号。参见Syn_ResetSAM。pcSAMIDout 字符串指针，指向读到的SAM编号。iIfOpenin 整数，参见Syn_ResetSAM。返回值：0成功其他失败（具体含义参见返回码表）Syn_FindReader 自动寻找读卡器。int Syn_FindReader ();返回值：0未找到其他116串口10011016USB（三）身份证卡类API：Syn_StartFindIDCard 开始找卡。int Syn_StartFindIDCard (int iPort ,unsigned char *pucIIN,intiIfOpen);参数说明：iPortin 整数，表示端口号。参见Syn_ResetSAM。pucIINout 无符号字符指针，指向读到的IIN。iIfOpenin 整数，参见Syn_ResetSAM。返回值：0找卡成功0x80找卡失败Syn_SelectIDCard 选卡。int Syn_ SelectIDCard (int iPort ,unsigned char *pucSN,intiIfOpen);参数说明：iPortin 整数，表示端口号。参见Syn_ResetSAM。pucSNout 无符号字符指针，指向读到的SN。iIfOpenin 整数，参见Syn_ResetSAM。返回值：0选卡成功0x81选卡失败Syn_ReadBaseMsg 读取ID卡内基本信息区域信息。int Syn_ReadBaseMsg (int iPort，unsigned char * pucCHMsg，unsigned int *puiCHMsgLen， unsigned char * pucPHMsg，unsigned int *puiPHMsgLen,intiIfOpen);参数说明：iPortin 整数，表示端口号。参见Syn_ResetSAM。pucCHMsgout 无符号字符指针，指向读到的文字信息。puiCHMsgLenout 无符号整型数指针，指向读到的文字信息长度。pucPHMsgout 无符号字符指针，指向读到的照片信息。puiPHMsgLenout 无符号整型数指针，指向读到的照片信息长度。iIfOpenin 整数，参见Syn_ResetSAM。返回值：0读基本信息成功其他读基本信息失败（具体含义参见返回码表）Syn_ReadIINSNDN 读取ID卡内IIN,SN和DN。int Syn_ReadIINSNDN (int iPort，unsigned char * pucIINSNDN,intiIfOpen);参数说明：iPortin 整数，表示端口号。参见Syn_ResetSAM。pucIINSNDNout 无符号字符指针，指向读到的IIN,SN和DN,长度为固定28字节。iIfOpenin 整数，参见Syn_ResetSAM。返回值：0读IIN,SN和DN成功其他读IIN,SN和DN失败（具体含义参见返回码表）Syn_ReadBaseMsgToFile 与Syn_ ReadBaseMsg函数类似，读取ID卡内基本信息区域信息，并将读到的基本信息写进输入参数所指定的文件中。int Syn_ ReadBaseMsgToFile (int iPortID,char * pcCHMsgFileName,unsigned int *puiCHMsgFileLen,char * pcPHMsgFileName,unsigned int *puiPHMsgFileLen,intiIfOpen);参数说明：iPortin 整数，表示端口号。参见Syn_ResetSAM。pcCHMsgFileNamein 读取到的ID卡内文字信息,需要写入文件，此为由用户指定的文件名。puiCHMsgFileLenout 存储文字信息的文件的长度。pcCHMsgFileNamein 读取到的ID卡内照片信息,需要写入文件，此为由用户指定的文件名。puiCHMsgFileLenout 存储照片信息的文件的长度。iIfOpenin 整数，参见Syn_ResetSAM。返回值：0读基本信息成功其他读基本信息失败（具体含义参见返回码表）Syn_ReadIINSNDNToASCII 读取ID卡内IIN,SN和DN，并把16进制转化成ASCII形式。int Syn_ReadIINSNDNToASCII (int iPort，unsigned char * pucIINSNDN,intiIfOpen);参数说明：iPortin 整数，表示端口号。参见Syn_ResetSAM。pucIINSNDNout 无符号字符指针，指向读到的IIN,SN和DN,长度为固定56字节。iIfOpenin 整数，参见Syn_ResetSAM。返回值：0读SN和DN成功其他读SN和DN失败（具体含义参见返回码表）举例说明：如读取到的IIN,SN和DN十六进制是0x12, 0x9a，把每个字节拆分成两个ASCII形式的数，转化成后则为0x31,0x32,0x39,0x61。Syn_GetBmp本函数用于将wlt文件解码成bmp文件。int Syn_GetBmp(char * Wlt_File,int intf)；参数说明：Wlt_File in 字符指针。wlt文件名intf in阅读设备通讯接口类型（1RS-232C，2USB）返回值：值意义1相片解码解码正确0调用sdtapi.dll错误-1相片解码错误-2wlt文件后缀错误-3wlt文件打开错误-4wlt文件格式错误-5软件未授权-6设备连接错误（四）其他设置类APISyn_SetPhotoPath 本函数用于设置照片文件存储的路径int Syn_SetPhotoPath(int iOptionchar * cPhotopath);参数说明：iOptionin 整形，0=C:根目录，1=当前路径，2=指定路径cPhotoPathin 字符指针。路径名返回值：0 成功-1不成功Syn_SetPhotoType 本函数用于设置照片文件存储的格式int Syn_SetPhotoType(int iType);参数说明：iTypein 整形。1=bmp ， 2=jpeg，3=base64返回值：0 成功-1不成功Syn_SetPhotoName 本函数用于设置照片文件的文件名int Syn_SetPhotoName(int iType);参数说明：iTypein 整形。0=tmp ， 1=姓名，2=身份证号，3=姓名_身份证号返回值：0 成功-1不成功Syn_SetSexType 本函数用于设置返回性别的格式int Syn_SetSexType(int iType);参数说明：iTypein 整形。0=卡内存储的数据， 1=解释之后的数据返回值：0 成功-1不成功Syn_SetNationType 本函数用于设置返回民族的格式int Syn_SetNationType(int iType);参数说明：iTypein 整形。0=卡内存储的数据 ， 1=解释之后的数据，2=解释之后+“族”返回值：0 成功-1不成功Syn_SetBornType 本函数用于设置返回出生日期的格式int Syn_SetBornType(int iType);参数说明：iTypein 整形。0=YYYYMMDD,1=YYYY年MM月DD日,2=YYYY.MM.DD,3=YYYY-MM-DD,4=YYYY/MM/DD返回值：0 成功-1不成功Syn_SetUserLifeBType 本函数用于设置返回有效期开始日期的格式int Syn_SetUserLifeBType(int iType);参数说明：iTypein 整形。0=YYYYMMDD,1=YYYY年MM月DD日,2=YYYY.MM.DD,3=YYYY-MM-DD,4=YYYY/MM/DD返回值：0 成功-1不成功Syn_SetUserLifeEType 本函数用于设置返回有效期结束日期的格式int Syn_SetUserLifeEType(int iType；int iOption);参数说明：iTypein 整形。0=YYYYMMDD,1=YYYY年MM月DD日,2=YYYY.MM.DD,3=YYYY-MM-DD,4=YYYY/MM/DDiOptionin 整形。0=长期不转换 1=长期转换为 有效期开始加50年返回值：0 成功-1不成功三、 OCX接口说明属性NameA 该属性返回读取信息的姓名，返回数据类型为BSTRSex该属性返回读取信息的性别，返回数据类型为BSTRNation该属性返回读取信息的民族，返回数据类型为BSTRBorn该属性返回读取信息的出生日期，返回数据类型为BSTRAddress该属性返回读取信息的地址，返回数据类型为BSTRCardNo该属性返回读取信息的身份证号，返回数据类型为BSTRPolice该属性返回读取信息的发证机关，返回数据类型为BSTRUserLifeB该属性返回读取信息的有效期开始，返回数据类型为BSTRUserLifeE该属性返回读取信息的有效期结束，返回数据类型为BSTRPhotoName;该属性返回读取信息的照片文件名，返回数据类型为BSTRBase64Photo该属性返回读取信息的Base64照片编码，仅在用SetPhotoType方法设置存储文件为Base64格式之后有效返回数据类型为BSTR方法SetPhotoPath本方法用于设置存储照片的路径,参见Syn_SetPhotoPath。参数说明：iniType整形cPath字符串,BSTRSetPhotoType本方法用于设置存储照片的格式，参见Syn_SetPhotoTypeSetPhotoName本方法用于设置存储照片的文件名，参见Syn_SetPhotoNameSetSexType 本方法用于设置返回性别的格式，参见Syn_SetSexTypeSetNationType本方法用于设置返回民族的格式，参见Syn_SetNationTypeSetBornType本方法用于设置返回出生日期的格式，参见Syn_SetBornTypeSetUserLifeBType本方法用于设置返回有效期开始的格式，参见Syn_SetUserLifeBTypeSetUserLifeEType本方法用于设置返回有效期结束的格式，参见Syn_SetUserLif