二代证系统终端API使用手册
内蒙古银安科技开发有限公司
二代证系统终端API使用手册
1.前言 ........................................................................................................................................... 2 2.系统要求 .............................................................................................................................. 2 3.API列表 ............................................................................................................................... 2 4.API详细说明 ................................................................................................................... 3
4.1 端口类API ............................................................................................................................... 3
4.1.1 SDT_SetMaxRFByte .......................................................................................................................... 3 4.1.2 SDT_GetCOMBaud .............................................................................................................................. 3 4.1.3 SDT_SetCOMBaud .............................................................................................................................. 4 4.1.4 SDT_OpenPort .................................................................................................................................. 4 4.1.5 SDT_ClosePort ................................................................................................................................ 5
4.2 SAM类API ................................................................................................................................ 5
4.2.1 SDT_ResetSAM .................................................................................................................................. 5 4.2.2 SDT_GetSAMStatus .......................................................................................................................... 6 4.2.3 SDT_GetSAMID .................................................................................................................................. 6 4.3.4 SDT_GetSAMIDToStr ........................................................................................................................ 7
4.3 身份证卡类API........................................................................................................................ 7
4.3.1 SDT_StartFindIDCard .................................................................................................................... 7 4.3.2 SDT_SelectIDCard .......................................................................................................................... 8 4.3.3 SDT_ReadBaseMsg ............................................................................................................................ 8 4.3.4 SDT_ReadIINSNDN ............................................................................................................................ 9 4.3.5 SDT_ReadBaseMsgToFile .............................................................................................................. 10 4.3.6 SDT_ReadIINSNDNToASCII ............................................................................................................ 10
5.API调用说明 ................................................................................................................. 11
5.1 调用顺序 ................................................................................................................................. 11 5.2 例子程序(以delphi语言为例) ......................................................................................... 11
6.函数返回码列表 ......................................................................................................... 13
二代证系统终端API使用手册
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列表
加密API分为下列几类,在下面各表中列出。
序号 函数名 1. 2. 3. 4. 5. SDT_SetMaxRFByte SDT_GetCOMBaud SDT_SetCOMBaud SDT_OpenPort SDT_ClosePort 端口API 功能描述 设置射频适配器最大通信字节数 查看串口当前波特率 设置串口上SAM的波特率 打开串口/USB口 关闭串口/USB口 序号 函数名 6. 7. 8. 9. SDT_ResetSAM SDT_GetSAMStatus SDT_GetSAMID SDT_GetSAMIDToStr SAM类API 功能描述 对SAM复位 对SAM进行状态检测 读取SAM的编号(十六进制) 读取SAM的编号(字符串格式) 序号 函数名 10. 11. 12. 13. 14. SDT_StartFindIDCard SDT_SelectIDCard SDT_ReadBaseMsg SDT_ReadIINSNDN SDT_ReadBaseMsgToFile 身份证卡类API 功能描述 开始找卡 选卡 读取ID卡内基本信息区域信息 读取ID卡内IIN,SN, DN 读取ID卡内基本信息区域信息,并把信息写入指定的文件中 读取ID卡内IIN,SN, DN,并转换成ASCII形式 15. SDT_ReadIINSNDNToASCII
二代证系统终端API使用手册
4.API详细说明
4.1 端口类API
4.1.1 SDT_SetMaxRFByte
设置射频适配器最大通信字节数。 int SDT_SetMaxRFByte (
int iPort, unsigned char ucByte, int iIfOpen );
参数说明:
iPort [in] 整数,表示端口号。参见SDT_ResetSAM。
ucByte [in] 无符号字符,24-255,表示射频适配器最大通信字节数。
iIfOpen [in] 整数,参见SDT_ResetSAM。
返回值:
0x90 其他
成功
失败(具体含义参见返回码表)
4.1.2 SDT_GetCOMBaud
查看串口当前波特率(该函数只用于SAM采用RS232串口的情形,如果采用USB接口则不支持该API)。
int SDT_GetCOMBaud (
int iPort,
unsigned int * puiBaudRate );
参数说明:
iPort [in] 整数,表示端口号。此处端口号必须为1-16,表示串口,参见SDT_Login。
puiBaudRate [out] 无符号整数指针,指向普通串口当前波特率, 默认情况下为115200。
二代证系统终端API使用手册
返回值:
0x90 0x1 0x5
成功
端口打开失败/端口号不合法
无法获得该SAM的波特率,该SAM串口不可用。
4.1.3 SDT_SetCOMBaud
设置SAM的串口的波特率(该函数只用于SAM采用RS232串口的情形,如果采用USB接口则不支持该API),设置成功后,在该SAM和主机注册表中都记录设置后的波特率,保证在SAM重新启动和该套API被重新调用时采用设置后的波特率。该函数调用成功后,需要延时5毫秒,然后才能继续与SAM通信。
int SDT_SetCOMBaud (
int iPort,
unsigned int uiCurrBaud,
unsigned int uiSetBaud );
参数说明:
iPort [in] 整数,表示端口号。此处端口号必须为1-16,表示串口。
uiCurrBaud [in] 无符号整数,调用该API前已设置的业务终端与SAM通信的波特率(SAM出厂时默认,业务终端与SAM通信的波特率为115200).业务终端以该波特率与SAM通信,发出设置SAM新波特率的命令.。uiCurrBaud只能为下列数值之一:115200,57600,38400,19200,9600.如果uiCurrBaud数值不是这些值之一,函数返回0x21;如果已设置的波特率与uiCurrBaud不一致, 则函数返回0x02,表示不能设置,调用API不成功。
uiSetBaud
[in] 无符号整数,将要设置的SAM与业务终端通信波特率。uiSetBaud只能取下列值之一::115200,57600,38400,19200,9600,如果输入uiSetBaud参数不是这些数值之一,,函数返回0x21,设置不成功,保持原来的波特率不变。
返回值:
0x90 成功
0x1 端口打开失败/端口号不合法。 0x2 超时,设置不成功。
0x21 uiCurrBaud 、uiSetBaud输入参数数值错误.。
4.1.4 SDT_OpenPort