HwDevComm.dll开发使用手册精选.doc

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，onnect考勤机考勤机默认处于ccept状态。 Socket连接：关闭PC机Socket 图3.1 本协议的语法结构如图3.1所示，由4类保留字组成，这4类保留字的说明如表3.1所示。 保留字名称 意义与用途 命令字 用于指明本次操作究竟要干什么（如：GetEmployeeID 表示获取考勤机上所有员工的员工号）。 控制字 作为命令字的参数出现，用于指明该参数是什么（如：name 表示该参数是员工姓名）。 常量保留字language=chs 表示该考勤机的语言设置为简体中文）。 分隔符 用于分隔各个保留字。 表3.1 除分隔符外，其余保留字为 数字字母下划线 的组合，最长32字符，大小写敏感。 各保留字间可以插入Space(空格)、Tab(跳格)、CR(回车)，处理忽略不计。采用“小写加下划线”的方式，如常量保留字采用“小写加下划线”的方式GetEmployeeID 从考勤机接收所有员工的员工号。 GetEmployee 从考勤机接收指定工号员工的员工信息，一次只能接收一个。 SetEmployee 发送员工到考勤机，一次只能发一个。 DeleteEmployee 在考勤机上删除指定工号的员工。可一次删除多个员工。 DeleteAllEmployee 在考勤机上删除所有员工。 SetNameTable 该命令更新考勤机上的id-姓名对照表，然后更新表中存在的员工姓名GetRecord 从考勤机接收所指定时间范围的考勤记录。 DeleteAllRecord 在考勤机上删除所有考勤记录。 考勤机管理类命令 InitDevice 初始化考勤机到出厂状态。 InitDeviceAdmin 初始化考勤机的管理员设置到出厂状态。 GetDeviceInfo 读取考勤机配置、状态信息。 SetDeviceInfo 设置考勤机配置、状态信息。