HwDevComm.dll开发使用手册资料.doc

PAGE  PAGE - 13 - HwDevComm.dll开发使用手册 概述 HwDevComm.dll 是与所有汉王考勤机（及其他符合《汉王考勤机通信协议-HDCP_V0.1协议（以下简称：通信协议）的考勤设备）进行通信的动态链接库（DYNAMIC LINK LIBRARY，简称DLL），其可以在Win32平台上被调用。 接口 HwDevComm.dll 对外提供了1个接口，描述如下： 接口意义HwDev_Execute执行各种命令，如管理类、记录类等。其接口声明如下： Int HwDev_Execute( char * pDevInfoBuf, unsigned long nDevInfoLen, char * pSendBuf, unsigned long nSendLen, char ** pRecvBuf, unsigned long * pRecvLen, FuncTotalDoneTp pFuncTotalDone) 其接口具体参数、返回值及意义如下： 参数意义pDevInfoBuf考勤机信息首指针；存放符合《汉王考勤机通信协议-HDCP_V0.1语法的考勤机信息描述。考勤机信息描述形如： DeviceInfo( dev_id = 1 comm_type = ip ip_adress = 172.16.1.15 )nDevInfoLen考勤机信息缓冲区的长度。pSendBuf发送缓冲区首指针；存放符合《汉王考勤机通信协议-HDCP_V0.1语法的命令、参数和数据。建议在缓冲区中一次放入一条命令。如果在该缓冲区中放入了多个命令，将会被顺序执行。如果其中的一个命令执行失败了，将不会影响到之后的命令的执行。nSendLen发送缓冲区的长度。如果 nSendLen=0 则HwDevComm.dll只接收不发送。pRecvBuf接收缓冲区首指针；存放各种命令的执行结果； 执行结果的语法符合《汉王考勤机通信协议-HDCP_V0.1； 该内存由HwDevComm.dll来申请和释放。pRecvLen接收缓冲区的长度pFuncTotalDone回调函数指针；用于向调用者反馈执行进度。其中PFuncTotalDoneTp类型的定义为：typedef int (CALLBACK FuncTotalDoneTp)( unsigned long nTotal, unsigned long nDone )。返回值意义0成功-1失败其他保留 通信协议概述 与考勤机的连接 两种方式：串口、Socket。 准备：用串口线连接PC机与考勤机或用网线连接PC机与考勤机。 建立串口连接：打开PC机串口（考勤机串口默认处于打开状态）。 拆除串口连接：关闭PC机串口。 建立Socket连接：建立PC机Socket，Connect考勤机（考勤机默认处于Accept状态，在9922端口监听）。 拆除Socket连接：关闭PC机Socket。 语法和保留字 图3.1 本协议的语法结构如图3.1所示，由4类保留字组成，这4类保留字的说明如表3.1所示。 保留字名称意义与用途命令字用于指明本次操作究竟要干什么（如：GetEmployeeID 表示获取考勤机上所有员工的员工号）。控制字作为命令字的参数出现，用于指明该参数是什么（如：name 表示该参数是员工姓名）。常量保留字作为命令字的参数出现，一般跟在控制字的后面，用于指示该参数的值是多少。（如：language=chs 表示该考勤机的语言设置为简体中文）。分隔符用于分隔各个保留字。表3.1 除分隔符外，其余保留字为 数字字母下划线 的组合，最长32字符，大小写敏感。 各保留字间可以插入Space(空格)、Tab(跳格)、CR(回车)，处理忽略不计。 保留字的命名原则 保留字名称命名原则命令字Pascal命名法，指用一个或多个连在一起的词来组成名字，每个词都用大写字母开头，其他字母都小写。控制字采用“小写加下划线”的方式，都用小写字母，词之间用“_”分隔。如finger_count。常量保留字采用“小写加下划线”的方式。 保留字列表及其意义 命令字 名称意义员工管理类命令GetEmployeeID从考勤机接收所有员工的员工号。GetEmployee从考勤机接收指定工号员工的员工信息，一次只能接收一个。SetEmployee发送员工到考勤机，一次只能发一个。DeleteEmployee在考勤机上删除指定工号的员工。可一次删除多个员工。