iFace系列脱机通讯开发包开发手册

iFace系列脱机通讯开发包

开发手册

版本: 6.14 日期: 2009 年12月

2009 ZKSoftware Inc.。版权所有，翻印必究。

·本说明文件中的信息如有更改，恕不另行通知。 ·ZKSoftware Inc.为中控科技的司标，Biokey为中控科技的核心技术徽标，ZKSoftware ,Biokey已经在中国及美国注册。 ·本说明文件中述及的其他商标和产品名称是指拥有相应商标和产品名称的公司或者制造的产品。ZKSoftware Inc.对其他公司的商标和产品名称不拥有任何所有权。 ·开发中使用问题，非开发包问题，请自行解决。

·使用该开发包，由于人为或程序本身造成数据丢失，本公司概不负责。 ·该文档基于6.0.3.5版SDK

目录

1. SDK介绍....................................................................................................................................................................1 2. 快速开始...................................................................................................................................................................2

2.1 SDK安装..........................................................................................................................................................2 2.2常用词介绍.......................................................................................................................................................2 2.3 常用工作流程介绍..........................................................................................................................................3

2.3.1考勤记录下载流程:.............................................................................................................................3 2.3.2操作记录下载流程:.............................................................................................................................4 2.3.3门禁设置流程:.....................................................................................................................................4 2.3.4下载用户信息,指纹模板,面部模板等流程.......................................................................................5 2.3.5实时事件接收流程...............................................................................................................................5 2.3.6联机登记流程 (上传用户信息,指纹模板,面部模板等流程).........................................................6

3. 属性相关介绍............................................................................................................................................................7

3.1 AccGroup..........................................................................................................................................................7 3.2 AccTimeZones..................................................................................................................................................7 3.3 BASE64.............................................................................................................................................................7 3.4 CardNumber......................................................................................................................................................7 3.5 CommPort..........................................................................................................................................................7 3.6 ConvertBIG5....................................................................................................................................................7 3.7 PINWidth..........................................................................................................................................................8 3.8 GetStrCardNumber..........................................................................................................................................8 3.9 SetStrCardNumber..........................................................................................................................................8 4. 实时事件相关............................................................................................................................................................8

4.1 获取实时事件方法..........................................................................................................................................8

4.1.1 RegEvent..............................................................................................................................................8 4.1.2 ReadRTLog............................................................................................................................................9 4.1.3 GetRTLog..............................................................................................................................................9 4.2 实时事件介绍................................................................................................................................................10

4.2.1 OnConnected......................................................................................................................................10 4.2.2 OnDisConnected................................................................................................................................10 4.2.3 OnAlarm..............................................................................................................................................10 4.2.4 OnDoor................................................................................................................................................10 4.2.5 OnAttTransactionEx.........................................................................................................................11 4.2.6 OnEnrollFingerEx.............................................................................................................................11 4.2.7 OnFinger.............................................................................................................................................11 4.2.8 OnFingerFeature..............................................................................................................................12 4.2.9 OnHIDNum............................................................................................................................................12 4.2.10 OnNewUser........................................................................................................................................12 4.2.11 OnVerify..........................................................................................................................................12 4.2.12 OnWriteCard....................................................................................................................................12 4.2.13 OnEmptyCard....................................................................................................................................12 4.2.14 OnEMData..........................................................................................................................................13

5常用函数介绍.............................................................................................................................................................13

5.1 连接机器相关函数........................................................................................................................................13

5.1.1 Connect_Net......................................................................................................................................13 5.1.2 Connect_Com......................................................................................................................................13 5.1.3 Disconnect........................................................................................................................................14 5.2 数据管理相关函数........................................................................................................................................14

5.2.1 考勤记录数据....................................................................................................................................14

5.2.1.1 ReadGeneralLogData.................................................................................................................14 5.2.1.2 ReadAllGLogData.....................................................................................................................14 5.2.1.3 SSR_GetGeneralLogData..........................................................................................................15 5.2.1.4 ClearGLog..................................................................................................................................16 5.2.2操作记录相关.....................................................................................................................................16

5.2.2.1 ReadSuperLogData....................................................................................................................16 5.2.2.2 ReadAllSLogData......................................................................................................................16 5.2.2.3 GetSuperLogData.......................................................................................................................17 5.2.2.4 GetAllSLogData.........................................................................................................................18 5.2.2.5 ClearSLog..................................................................................................................................18 5.2.2.6 GetSuperLogData2.....................................................................................................................19 5.2.3用户信息相关.....................................................................................................................................19

5.2.3.1 ReadAllUserID...........................................................................................................................19 5.2.3.2 SSR_EnableUser........................................................................................................................20 5.2.3.3 SetUserInfoEx............................................................................................................................20 5.2.3.4 GetUserInfoEx...........................................................................................................................20 5.2.3.5 DeleteUserInfoEx.......................................................................................................................21 5.2.3.6 SSR_GetAllUserInfo..................................................................................................................21 5.2.3.7 SSR_GetUserInfo.......................................................................................................................22 5.2.3.8 SSR_SetUserInfo.......................................................................................................................22 5.2.4登记数据（同时包括用户信息和指纹）.........................................................................................23

5.2.4.1 SSR_DeleteEnrollData...............................................................................................................23 5.2.4.2 SSR_DeleteEnrollDataExt.........................................................................................................24 5.2.5指纹模板相关.....................................................................................................................................24

5.2.5.1 ReadAllTemplate........................................................................................................................24 5.2.5.2 SetUserTmpEx...........................................................................................................................24 5.2.5.3 SetUserTmpExStr......................................................................................................................25 5.2.5.4 GetUserTmpEx..........................................................................................................................26 5.2.5.5 GetUserTmpExStr......................................................................................................................26 5.2.5.6 SSR_DelUserTmp......................................................................................................................27 5.2.5.7 SSR_DelUserTmpExt................................................................................................................27 5.2.6面部数据相关.....................................................................................................................................28

5.2.6.1 SetUserFace...............................................................................................................................28 5.2.6.2 GetUserFace...............................................................................................................................28 5.2.6.3 DelUserFace...............................................................................................................................29 5.2.6.4 GetUserFaceStr..........................................................................................................................29 5.2.6.5 SetUserFaceStr...........................................................................................................................30 5.2.7 其他......................................................................................................................................................30

5.2.7.1 GetFPTempLength.....................................................................................................................30 5.2.7.2 GetFPTempLengthStr.................................................................................................................30 5.2.7.3 FPTempConvert.........................................................................................................................31 5.2.7.4 FPTempConvertStr.....................................................................................................................31 5.2.7.5 FPTempConvertNew..................................................................................................................32 5.2.7.6 FPTempConvertNewStr.............................................................................................................32 5.2.8系统数据管理相关.............................................................................................................................32

5.2.8.1 ClearKeeperData........................................................................................................................32 5.2.8.2 ClearData...................................................................................................................................33 5.2.8.3 GetDataFile................................................................................................................................33 5.2.8.4 SendFile.....................................................................................................................................34 5.2.8.5 RefreshData................................................................................................................................34

5.3门禁相关（时间段，组，开锁组合）.........................................................................................................35

5.3.1GetUserGroup......................................................................................................................................35 5.3.2SetUserGroup......................................................................................................................................35 5.3.3GetTZInfo............................................................................................................................................35 5.3.4SetTZInfo............................................................................................................................................36 5.3.5SSR_SetUnLockGroup..........................................................................................................................36 5.3.6SSR_GetUnLockGroup..........................................................................................................................37 5.3.7SSR_SetGroupTZ..................................................................................................................................37 5.3.8SSR_GetGroupTZ..................................................................................................................................38 5.3.9GetUserTZs..........................................................................................................................................38 5.3.10SetUserTZs........................................................................................................................................39 5.3.11GetUserTZStr....................................................................................................................................39 5.3.12SetUserTZStr....................................................................................................................................40 5.3.13ACUnlock............................................................................................................................................40 5.3.14GetACFun............................................................................................................................................41 5.3.15GetDoorState....................................................................................................................................41 5.3.16UseGroupTimeZone............................................................................................................................41 5.4机器管理........................................................................................................................................................42

5.4.1IsTFTMachine......................................................................................................................................42 5.4.2GetDeviceStatus................................................................................................................................42 5.4.3GetDeviceInfo....................................................................................................................................43 5.4.4SetDeviceInfo....................................................................................................................................45 5.4.5SetDeviceTime....................................................................................................................................45 5.4.6SetDeviceTime2..................................................................................................................................45 5.4.7GetDeviceTime....................................................................................................................................46 5.4.8GetSerialNumber................................................................................................................................46 5.4.9GetProductCode..................................................................................................................................47 5.4.10GetFirmwareVersion........................................................................................................................47 5.4.11GetSDKVersion..................................................................................................................................47 5.4.12GetDeviceIP......................................................................................................................................48 5.4.13SetDeviceIP......................................................................................................................................48 5.4.14GetDeviceMAC....................................................................................................................................48 5.4.15SetDeviceMAC....................................................................................................................................49 5.4.16GetWiegandFmt..................................................................................................................................49 5.4.17SetWiegandFmt..................................................................................................................................49 5.4.18GetCardFun........................................................................................................................................50 5.4.19SetDeviceCommPwd............................................................................................................................50 5.4.20SetCommPassword..............................................................................................................................51 5.4.21QueryState........................................................................................................................................51 5.4.22GetVendor..........................................................................................................................................51 5.4.23GetDeviceStrInfo............................................................................................................................52 5.4.24GetPlatform......................................................................................................................................52 5.4.25ReadAOptions....................................................................................................................................52 5.4.26GetSysOption....................................................................................................................................53 5.4.27SetSysOption....................................................................................................................................53 5.5其他................................................................................................................................................................54

5.5.1机器控制.............................................................................................................................................54

5.5.1.1ClearAdministrators....................................................................................................................54 5.5.1.2EnableDevice..............................................................................................................................54 5.5.1.3EnableClock................................................................................................................................54

5.5.1.4DisableDeviceWithTimeOut.......................................................................................................55 5.5.1.5PowerOffDevice..........................................................................................................................55 5.5.1.6RestartDevice..............................................................................................................................55 5.5.1.7SleepDevice................................................................................................................................56 5.5.2 卡操作相关........................................................................................................................................56

5.5.2.1WriteCard....................................................................................................................................56 5.5.2.2EmptyCard..................................................................................................................................56 5.5.3 其他....................................................................................................................................................57

5.5.3.1GetLastError................................................................................................................................57 5.5.3.2GetHIDEventCardNumAsStr......................................................................................................57 5.5.3.3CaptureImage..............................................................................................................................58 5.5.3.4UpdateFirmware..........................................................................................................................58 5.5.3.5BeginBatchUpdate......................................................................................................................58 5.5.3.6BatchUpdate................................................................................................................................59 5.5.3.7CancelBatchUpdate.....................................................................................................................59 5.5.3.8PlayVoice....................................................................................................................................59 5.5.3.9PlayVoiceByIndex.......................................................................................................................60

6.常见问题解答............................................................................................................................................................60

6.1 如何下载考勤记录........................................................................................................................................60 6.2 如何联机创建用户........................................................................................................................................60 6.3 U盘数据导入及下载.....................................................................................................................................60 6.4 BIOKEY采集指纹模板写入脱机...................................................................................................................62 6.5 取得所有用户所有信息................................................................................................................................62 6.6 机器连接........................................................................................................................................................62 6.7 在SSR_SetUserInfo后密码不能用问题....................................................................................................63 6.8 联机模板转换为脱机模板............................................................................................................................63 6.9 Demo程序不能接机器问题...........................................................................................................................63 6.10 脱机指纹机连接后处于工作状态问题......................................................................................................63 6.11上传非英文姓名或短消息到机器内出现乱码，或不能正常显示...........................................................63 6.12 卡管理问题..................................................................................................................................................64 6.13 连接穿越防火墙或路由器问题..................................................................................................................64 6.14 大容量指纹上传..........................................................................................................................................64 6.15 高速上传和普通上传的区别......................................................................................................................64 6.16如何支持人脸模板的下载............................................................................................................................64

1. SDK介绍

脱机通讯开发包是一个与脱机指纹机、门禁机、卡机等进行数据通讯的接口。可以方便地对机器进行用户信息、指纹的管理，下载考勤记录、管理记录、用户信息、指纹模板、面部模板，对机器进行各种设置及门禁配置管理的开发包。主要功能有： 1、下载机器考勤记录。

2、下载、上传用户信息、卡信息、指纹信息以及面部信息。 3、设置门禁机的门禁规则。

4、进行各种配置，如设置机器时间、匹配阀值等。

5、可实时激发机器的各种事件，如按指纹、验证通过等。

2. 快速开始

2.1 SDK安装

1、

6. 操作记录

也称管理记录，为用户或管理员在操作机器时产生的操作记录，如开机，关机，登记用户等操作。

2.3 常用工作流程介绍

详细使用方法请参考对应的demo程序。

2.3.1考勤记录下载流程:

2.3.2操作记录下载流程:

开始连接设备(Connect_Net或其他)从机器读取所有操作记录到缓存(ReadSuperLogData)

2.3.3门禁设置流程:

从缓存取操作记录是否成功？(GetSuperLogData)NY保存操作记录结束开始连接设备(Connect_Net或其他)定义时间段(SetTZInfo)判断用户是否使用组时间段?(UseGroupTimeZone or Y定义组时间段(SetGroupTZStr)GetUserTZStr)N设置用户所在的组(SetUserGroup)分配时间段给用户(SetUserTZStr)设置开锁组合(SSR_SetUnlockGroup)结束

2.3.4下载用户信息,指纹模板,面部模板等流程

左边为下载所有用户，右边为下载指定用户

开始开始连接设备(Connect_net或其他)连接设备(Connect_net或其他)读取所有用户信息到PC缓存(ReadAllUserID)下载用户信息是否成功? (SSR_GetUserInfo)读取所有指纹模板到PC缓存ReadAllTemplateY从PC缓存取用户信息是否成功？ (SSR_GetAllUserInfo)获取该用户卡号(attribute:Cardnumber or GetStrCardNumber)Y获取该用户的卡号(attribute:Cardnumber or GetStrCardNumber)获取该用户的指纹模板N(GetUserTmpExStr)获取该用户的指纹模板(GetUserTmpExStr)N获取该用户的面部模板(GetUserFaceStr)获取该用户的面部模板(GetUserFaceStr)结束结束

2.3.5实时事件接收流程

实时事件接收有以下两种方式，建议用户使用第二种方式

开始开始连接设备(Connect_Net或其他)N连接设备(Connect_Net或其他)读取实时事件到PC缓存是否成功？(ReadRTLog)注册需要触发的实时事件(Regevent)Y从缓存取实时事件并触发(GetRTLog)结束

2.3.6联机登记流程 (上传用户信息,指纹模板,面部模板等流程)

下图为直接在机器内创建用户，并给该用户上传相应的卡号、密码、指纹信息，即分别实现登记卡用户，密码用户，指纹或面部用户等

3. 属性相关介绍

3.1 AccGroup

功能：设置或获取用户所属的组。 在上传用户前如果设置了该属性，则在SetUserInfo等函数上传用户时，设置该用户所属的组，否则默认为1组。

类型：LONG ，可读写。

3.2 AccTimeZones

功能：设置用户使用时间段。 在上传用户前如果设置了该属性，则在SetUserInfo等函数上传用户时，设置该用户所属的时间段。 类型：LONG * ,可以认为该属性为下标为3的一维数组long类型数组。可读写。

3.3 BASE64

功能：当设置该属性为真值时，开发包在输出字符串模板时输出为Base64编码，否则是十六进制编码。 类型：LONG ，可读写。

3.4 CardNumber

功能：设置或读取用户的卡号，如果不能使用该属性，请使用GetStrCardnumber和SetStrCardnumber进行卡号的相关操作

类型：LONG ,可读写。

3.5 CommPort

功能：设置串口或485连接时的端口号。 类型：LONG ,可读写。

3.6 ConvertBIG5

功能：当设置该属性为真值时，开发包自动把简体字符转换为繁体字符，用于繁体版脱机开发，但是在多国语言系列产品中，该函数无效，请不要设置该属性 类型：LONG ,可读写。

注意：在多国语言系列版本以后的版本中，请不要设置该属性，该属性无效。ZEM100 5.22， ZEM200 5.30后的版本不需要修改该属性。

3.7 PINWidth

功能：标示用户编号（阿拉伯数字）最大长度。 类型：LONG ,只读。

3.8 GetStrCardNumber

【函数定义】

VARIANT_BOOL GetStrCardNumber([out] BSTR* ACardNumber) 【功能】 获取SDK属性cardnumber的值，一般在获取到用户信息后即可利用该函数获得相应用户的卡号信息 【参数】 AcardNumber 卡号 【返回值】 成功返回true,否则返回false 【相关函数】 GetUserInfo

3.9 SetStrCardNumber

【函数定义】

VARIANT_BOOL SetStrCardNumber([in] BSTR ACardNumber) 【功能】 设置SDK属性cardnumber的值，一般在设置用户信息前用该函数设置相应用户的卡号信息 【参数】 AcardNumber 卡号 【返回值】 成功返回true,否则返回false 【相关函数】 SetUserInfo

4. 实时事件相关

4.1 获取实时事件方法

4.1.1 RegEvent

【函数定义】

VARIANT_BOOL RegEvent( [in] LONG dwMachineNumber, [in] LONG EventMask)

【功能】

注册需要触发的实时事件 【参数】 dwMachineNumber: 机器号 EventMask: 事件代号。具体含义如下 1 OnAttTransaction，OnAttTransactionEx 2（1<<1） OnFinger 4（1<<2） OnNewUser 8（1<<3） OnEnrollFinger，OnEnrollFingerEx 16（1<<4） OnKeyPress 256（1<<7） OnVerify 512（1<<8） OnFingerFeature 1024（1<<9） OnDoor，OnAlarm 2048（1<<10） OnHIDNum 4096（1<<11） OnWriteCard 8192（1<<12） OnEmptyCard

16384（1<<13） OnDeleteTemplate

使用时，如需注册多个实时事件，只需将相关事件代号的二进制进行或运算即可，如注册全部实时事件，EventMask参数值为65535 【返回值】

成功返回True，否则返回False 【相关函数】

ReadRTLog，GetRTLog

4.1.2 ReadRTLog

【函数定义】

VARIANT_BOOL ReadRTLog( [in] LONG dwMachineNumber) 【功能】

读取实时事件到PC的缓冲区，该函数和GetRTLog搭配使用可以实现在连接机器成功后主动向机器获取实时事件的功能。 【参数】 dwMachineNumber: 机器号 【返回值】

成功返回真，否则返回假 【相关函数】 GetRTLog

4.1.3 GetRTLog

【函数定义】

VARIANT_BOOL GetRTLog(LONG dwMachineNumber) 【功能】

从PC的缓冲区取出事件，并使该事件触发，该函数和ReadRTLog搭配使用可以实现在连接机器成功后主动向机器获取实时事件的功能。 【参数】 dwMachineNumber: 机器号 【返回值】

成功返回真，否则返回假 【相关函数】 ReadRTLog

4.2 实时事件介绍

4.2.1 OnConnected

当成功连接机器时触发该事件，无返回值

4.2.2 OnDisConnected

当断开机器时触发该事件，无返回值

4.2.3 OnAlarm

OnAlarm (LONG AlarmType,LONG EnrollNumber,LONG Verified) 当机器报警时触发该事件 【返回值】

Alarm Type:报警类型 55时为拆机报警，58为错按报警，32为胁迫报警，34为反潜报

警

EnrollNumber:用户ID 当为拆机或错按报警或胁迫按键报警时，该值为0，当为其他胁

迫或反潜报警时，该值为用户ID号

Verified:是否验证 当为拆机或错按报警或胁迫按键报警时，该值为0，其余报警该

值为1.

4.2.4 OnDoor

OnDoor (LONG EventType) 当机器开门时发生该时件 【返回值】

EventType：开门类型

4表示门未关好或者门已打开,53表示出门按钮,5表示门已关闭,1表示门被意外打开

4.2.5 OnAttTransactionEx

OnAttTransactionEx (BSTR EnrollNumber,LONG IsInValid,LONG AttState, LONG VerifyMethod,LONG Year, LONG Month, LONG Day, LONG Hour, LONG Minute, LONG Second, LONG WorkCode) 当验证通过时触发该事件 【返回值】

EnrollNumber为该用户的UserID

IsInValid为该记录是否为有效记录，1为无效记录，0为有效记录。

AttState为考勤状态 默认 0—Check-In 1—Check-Out 2—Break-Out

3—Break-In 4—OT-In 5—OT-Out

VerifyMethod为验证方式 一般情况下：0为密码验证，1为指纹验证，2为卡验证 多中验证方式模式下： FP_OR_PW_OR_RF 0

FP 1

PIN 2 PW 3 RF 4 FP_OR_PW 5 FP_OR_RF 6 PW_OR_RF 7 PIN_AND_FP 8 FP_AND_PW 9 FP_AND_RF 10 PW_AND_RF 11 FP_AND_PW_AND_RF 12 PIN_AND_FP_AND_PW 13 FP_AND_RF_OR_PIN 14 Year/Month/Day/Hour/Minute/ Second为验证通过时的时间

WorkCode返回验证时WorkCode值，当机器无Workcode功能时，该值返回0.

4.2.6 OnEnrollFingerEx

OnEnrollFingerEx (BSTR EnrollNumber, LONG FingerIndex, LONG ActionResult, LONG TemplateLength) 登记指纹时触发该事件 【返回值】

EnrollNumber为当前登记指纹的用户ID FingerIndex为当前指纹的索引号

ActionResult为操作结果，成功则为0，否则返回值大于0 TemplateLength返回该指纹模板的长度

4.2.7 OnFinger

当机器上指纹头上检测到有指纹时触发该消息，无返回值

4.2.8 OnFingerFeature

OnFingerFeature (LONG Score)

登记用户指纹时，当有指纹按下时触发该消息 【返回值】

Score为该指纹的质量分数

4.2.9 OnHIDNum

OnHIDNum(LONG CardNumber) 当刷卡时触发该消息 【返回值】

CardNumber为该卡的卡号 卡类型可以是ID卡，HID卡，MIFARE卡需要被作为ID卡使用时才会触发该事件

4.2.10 OnNewUser

OnNewUser (LONG EnrollNumber) 当成功登记新用户时触发该消息 【返回值】

EnrollNumber为新登记用户的UserID

4.2.11 OnVerify

OnVerify (LONG UserID) 当用户验证时触发该消息 【返回值】

当验证成功时UserID为该用户ID，当卡验证通过时，该值返回卡号，验证失败时返回值为-1

4.2.12 OnWriteCard

OnWriteCard (LONG EnrollNumber, LONG ActionResult, LONG Length) 当机器进行写卡操作时触发该事件 【返回值】

EnrollNumber为当前需写如卡内用户的用户ID

ActionResult为写卡操作的结果，0为成功，其他值为失败 Length为写入卡内总的数据大小

4.2.13 OnEmptyCard

OnEmptyCard (LONG ActionResult) 当清空MIFARE卡操作时触发该事件 【返回值】

ActionResult为清卡操作的结果，0为成功，其他值为失败

4.2.14 OnEMData

OnEMData (LONG DataType, LONG DataLen, CHAR* DataBuffer) 当机器向SDK发送未知事件时，触发该事件 【返回值】

DataType为返回事件类型 DataLen为整个数据长度 DataBuffer为实际数据

5. 常用函数介绍

5.1 连接机器相关函数

5.1.1 Connect_Net

【函数定义】

VARIANT_BOOL Connect_Net( [in] BSTR IPAdd, [in] long Portl) 【功能】

通过IP地址连接机器，和机器建立一个网络连接 【参数】 IPAdd: 机器的IP地址。 Port: 连接机器时使用的端口号，默认为4370. 【返回值】

连接成功返回True，否则返回False 【相关函数】

Disconnect、Connect_Com

5.1.2 Connect_Com

【函数定义】

VARIANT_BOOL Connect_Com( [in] long ComPort, [in] long MachineNumber, [in] long BaudRate) 【功能】

通过串口连接机器，即RS232或RS485连接 【参数】 ComPort: 需要连接机器的PC串口号 MachineNumber: 机器号 BaudRate: 波特率 【返回值】

连接成功返回True，否则返回False 【相关函数】

Disconnect、Connect_Net

5.1.3 Disconnect

【函数定义】 Disconnect(void) 【功能】

断开连接的机器，释放相关资源 【参数】 无

【返回值】 无

【相关函数】

Connect_Net、Connect_Com

5.2 数据管理相关函数

5.2.1 考勤记录数据

5.2.1.1 ReadGeneralLogData

【函数定义】

VARIANT_BOOL ReadGeneralLogData( [in] long dwMachineNumber) 【功能】

读取考勤记录到PC的内部缓冲区，同ReadAllGLogData 【参数】 dwMachineNumber: 机器号 【返回值】

成功返回True，否则返回False 【相关函数】

ReadAllGLogData、SSR_GetGeneralLogData、ClearGLog

5.2.1.2 ReadAllGLogData

【函数定义】

VARIANT_BOOL ReadAllGLogData ( [in] long dwMachineNumber) 【功能】

读取考勤记录到PC的内部缓冲区，同ReadGeneralLogData 【参数】 dwMachineNumber: 机器号 【返回值】

成功返回True，否则返回False

【相关函数】

ReadGeneralLogData、SSR_GetGeneralLogData、ClearGLog

5.2.1.3 SSR_GetGeneralLogData

【函数定义】

VARIANT_BOOL SSR_GetGeneralLogData( [in] LONG dwMachineNumber, [out] BSTR* dwEnrollNumber, [out] LONG* dwVerifyMode, [out] LONG* dwInOutMode, [out] LONG* dwYear, [out] LONG* dwMonth, [out] LONG* dwDay, [out] LONG* dwHour, [out] LONG* dwMinute, [out] LONG* dwSecond, [out] LONG* dwWorkcode) 【功能】

从内部缓冲区中逐一读取考勤记录，使用该函数前，可使用ReadAllGLogData或ReadGeneralLogData将考勤记录从机器读到PC内部缓冲区。该函数每执行一次，指向考勤记录的指针指向下一条记录，同GetGeneralLogData不同的是该函数适用与彩屏机 【参数】 dwMachineNumber 机器号 dwEnrollNumber 指向BSTR型变量的指针，值接收该考勤记录的用户ID号，可最大支持24位 dwVerifyMode

指向long型变量的指针，其值接收记录的验证方式，具体含义如下：

一般情况下：0为密码验证，1为指纹验证，2为卡验证 多种验证方式模式下： FP_OR_PW_OR_RF 0

FP 1

PIN 2 PW 3 RF 4 FP_OR_PW 5 FP_OR_RF 6 PW_OR_RF 7 PIN_AND_FP 8 FP_AND_PW 9 FP_AND_RF 10 PW_AND_RF 11 FP_AND_PW_AND_RF 12 PIN_AND_FP_AND_PW 13 FP_AND_RF_OR_PIN 14 dwInOutMode

指向long型变量的指针，其值接收记录的考勤状态，具体含义如下： 默认 0—Check-In 1—Check-Out 2—Break-Out

3—Break-In 4—OT-In 5—OT-Out

dwYear，dwMonth，dwDay，dwHour，dwMinute，dwSecond， 都为指向long型变量的指针，其值分别接收考勤记录的日期和时间 dwWorkcode

指向long型变量的指针，其值接收记录的Workcode值 【返回值】

成功返回True,否则返回False 【相关函数】 ReadGeneralLogData

5.2.1.4 ClearGLog

【函数定义】

VARIANT_BOOL ClearGLog([in] long dwMachineNumber) 【功能】

清除机器内所有考勤记录 【参数】 dwMachineNumber 机器号 【返回值】

成功返回True,否则返回False 【相关函数】

ClearSLog、ClearKeeperData

5.2.2操作记录相关

5.2.2.1 ReadSuperLogData

【函数定义】

VARIANT_BOOL ReadSuperLogData( [in]long dwMachineNumber) 【功能】

读取操作记录到PC的内部缓冲区，同ReadAllSLogData 【参数】 dwMachineNumber: 机器号 【返回值】

成功返回True，否则返回False 【相关函数】

ReadAllSLogData、GetAllSLogData、GetSuperLogData、ClearSLog

5.2.2.2 ReadAllSLogData

【函数定义】

VARIANT_BOOL ReadAllSLogData( [in] long dwMachineNumber) 【功能】

读取操作记录到PC的内部缓冲区，同ReadSuperLogData 【参数】 dwMachineNumber: 机器号 【返回值】

成功返回True，否则返回False 【相关函数】

ReadSuperLogData、GetAllSLogData、GetSuperLogData、ClearSLog

5.2.2.3 GetSuperLogData

【函数定义】

VARIANT_BOOL GetSuperLogData( [in] long dwMachineNumber, [out] long* dwTMachineNumber, [out] long* dwSEnrollNumber, [out] long* Params4, [out] long* Params1, [out] long* Params2, [out] long* dwManipulation, [out] long* Params3, [out] long* dwYear, [out] long* dwMonth, [out] long* dwDay, [out] long* dwHour, [out] long* dwMinute) 【功能】

从内部缓冲区中逐一读取操作记录，使用该函数前，可使用ReadAllSLogData或ReadSuperLogData将操作记录从机器读到PC内部缓冲区。该函数每执行一次，指向操作记录的指针指向下一条记录，同GetSuperLogData2不同的仅是GetSuperLogData2能获得精确到秒的操作记录时间 【参数】 dwMachineNumber 机器号 dwTMachineNumber 指向long型变量的指针，其值接收操作记录的机器号 dwSEnrollNumber 指向long型变量的指针，其值接收该操作记录的管理者ID号 Params4 指向long型变量的指针，其值含义视dwManipulation不同而不同 Params1

指向long型变量的指针，其值含义视dwManipulation不同而不同

Params2

指向long型变量的指针，其值含义视dwManipulation不同而不同

dwManipulation 指向long型变量的指针，其值接收操作类型值，具体含义如下：

dwManipdwManipulation含

义 ulation值

0 1

开机 关机

Params1

报警类型，58为错按报

警，54为门磁报警，53为出门开关开门，55为拆机报警，65535时为

关闭报警

所设置的选项的编号

Params2

Params3

Params4

3 报警

4 5

进入菜单 更改设置

操作结果，0为成功，其他为失败

登记的指纹索引

指纹模板长度（为2时表示为胁迫指纹）

6 登记指纹 被操作用户的ID

7 登记密码 写入MF卡的指纹数量 读入MF卡的指纹数量

被操作用户的ID 是否为验证报警，0为按键报警，1为验证报

警

是否反潜

操作结果

写入MF卡内的指纹数据大小

14 创建MF卡

被操作用户的ID

20 22 30 32 34

把卡中数据复制到机器内 恢复出厂设置 登记新用户 胁迫报警 反潜

注：当为验证报警，此时dwSEnrollNumber返回被胁迫的用

户号

Params3

指向long型变量的指针，其值含义视dwManipulation不同而不同

dwYear，dwMonth，dwDay，dwHour，dwMinute 都为指向long型变量的指针，其值分别接收操作记录的日期和时间 【返回值】

成功返回True,否则返回False 【相关函数】

GetSuperLogData2、GetAllSLogData

5.2.2.4 GetAllSLogData

【函数定义】

GetAllSLogData( [in] long dwMachineNumber, [out] long* dwTMachineNumber, [out] long* dwSEnrollNumber, [out] long* dwSMachineNumber, [out] long* dwGEnrollNumber, [out] long* dwGMachineNumber, [out] long* dwManipulation, [out] long* dwBackupNumber, [out] long* dwYear, [out] long* dwMonth, [out] long* dwDay, [out] long* dwHour, [out] long* dwMinute) 【功能】

从内部缓冲区中逐一读取操作记录，使用该函数前，可使用ReadAllSLogData或ReadSuperLogData将操作记录从机器读到PC内部缓冲区。该函数每执行一次，指向操作记录的指针指向下一条记录，同GetSuperLogData完全一样，只是为了兼容，接口名称不同而已 【参数】

同GetSuperLogData 【返回值】

成功返回True,否则返回False 【相关函数】 GetSuperLogData

5.2.2.5 ClearSLog

【函数定义】

VARIANT_BOOL ClearSLog([in] long dwMachineNumber) 【功能】

清除机器内所有操作记录 【参数】 dwMachineNumber 机器号 【返回值】

成功返回True,否则返回False 【相关函数】

ClearGLog、ClearKeeperData

5.2.2.6 GetSuperLogData2

【函数定义】

VARIANT_BOOL GetSuperLogData2([in] LONG dwMachineNumber, [out] LONG* dwTMachineNumber, [out] LONG* dwSEnrollNumber, [out] LONG* Params4, [out] LONG* Params1, [out] LONG* Params2, [out] LONG* dwManipulation, [out] LONG* Params3, [out] LONG* dwYear, [out] LONG* dwMonth, [out] LONG* dwDay, [out] LONG* dwHour,[out] LONG* dwMinute, [out] LONG* dwSecs) 【功能】

从内部缓冲区中逐一读取操作记录，使用该函数前，可使用ReadAllSLogData或ReadSuperLogData将操作记录从机器读到PC内部缓冲区。该函数每执行一次，指向操作记录的指针指向下一条记录，同GetSuperLogData不同的仅是GetSuperLogData2能获得精确到秒的操作记录时间 【参数】 dwYear，dwMonth，dwDay，dwHour，dwMinute，dwSecs 都为指向long型变量的指针，其值分别接收操作记录的日期和时间 其他参数参考GetSuperLogData相应参数说明 【返回值】 成功返回True，否则返回False 【相关函数】 ReadAllSLogData、GetSuperLogData

5.2.3用户信息相关

5.2.3.1 ReadAllUserID

【函数定义】

VARIANT_BOOL ReadAllUserID([in] long dwMachineNumber) 【功能】

读取所有的用户信息到PC内存中，包括用户编号，密码，姓名，卡号等，指纹模板除外。在该函数执行完成后，可调用函数 GetAllUserID 取出用户信息 【参数】 dwMachineNumber 机器号 【返回值】 成功返回True，否则返回False 【相关函数】 SSR_GetAllUserInfo

5.2.3.2 SSR_EnableUser

【函数定义】

VARIANT_BOOL SSR_EnableUser([in] LONG dwMachineNumber, [in] BSTR dwEnrollNumber, [in] VARIANT_BOOL bFlag) 【功能】 设置用户是否可用 【参数】 dwMachineNumber 机器号 dwEnrollNumber 用户号 bFlag 用户启用标志，True为启用，False为禁用 【返回值】 成功返回True，否则返回False 【相关函数】 无

5.2.3.3 SetUserInfoEx

【函数定义】

VARIANT_BOOL SetUserInfoEx([in] LONG dwMachineNumber, [in] LONG dwEnrollNumber, [in] LONG VerifyStyle, [in] BYTE* Reserved) 【功能】 上传用户验证方式或组验证方式。只有有多种验证方式的机器可支持该函数 【参数】 dwMachineNumber 机器号 dwEnrollNumber 用户号 VerifyStyle

验证方式

彩屏门禁指纹机的值为:0表示使用组验证方式, 128(FP/PW/RF), 129(FP), 130(PIN), 131(PW), 132(RF), 133(FP&RF), 134(FP/PW), 135(FP/RF), 136(PW/RF), 137(PIN&FP), 138(FP&PW), 139(PW&RF), 140(FP&PW&RF), 141(PIN&FP&PW), 142(FP&RF/PIN).

Reserved 保留参数，暂无意义 【返回值】 成功返回True，否则返回False 【相关函数】 GetUserInfoEx、DeleteUserInfoEx

5.2.3.4 GetUserInfoEx

【函数定义】

VARIANT_BOOL GetUserInfoEx([in] LONG dwMachineNumber, [in] LONG dwEnrollNumber, [out] LONG*

VerifyStyle, [out] BYTE* Reserved) 【功能】 获取用户验证方式，只有具有多种验证方式的机器可支持该函数 【参数】 dwMachineNumber 机器号 dwEnrollNumber 用户号 VerifyStyle 该参数返回由dwEnrollNumber描述的用户的验证方式，具体含义如下：

彩屏门禁指纹机的值为:0表示使用组验证方式, 128(FP/PW/RF), 129(FP), 130(PIN), 131(PW), 132(RF), 133(FP&RF), 134(FP/PW), 135(FP/RF), 136(PW/RF), 137(PIN&FP), 138(FP&PW), 139(PW&RF), 140(FP&PW&RF), 141(PIN&FP&PW), 142(FP&RF/PIN).

Reserved 保留参数，无意义 【返回值】 成功返回True，否则返回False 【相关函数】 SetUserInfoEx、DeleteUserInfoEx

5.2.3.5 DeleteUserInfoEx

【函数定义】

VARIANT_BOOL DeleteUserInfoEx([in] LONG dwMachineNumber, [in] LONG dwEnrollNumber) 【功能】 删除指定用户设置的多种验证方式，只有有多种验证方式的机器可支持该函数 【参数】 dwMachineNumber 机器号 dwEnrollNumber 用户号 【返回值】 成功返回True，否则返回False 【相关函数】 SetUserInfoEx、GetUserInfoEx

5.2.3.6 SSR_GetAllUserInfo

【函数定义】

VARIANT_BOOL SSR_GetAllUserInfo([in] LONG dwMachineNumber, [out] BSTR* dwEnrollNumber, [out] BSTR* Name, [out] BSTR* Password, [out] LONG* Privilege, [out] VARIANT_BOOL* Enabled) 【功能】

取得所有用户信息。在该函数执行之前，可用 ReadAllUserID 读取到所有用户信息到内存，SSR_GetAllUserInfo每执行一次，指向用户信息指针移到下一记录，当读完所有用户信息后，函数返回False。 【参数】 dwMachineNumber

机器号 dwEnrollNumber 用户号 Name 用户姓名 Password 用户密码 Privilege 用户权限，3为管理员，0为普通用户 Enabled

用户启用标志，1为启用，0为禁用 【返回值】 成功返回True，否则返回False 【相关函数】 ReadAllUserID、GetAllUserInfo

5.2.3.7 SSR_GetUserInfo

【函数定义】

VARIANT_BOOL SSR_GetUserInfo([in] LONG dwMachineNumber, [in] BSTR dwEnrollNumber, [out] BSTR* Name, [out] BSTR* Password, [out] LONG* Privilege, [out] VARIANT_BOOL* Enabled) 【功能】 获取指定用户的用户信息 【参数】 dwMachineNumber 机器号 dwEnrollNumber 用户号 Name 该参数返回由dwEnrollNumber描述的用户的姓名 Password 该参数返回由dwEnrollNumber描述的用户的密码 Privilege 该参数返回由dwEnrollNumber描述的用户的权限，3为管理员，0为普通用户 Enabled

用户启用标志，1为启用，0为禁用 【返回值】 成功返回True，否则返回False 【相关函数】 SSR_SetUserInfo

5.2.3.8 SSR_SetUserInfo

【函数定义】

VARIANT_BOOL SSR_SetUserInfo([in] LONG dwMachineNumber, [in] BSTR dwEnrollNumber, [in] BSTR Name, [in] BSTR Password, [in] LONG Privilege, [in] VARIANT_BOOL Enabled)

【功能】 设置指定用户的用户信息, 若机器内没用该用户，则会创建该用户 【参数】 dwMachineNumber 机器号 dwEnrollNumber 用户号 Name 用户姓名 Password 用户密码 Privilege 用户权限，3为管理员，0为普通用户 Enabled

用户启用标志，1为启用，0为禁用 【返回值】 成功返回True，否则返回False 【相关函数】 SSR_GetUserInfo

5.2.4登记数据（同时包括用户信息和指纹）

5.2.4.1 SSR_DeleteEnrollData

【函数定义】

VARIANT_BOOL SSR_DeleteEnrollData([in] LONG dwMachineNumber, [in] BSTR dwEnrollNumber, [in] LONG dwBackupNumber) 【功能】 删除登记数据 【参数】

dwMachineNumber 机器号 dwEnrollNumber 用户号 dwBackupNumber

指纹索引

一般范围为0-9，同时会查询该用户是否还有其他指纹和密码，如都没有，则删除该用户 当为10是代表删除的是密码，同时会查询该用户是否有指纹数据，如没有，则删除该用户 11是代表删除该用户所有指纹数据，12代表删除该用户（包括所有指纹和卡号、密码数据）

【返回值】 成功返回True，否则返回False 【相关函数】 SSR_SetUserInfo、SSR_SetUserTmp、SSR_DeleteEnrollDataExt

5.2.4.2 SSR_DeleteEnrollDataExt

【函数定义】

VARIANT_BOOL SSR_DeleteEnrollDataExt([in]LONG dwMachineNumber, [in] BSTR dwEnrollNumber, [in] LONG dwBackupNumber) 【功能】

删除登记数据，和SSR_DeleteEnrollData不同的是删除所有指纹数据可用参数13实现，该函数具有更高效率 【参数】 dwMachineNumber 机器号 dwEnrollNumber 用户号 dwBackupNumber

指纹索引

一般范围为0-9，同时会查询该用户是否还有其他指纹和密码，如都没有，则删除该用户 当为10是代表删除的是密码，同时会查询该用户是否有指纹数据，如没有，则删除该用户

11和13是代表删除该用户所有指纹数据，12代表删除该用户（包括所有指纹和和卡号、密码数据）

【返回值】 成功返回True，否则返回False 【相关函数】 SSR_SetUserInfo、SSR_SetUserTmp、SSR_DeleteEnrollData

5.2.5指纹模板相关

5.2.5.1 ReadAllTemplate

【函数定义】

VARIANT_BOOL ReadAllTemplate([in] LONG dwMachineNumber) 【功能】

读取机器内所有指纹模板到PC内存，该函数一次性将所有指纹数据读到内存，相比于一个一个从机器获取，该函数具有更高效率 【参数】 dwMachineNumber 机器号 【返回值】 成功返回True，否则返回False 【相关函数】 无

5.2.5.2 SetUserTmpEx

【函数定义】 VARIANT_BOOL SetUserTmpEx([in] LONG dwMachineNumber, [in] BSTR dwEnrollNumber, [in] LONG dwFingerIndex,[in] LONG Flag, [in] BYTE* TmpData) 【功能】

以二进制方式上传用户普通指纹模板或者胁迫指纹模板,和SetUserTmpExStr不同的仅是指纹模板格式不同而已,注意：机器上必须已存在该用户或者将用户信息同时上传，相同用户的相同索引号模板如果已经登记，则覆盖。注：要求机器固件支持胁迫指纹功能（固件内部版本号Ver6.60及以上）。

【参数】 dwMachineNumber 机器号 dwEnrollNumber 用户号 dwFingerIndex 指纹索引号

Flag

标示指纹模板是否有效或者是否为胁迫指纹， 0表示指纹模板无效，1表示指纹模板有效，3 表示为胁迫指纹 TmpData 指纹模板数据 TmpLength 指纹模板长度 【返回值】 成功返回True，否则返回False 【相关函数】 GetUserTmpEx， SSR_SetUserInfo，BeginBatchUpdate，BatchUpdate

5.2.5.3 SetUserTmpExStr

【函数定义】

VARIANT_BOOL SetUserTmpExStr([in] LONG dwMachineNumber, [in] BSTR dwEnrollNumber, [in] LONG dwFingerIndex,[in] LONG Flag, [in] BSTR TmpData) 【功能】

以字符串方式上传用户普通指纹模板或者胁迫指纹模板,和SetUserTmpEx不同的仅是指纹模板格式不同而已,注意：机器上必须已存在该用户或者将用户信息同时上传，相同用户的相同索引号模板如果已经登记，则覆盖。注：要求机器固件支持胁迫指纹功能（固件内部版本号Ver6.60及以上）。 【参数】 dwMachineNumber 机器号 dwEnrollNumber 用户号 dwFingerIndex 指纹索引号

Flag

标示指纹模板是否有效或者是否为胁迫指纹， 0表示指纹模板无效，1表示指纹模板有效，3 表示为胁迫指纹 TmpData 指纹模板数据 TmpLength 指纹模板长度 【返回值】 成功返回True，否则返回False 【相关函数】

GetUserTmpExStr ，SSR_SetUserInfo，BeginBatchUpdate，BatchUpdate

5.2.5.4 GetUserTmpEx

【函数定义】 VARIANT_BOOL GetUserTmpEx([in] LONG dwMachineNumber, [in] BSTR dwEnrollNumber, [in] LONG dwFingerIndex,[out] LONG * Flag, [out] BYTE* TmpData, [out] LONG* TmpLength) 【功能】

以二进制方式下载用户普通指纹模板或者胁迫指纹模板,和GetUserTmpExStr不同的仅是指纹模板格式不同而已。注：要求机器固件支持胁迫指纹功能（固件内部版本号Ver6.60及以上）。 【参数】 dwMachineNumber 机器号 dwEnrollNumber 用户号 dwFingerIndex 指纹索引号

Flag

标示指纹模板是否有效或者是否为胁迫指纹， 0表示指纹模板无效，1表示指纹模板有效，3 表示为胁迫指纹

TmpData 指纹模板数据 TmpLength 指纹模板长度 【返回值】 成功返回True，否则返回False 【相关函数】 SetUserTmpEx，SSR_GetUserInfo

5.2.5.5 GetUserTmpExStr

【函数定义】

VARIANT_BOOL GetUserTmpExStr([in] LONG dwMachineNumber, [in] BSTR dwEnrollNumber, [in] LONG dwFingerIndex,[out] LONG * Flag, [out] BSTR* TmpData, [out] LONG* TmpLength) 【功能】

以字符串方式下载用户普通指纹模板或者胁迫指纹模板,和GetUserTmpEx不同的仅是指纹模板格式不同而已。注：要求机器固件支持胁迫指纹功能（固件内部版本号Ver6.60及以上）。 【参数】 dwMachineNumber 机器号 dwEnrollNumber 用户号 dwFingerIndex 指纹索引号

Flag

标示指纹模板是否有效或者是否为胁迫指纹， 0表示指纹模板无效，1表示指纹模板有效，3 表示为胁

迫指纹 TmpData 指纹模板数据 TmpLength 指纹模板长度 【返回值】 成功返回True，否则返回False 【相关函数】 SetUserTmpExStr，SSR_GetUserInfo

5.2.5.6 SSR_DelUserTmp

【函数定义】

VARIANT_BOOL SSR_DelUserTmp([in] LONG dwMachineNumber, [in] BSTR dwEnrollNumber, [in] LONG dwFingerIndex) 【功能】 删除用户指纹模板 【参数】 dwMachineNumber 机器号 dwEnrollNumber 用户号 dwFingerIndex

指纹索引号，一般范围为0-9

【返回值】 成功返回True，否则返回False 【相关函数】 SSR_SetUserTmp、SSR_GetUserTmp

5.2.5.7 SSR_DelUserTmpExt

【函数定义】

VARIANT_BOOL SSR_DelUserTmpExt([in] LONG dwMachineNumber, [in] BSTR dwEnrollNumber, [in] LONG dwFingerIndex) 【功能】 删除指定用户的指纹模板，和DelUserTmp的区别在与前者可以支持24位的用户号 【参数】 dwMachineNumber 机器号 dwEnrollNumber 用户号 dwFingerIndex

指纹索引，一般范围为0－9，当该值为13时删除该用户的所有指纹

【返回值】 成功返回True，否则返回False 【相关函数】

SSR_DelUserTmp

5.2.6面部数据相关

5.2.6.1 SetUserFace 【函数定义】

VARIANT_BOOL SetUserFace([in]LONG dwMachineNumber,[in]BSTR dwEnrollNumber,[in] LONG dwFaceIndex, [in] BYTE* TmpData,[in] LONG TmpLength)

【功能】 上传用户人脸模板，和SetUserFaceStr不同的只是人脸模板格式不同而已 【参数】 dwMachineNumber

机器号 dwEnrollNumber 用户号（不超过24位） dwFaceIndex 人脸索引，该参数只能为50，代表上传该用户所有人脸模板 TmpData 人脸模板 TmpLength

人脸模板长度

【返回值】 成功返回True，否则返回False 【相关函数】 GetUserFace、DelUserFace、SetUserFaceStr、GetUserFaceStr

5.2.6.2 GetUserFace 【函数定义】

VARIANT_BOOL GetUserFace([in]LONG dwMachineNumber, [in] BSTR dwEnrollNumber, dwFaceIndex, [out] BYTE* TmpData, [out] LONG * TmpLength)

【功能】 下载人脸模板，该函数和GetUserFaceStr不同的只是返回的人脸模板格式不同而已 【参数】 dwMachineNumber

机器号 dwEnrollNumber 用户号（不超过24位） dwFaceIndex 人脸索引，该参数只能为50，代表下载该用户所有人脸模板 TmpData 该参数返回人脸模板 TmpLength

该参数返回人脸模板长度

【返回值】

[in] LONG 成功返回True，否则返回False 【相关函数】 SetUserFace、DelUserFace、SetUserFaceStr、GetUserFaceStr

5.2.6.3 DelUserFace 【函数定义】

VARIANT_BOOL DelUserFace([in] LONG dwMachineNumber, [in] BSTR dwEnrollNumber, [in] LONG dwFaceIndex)

【功能】 删除用户人脸模板 【参数】 dwMachineNumber

机器号 dwEnrollNumber 用户号（不超过24位） dwFaceIndex 人脸索引，该参数只能为50，代表删除该用户所有人脸模板

【返回值】 成功返回True，否则返回False 【相关函数】 GetUserFace、SetUserFace、SetUserFaceStr、GetUserFaceStr

5.2.6.4 GetUserFaceStr

【函数定义】

VARIANT_BOOL GetUserFaceStr([in]LONG dwMachineNumber,[in]BSTR dwEnrollNumber, [in]LONG dwFaceIndex, [out]BSTR* TmpData, [out]LONG * TmpLength) 【功能】

下载人脸模板,和GetUserFace不同的是本函数以字符串形式返回人脸模板 【参数】 dwMachineNumber 机器号 dwEnrollNumber 用户号（不超过24位） dwFaceIndex 人脸索引，该参数只能为50，代表下载该用户所有人脸模板 TmpData 该参数返回人脸模板 TmpLength 该参数返回人脸模板长度 【返回值】 成功返回True，否则返回False 【相关函数】 GetUserFace、SetUserFace、SetUserFaceStr、

5.2.6.5 SetUserFaceStr

【函数定义】

VARIANT_BOOL SetUserFaceStr([in] LONG dwMachineNumber, [in] BSTR dwEnrollNumber, [in] LONG dwFaceIndex, [in]BSTR TmpData, [in] LONG TmpLength) 【功能】

上传用户人脸模板，和SetUserFace不同的只是人脸模板格式不同而已 【参数】 dwMachineNumber 机器号 dwEnrollNumber 用户号（不超过24位） dwFaceIndex 人脸索引，该参数只能为50，代表上传该用户所有人脸模板 TmpData 人脸模板 TmpLength 人脸模板长度 【返回值】 成功返回True，否则返回False 【相关函数】 SetUserFace、GetUserFaceStr、GetUserFace

5.2.7 其他

5.2.7.1 GetFPTempLength

【函数定义】

GetFPTempLength([in] BYTE* dwEnrollData, [out] long * Len) 【功能】 计算指定指纹模板长度 【参数】 dwEnrollData 指向指纹模板的指针 Len 该参数返回由dwEnrollData描述的指纹模板的长度 【返回值】 成功返回True，否则返回False 【相关函数】 GetFPTempLengthStr

5.2.7.2 GetFPTempLengthStr

【函数定义】 GetFPTempLengthStr([in] BSTR dwEnrollData, [out] long * Len) 【功能】

计算指定指纹模板长度

【参数】 dwEnrollData 字符串形式表示的指纹模板 Len 该参数返回由dwEnrollData描述的指纹模板的长度 【返回值】 成功返回True，否则返回False 【相关函数】 GetFPTempLength

5.2.7.3 FPTempConvert

【函数定义】

VARIANT_BOOL FPTempConvert([in] BYTE* TmpData1, [out] BYTE* TmpData2, [out] long *Size) 【功能】

脱机指纹模板转换为BIOKEY指纹模板，和FPTempConvertStr的区别在于数据格式不同而已 【参数】 TmpData1 欲转换的脱机指纹模板 TmpData2 该参数返回转换后的BIOKEY指纹模板 Size 该参数返回转换后的BIOKEY指纹模板的大小 【返回值】 成功返回True，否则返回False 【相关函数】 FPTempConvertStr、FPTempConvertNew、FPTempConvertNewStr

5.2.7.4 FPTempConvertStr

【函数定义】

VARIANT_BOOL FPTempConvertStr([in] BSTR TmpData1,[out]BSTR* TmpData2, [out] long *Size) 【功能】

以字符串形式将脱机指纹模板转换为BIOKEY指纹模板，和FPTempConvert的区别在于数据格式不同而已 【参数】 TmpData1 欲转换的脱机指纹模板 TmpData2 该参数返回转换后的BIOKEY指纹模板 Size 该参数返回转换后的BIOKEY指纹模板的大小 【返回值】 成功返回True，否则返回False 【相关函数】 FPTempConvert、FPTempConvertNew、FPTempConvertNewStr

5.2.7.5 FPTempConvertNew

【函数定义】

VARIANT_BOOL FPTempConvertNew([in] BYTE* TmpData1, [out] BYTE* TmpData2, [out] long *Size) 【功能】

将BIOKEY指纹模板转换为脱机指纹模板，和FPTempConvertNewStr的区别在于数据格式不同而已 【参数】 TmpData1 欲转换的脱机指纹模板 TmpData2 该参数返回转换后的脱机指纹指纹模板 Size 该参数返回转换后的脱机指纹模板的大小 【返回值】 成功返回True，否则返回False 【相关函数】 FPTempConvertNewStr、FPTempConvert、FPTempConvertStr

5.2.7.6 FPTempConvertNewStr

【函数定义】

VARIANT_BOOL FPTempConvertNewStr([in] BSTR TmpData1, [out] BSTR* TmpData2, [out] long *Size) 【功能】

以字符串形式将将BIOKEY指纹模板转换为脱机指纹模板，和FPTempConvertNew的区别在于数据格式不同而已 【参数】 TmpData1 欲转换的脱机指纹模板 TmpData2 该参数返回转换后的脱机指纹指纹模板 Size 该参数返回转换后的脱机指纹模板的大小 【返回值】 成功返回True，否则返回False 【相关函数】 FPTempConvertNew、FPTempConvert、FPTempConvertStr

5.2.8系统数据管理相关

5.2.8.1 ClearKeeperData

【函数定义】

VARIANT_BOOL ClearKeeperData([in] long dwMachineNumber) 【功能】

清楚机器内所有的数据 【参数】 dwMachineNumber

机器号 【返回值】

成功返回True,否则返回False 【相关函数】

ClearGLog，ClearSLog

5.2.8.2 ClearData

【函数定义】

VARIANT_BOOL ClearData([in] LONG dwMachineNumber, [in] LONG DataFlag) 【功能】 清除机器内由DataFlag指定的记录 【参数】 dwMachineNumber 机器号 DataFlag 该参数指定需清除的记录类型，范围为1—5，具体含义如下

1 考勤记录 2 指纹模板数据 3 无

4 操作记录 5 用户信息

当该参数为5时，即删除机器内所有用户，注：此操作同时会删除机器内所有指纹模板

【返回值】 成功返回True，否则返回False 【相关函数】 ClearKeeperData

5.2.8.3 GetDataFile

【函数定义】

VARIANT_BOOL GetDataFile([in] LONG dwMachineNumber, [in] LONG DataFlag, [in] BSTR FileName) 【功能】 从机器获取指定数据文件 【参数】 dwMachineNumber 机器号 DataFlag 需要获取的数据文件类型

1 考勤记录数据文件 2 指纹模板数据文件 3 无

4 操作记录数据文件 5 用户信息数据文件 6 短消息数据文件

7 短消息与用户关系的数据文件

8 9 扩展用户信息数据文件 Workcode信息数据文件

FileName 接收到获取的数据文件存储文件名 【返回值】 成功返回True，否则返回False 【相关函数】 SaveTheDataToFile

5.2.8.4 SendFile

【函数定义】 VARIANT_BOOL SendFile([in] LONG dwMachineNumber,[in] BSTR FileName) 【功能】

发送文件到机器，一般发送到/mnt/mtdblock/下，彩屏机如传的是用户照片或宣传图片，需命名为以下格式：图片会自动被转移到相应目录下。

宣传图片命名方式：“ad_”为前缀,后加数字，范围为1－20，后缀为.jpg，如ad_4.jpg 用户照片命名方式：“用户ID”+“.jpg”，如1.jpg 【参数】 dwMachineNumber 机器号 FileName 要发送的文件名 【返回值】 成功返回True，否则返回False 【相关函数】 无

5.2.8.5 RefreshData

【函数定义】 VARIANT_BOOL RefreshData([in] long dwMachineNumber) 【功能】

刷新机器内数据，一般在上传用户信息或指纹后调用，这样能使所作的修改立即起作用，起到同步作用。 【参数】 dwMachineNumber 机器号 【返回值】 成功返回True,否则返回False 【相关函数】 无

本文来源：https://www.bwwdw.com/article/cjv7.html