Sie sind auf Seite 1von 48

Users Manual of OTA710C SDK

FKAttend.DLL Port 2.1 Connection and Disconnection of Machine 2.1.1 ConnectComm Format: long ConnectComm(long nMachineNumber, long nComPort,

long nBaudRate, char * pstrTelNumber, long nWaitDialTime, long nLicense) Function: Parameter: Open COM port for machine through RS-232-/485 nMachineNumber The machine No. that will be connected

nComPort COM port No. nBaudRate COM communication baudrate pstrTelNumber telephone No. nWaitDialTime telephone connection waiting time (unit ms) nLicense connection license Return: Operating return successfully 1.erro code for return fail please see 4.2 error code table Other: 1."pstrTelNumber" and "nWaitDialTime"Is through the Function that Modem is connecting, if no Modem, then input 0. 2."nLicense" It to each agent, its the license that our company provide, without this number then cant connect to machine.
1

2.1.2 ConnectNet Format: long ConnectNet(long nMachineNumber, char * strIpAddress,

long nPort, long nTimeOut, long nProtocolType, long nNetPassword, long nLicense) Function: Open the net port when connect machine through network cable. Parameter: nMachineNumber Machine No. that will be connected.

strIpAddress TCP/IP address of machine which will be connect nPort net port number nTimeOut connection waiting time (unit ms) nProtocolType communication protocol category nNetPassword Net Communication password nLicense. Connection License No. Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Other: 1. If the machine isnt connected with network please according to nTimeOut time return to error code after standby. 2. nProtcocolType The specified types of network communications protocol
2

0: PROTOCOL_TCPIP - TCP/IP communication 1: PROTOCOL_UDP - UDP communication 3 ."nLicense" is the same with2.1.1 ConnectComm.

2.1.3 ConnectUSB Format: long ConnectUSB(long nMachineNumber, long nLicense)

Function: Using USB cable to connect with computer, open USB port. Parameter: nMachineNumber The machine No. that will be connected.

nLicense Connection License No. Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others:1 ."nLicense" is the same with2.1.1 ConnectComm.

2.1.4 DisConnect Format: void DisConnect(void)

Function: Disconnection with machine Others: 1. Turn off the machine which is connected with ConnectComm or ConnectNet, that is close the corresponding port.

2.2 Register Data Management


3

2.2.1 GetEnrollData Format: long GetEnrollData(long anEnrollNumber, long

anBackupNumber, long *apnMachinePrivilege, long *apnEnrollData, long *apnPassWord) Function: Get the users operating authority and registration information. Parameter: anEnrollNumber register No.

anBackupNumber register information and catalogues No. apnMachinePrivilege The parameters indicator of the users operating authority. apnEnrollData The parameters indicator of fingerprint data. apnPassWord The parameters indicator of password or card No.data. Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table

Others: 1.According to anBackupNumber corresponding register data return to apnEnrollData or apnPassWord. Return to the meaning of the operation authority of apnMachinePrivilege please refer to 2.4.2ModifyPrivilege

3. Each user can register 3 fingerprints and one password or card No., this registration information is reflected in "anBackupNumber" The meaning of "anBackupNumber" as following : 0: BACKUP_FP_0 - The first fingerprint area that has been registered. 1: BACKUP_FP_1 The second fingerprint area that has been registered. 2: BACKUP_FP_2 The third fingerprint area that has been registered. 10 : BACKUP_PSW - The registered No. 11 : BACKUP_CARD - The registered card No.

2.2.2 GetEnrollDataWithString Format: long GetEnrollDataWithString(long anEnrollNumber, long

anBackupNumber, long *apnMachinePrivilege, char * apstrEnrollData) Function It is similar with GetEnrollData command, obtaining registration information in the form of text column. Parameter anEnrollNumber register No. anBackupNumber register information category No. apnMachinePrivilege The parameter indicator of users operation authority
5

apstrEnrollData The parameter indicator of registering information Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others: 1. It has nothing with anBackupNumber, return to apstrEnrollData after registering information.

2.2.3 PutEnrollData Format: long PutEnrollData(long anEnrollNumber, long anBackupNumber, long anMachinePrivilege, long *apnEnrollData, long anPassword) Function Send the users operating authority and registration information which will be registered to machine. Parameter anEnrollNumber register No. anBackupNumber Register information, category No. anMachinePrivilege users operation authority apnEnrollData parameter indicator of fingerprint data anPassword Password or card No. data Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others1."anBackupNumber" please refer to2.2.1 GetEnrollData.
6

2."anMachinePrivilege" please refer to2.4.2 ModifyPrivilege. 3.According to "anBackupNumber" send. "apnEnrollData" or "apnPassword" data. 4. Only after implementing command then implement SaveEnrollData command can save machines transmit data. SaveEnrollData command please refer to2.2.5 SaveEnrollData.

2.2.4 PutEnrollDataWithString Format :long PutEnrollDataWithString(long anEnrollNumber, long anBackupNumber, long anMachinePrivilege, BSTR apstrEnrollData) Function It is similar with PutEnrollData command, registration information will be recorded in the form of text columns Parameter anEnrollNumber register No. anBackupNumber register information, category No. anMachinePrivilege users operating authority apstrEnrollData parameter indicator of registration information Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others1. Dont care about anBackupNumber, register registration data
7

directly on apstrEnrollData.

2.2.5 SaveEnrollData Format : long SaveEnrollData(void) Function Using PutEnrollData or PutEnrollDataWithString Command registers the transmitted registration information to machine Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others: 1. Before using this command, use PutEnrollData or PutEnrollDataWithString command to transmit the data which will be registered to machine.

2.2.6 DeleteEnrollData Format : long DeleteEnrollData(long anEnrollNumber, long anBackupNumber) Function Delete the specified registration information ParameteranEnrollNumber register No. anBackupNumber register information, category No.

Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code
8

Table Others: 1. If there isnt specified data in machine, this command will fail.

2.2.7 USBReadAllEnrollDataFromFile Format : long USBReadAllEnrollDataFromFile(char *apstrFilePath) Function Read the data in machine to PC memory. ParameterapstrFilePath document name Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others: 1. It will implement fail if the document structure is wrong 2. Please refer to machine users manual about the using of USB memory on machine.

2.2.8 USBReadAllEnrollDataCount Format : long USBReadAllEnrollDataCount(long *apnValue) Function Reading the registration information in PC memory by USBReadAllEnrollDataFromFile command. ParameterapnValue parameter indicator of registration information Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table
9

Others: 1. Before using this command please use USBReadAllEnrollDataFromFile command to read information.

2.2.9 USBGetOneEnrollData Format :long USBGetOneEnrollData(long *apnEnrollNumber, long *apnBackupNumber, long *apnMachinePrivilege, long *apnEnrollData, long *apnPassWord, long *apnEnableFlag) Function Get the registration information which is read by USBReadAllEnrollDataFromFile command. ParameterapnEnrollNumber parameter indicator of register No. apnBackupNumber parameter indicator of registering information, category No. apnMachinePrivilege parameter indicator of users operating authority. apnEnrollData parameter indicator of fingerprint data. apnPassWord parameter indicator of password or card No. data apnEnableFlag parameter indicator of users machine license. Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table
10

Others: 1. This command is similar with GetEnrollData, the difference is tat its not connected directly, only using USB memory. About the explanation of GetEnorollData command please refer to 2.2.1 GetEnrollData. 2. Return to RUNERR_LOG_END after getting data. 3.If there isnt data in USB, then the command is fail. 4."apnEnableFlag" explanation please refer to 2.4.1 EnableUser.

2.2.10 USBGetOneEnrollDataWithString Format : long USBGetOneEnrollDataWithString(long *apnEnrollNumber, long *apnBackupNumber, long *apnMachinePrivilege, BSTR* apstrEnrollData, long *apnEnableFlag) Function: It is similar with USBGetOneEnrollData, the registration information will be obtained in the form of text column. Parameter: apnEnrollNumber parameter indicator of registering No. apnBackupNumber parameter indicator of registration information, category No. apnMachinePrivilege parameter indicator of users operating authority
11

apstrEnrollData parameter indicator of registering information. apnEnableFlag parameter indicator of users machine license. Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others 1. This command is similar with GetEnrollDataWithString

command The difference is that its not connected directly, only using USB memory. About the GetEnrollDataWithString please refer to 2.2.2GetEnrollDataWithString. 2. Other instruction please refer to 2.2.9 USBGetOneEnrollData.

2.2.11 USBSetOneEnrollData Format : long USBSetOneEnrollData(long anEnrollNumber, long anBackupNumber, long anMachinePrivilege, long *apnEnrollData, long anPassWord, long anEnableFlag) Function: Convert to USB memory document for users operating authority and registration information, formalizing on PC memory. Parameter: anEnrollNumber Register No.

anBackupNumber Register information, category No.


12

anMachinePrivilege Users operating authority apnEnrollData Parameter indicator of fingerprint data. anPassWord Parameter indicator of password of card No. data. anEnableFlag Parameter indicator of users machine license Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others: 1. This command is similar with PutEnrollData command, the difference is that its not connected directly, only using USB memory. About the PutEnrollData command please refer to 2.2.3 PutEnrollData. 2.Explanation about "anEnableFlag" please refer to 2.4.1 EnableUser.

2.2.12 USBSetOneEnrollDataWithString Format: long USBSetOneEnrollDataWithString(long anEnrollNumber,

long anBackupNumber, long anMachinePrivilege, BSTR apstrEnrollData, long anEnableFlag) Function: It is the same with USBSetOneEnrollData command,register the registration information in the form of text column. Function: anEnrollNumber Register No.
13

anBackupNumber Register information, category No. anMachinePrivilege Users operating authority. apstrEnrollData Parameter indicator of registration information. anEnableFlag Parameter indicator of users machine license. Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others: 1.This command is similar with PutEnrollDataWithString,

the difference is that its not connected directly, only using USB memory. About the PutEnrollDataWithString command please refer to 2.2.4 PutEnrollDataWithString. 2. Other instruction please refer to 2.2.11 USBSetOneEnrollData.

2.2.13 USBWriteAllEnrollDataToFile Format: long USBWriteAllEnrollDataToFile(char *apstrFilePath)

Function: Using USBSetOneEnrollData or USBSetOneEnrollDataWithString command to make formalizing registration data document in PC memory. Parameter: apstrFilePath document name

Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table
14

Others: 1. Before using this command, you have to use the formalizing data which is made by USBSetOneEnrollData or USBSetOneEnrollDataWithString command.

2.2.14 ReadAllUserID Format: long ReadAllUserID(void)

Function: Read all machines user information data to PC memory. Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others: 1. The read users information will be obtained by GetAllUserID command. About the GetAllUserID command please refer to 2.2.15 GetAllUserID.

2.2.15 GetAllUserID Format: long GetAllUserID(long *apnEnrollNumber, long

*apnBackupNumber, long *apnMachinePrivilege, long *apnEnableFlag) Function: Will pass the users information read bye ReadAllUserID, obtained one bye one. Parameter apnEnrollNumber Parameter indicator for registering No. apnBackupNumber Parameter indicator for registering information
15

category No. apnMachinePrivilege Parameter indicator for users operating authority. apnEnableFlag Parameter indicator of users machine license Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others: 1. The users information which cant read by ReadAllUserID, the command will fail. 2. Return to RUNERR_LOG_END after obtaining data. 3. Return to "apnMachinePrivilege" operating authority please refer to 2.4.2 ModifyPrivilege 4.Instruction about "apnEnableFlag" please refer to 2.4.1 EnableUser.

2.2.16 EmptyEnrollData Format: long EmptyEnrollData(void)

Function: Delete all registration information which are registered. Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others: 1. Because it will clear all registration information, please
16

backup registration information before implement this command.

2.2.17 ClearKeeperData Format: long ClearKeeperData(void)

Function: Delete all registration information and records data in machine( Initialize machine function) Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others: 1. Because this will delete all registration information and records data, please backup important registration information before implementing this command.

2.2.18 BenumbAllManager Format: long BenumbAllManager(void)

Function: Delete all the Manager information, change the Manager to User. Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table 2.3 2.3 Records data management 2.3.1 LoadSuperLogData
17

Format:

long LoadSuperLogData(long anReadMark)

Function: Read management records from machine to PC memory to analyze. Parameter: anReadMark Read mark

Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others: 1. The data which was read can be obtained by

GetSuperLogData, please refer to 2.3.3 GetSuperLogData. anReadMark = 1 Read the new added records data anReadMark = 0 Read all records data

2.3.2 USBLoadSuperLogDataFromFile Format: long USBLoadSuperLogDataFromFile(char *apstrFilePath)

Function: Read the data in machine to PC memory. Parameter: apstrFilePath document file

Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others: 1.Its similar with LoadSuperLogData, you can obtain

management records data when disconnect with PC. 2. If the document structure is wrong, the implementation of this
18

command will fail. 3. The using of machine USB please refer to User Manuel.

2.3.3 GetSuperLogData Format: long GetSuperLogData(long *apnSEnrollNumber, long

*apnGEnrollNumber, long *apnManipulation, long *apnBackupNumber, DATE *apnDateTime) Function: Through LoadSuperLogData or USBLoadSuperLogDataFromFile command to read the management records in PC memory, obtained one by one. Parameter: apnSEnrollNumber Parameter indicator of managers registration No. apnGEnrollNumber Parameter indicator of subordinates registration No. Parameter indicator of apnManipulation Parameter indicator of management objects identification No. apnBackupNumber Parameter indicator of subordinates registration information category No. apnDateTime manage records data, parameter indicator of time Return: It implements return successfully 1. the error code for return fail.
19

Error code detail explanation please refer to 4.2 Error Code Table Others: 1. Return to RUNERR_LOG_END after obtaining data. 2. Implement LoadSuperLogData or USBLoadSuperLogDataFromFile first, or this command will fail. 3."apnManipulation" as following : 3: LOG_ENROLL_USER - User registration 4: LOG_ENROLL_MANAGER Manager registration 5: LOG_ENROLL_DELFP- Delete fingerprint data 6: LOG_ENROLL_DELPASS- Delete the registered password 7: LOG_ENROLL_DELCARD- Delete card data 8: LOG_LOG_ALLDEL Delete all records data 9 : LOG_SETUP_SYS- Modify machine information 10 : LOG_SETUP_TIME- Modify machine time 11 : LOG_SETUP_LOG- Modify records limit value 12 : LOG_SETUP_COMM- Modify communication protocol 13 : LOG_PASSTIME Time set successfully 14 : LOG_SETUP_DOOR- Door operating information set

2.3.4 EmptySuperLogData Format: long EmptySuperLogData(void)

Function: Delete all management records data from machine


20

Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others: 1. Because it will delete all management records data, please

backup important registration information before implementing this command.

2.3.5 LoadGeneralLogData Format: long LoadGeneralLogData(long anReadMark) Function: Read in/out records in machine to PC memory to analyze. Parameter: anReadMark Read mark

Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others: 1. The read data can be obtained by GetGeneralLogData. 2.3.7 GetGeneralLogData 2. anReadMark = 1 read new records data anReadMark = 0 read all data

2.3.6 USBLoadGeneralLogDataFromFile Format: long USBLoadGeneralLogDataFromFile(BSTR apstrFilePath)

Function: Read the data in machine to PC memory.


21

Parameter:

apstrFilePath Document name

Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others: 1.It is similar with LoadGeneralLogData, using this command

to obtain in/out records data when its disconnection with PC. 2. If the document structure is wrong, the implementation of this command will fail. 3. The using of machine USB please refer to User Manuel.

2.3.7 GetGeneralLogData Format: long GetGeneralLogData(long *apnEnrollNumber, long

*apnVerifyMode, long *apnInOutMode, DATE *apnDateTime) Function: Through LoadGeneralLogData or USBLoadGeneralLogDataFromFile command to read in/out records in PC memory, obtained one by one. Parameter: apnEnrollNumber Parameter indicator of in/out user registration No. ApnVerifyMode Parameter indicator of verification ways apnInOutMode Parameter indicator of in/out ways apnDateTime In/out records date, parameter indicator of time.
22

Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others: 1. Return after obtaining data. 2.RUNERR_LOG_END. "apnVerifyMode" as following : 1: LOG_FPVERIFY- Fingerprint verification 2: LOG_PASSVERIFY- Password verification 3: LOG_CARDVERIFY- Card verification 4: LOG_FPPASS_VERIFY - Fingerprint +card verification 5: LOG_FPCARD_VERIFY - Fingerprint + card verification 6: LOG_PASSFP_VERIFY - Password + fingerprint verification 7: LOG_CARDFP_VERIFY - Card + fingerprint verification .(2.7 ) 10 : LOG_OPEN_DOOR- Send open door signal after verification 11 : LOG_CLOSE_DOOR- Send close door signal after verification 12 : LOG_OPEN_HAND- Send close door signal through door-open button 13 : LOG_OPEN_THREAT-Send open door signal when
23

anti-threat fingerprint verification 14 : LOG_PROG_OPEN- Send open door signal from machine 15 : LOG_PROG_CLOSE- Send close door signal from machine 16 : LOG_OPEN_IREGAL- Send illegal open door signal 17 : LOG_CLOSE_IREGAL- Send illegal close door signal

18 : LOG_OPEN_COVER- Open machine cover 19 : LOG_CLOSE_COVER- Close machine cover 3.First use LoadGeneralLogData or USBLoadGeneralLogDataFromFile command, otherwise this command will fail. 4."apnInOutMode" as following : 0: LOG_IOMODE_IN - In verification 1: LOG_IOMODE_OUT - Out verification

2:LOG_IOMODE_IO Normal verification

2.3.8 EmptyGeneralLogData Format: long EmptyGeneralLogData(void)

Function: Delete all in and out records data.


24

Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others: 1. Because this will delete all in and out records data, so please backup the important in and out records data before implementing this command.

2.4 User Information Management 2.4.1 EnableUser Format: long EnableUser(long anEnrollNumber, long

anBackupNumber, long anEnableFlag) Function: Set the machine is available or unavailable for user Parameter: anEnrollNumber Register No. anBackupNumber Register information, category No. anEnableFlag License mark Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others: 1 anEnableFlag = 0 unavailable anEnableFlag = 1 available.

2.4.2 ModifyPrivilege
25

Format: long ModifyPrivilege(long anEnrollNumber, long anBackupNumber, long anMachinePrivilege) Function: Set users machine operating authority Parameter: anEnrollNumber Register No.

anBackupNumber Register information, category No.

anMachinePrivilege Operating authority Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others: There are user and manager according to the users operating authority, the authority is reflect on "anMachinePrivilege". "anMachinePrivilege" as following : 0: MP_NONE -) User(only can be verified in machine) 1: MP_ALL - Manager.(it can operate users in machine)

2.4.3 GetUserName Format: long GetUserName(long anEnrollNumber, char

*apstrUserName) Function: Obtained the assigned user name Parameter: anEnrollNumber Register No.
26

apstrUserName Parameter indicator to store name Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others: 1."apstrUserName" Max. is 10byte(Max. 10 English letters or 5 other characters). 2. This command will fail without assigned name. Others: 1. 2.4.4 SetUserName Format: long SetUserName(long anEnrollNumber, char

*apstrUserName) Function: Assign name for users Parameter: anEnrollNumber Register No.

apstrUserName Parameter indicator including name Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others: 1."apstrUserName" Max. is 10byte(Max. 10 English letters or 5 other characters). 2. This command will fail without assigned name.

2.4.5 GetNewsMessage
27

Format:

long GetNewsMessage(long anNewsId, char *apstrNews)

Function: Obtain specified news from machine Parameter: anNewsId News identification No.

apstrNews Parameter indictor of news data Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others: 1."anNewsId" is specified news No., from '0~255. 2."apstrUserName" Max. name is 48byte(Max.48 English letters or24 other characters)

2.4.6 SetNewsMessage Format: long SetNewsMessage(long anNewsId, char *apstrNews)

Function: Set news in machine Parameter: anNewsId News identification No.

apstrNews Parameter indicator news data Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others: 1 Detail explanation please refer to 2.4.5 GetNewsMessage.

2.4.7 GetUserNewsID
28

Format:

long GetUserNewsID(long anEnrollNumber, long *apnNewsId)

Function: Obtain identification No. of assigning notice for users. Parameter: anEnrollNumber Register No. apnNewsId Parameter indicator of recognizing No. Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others:1 "apnNewsId" is set in2.4.6 SetNewsMessage. 2.4.8 SetUserNewsID Format: long SetUserNewsID(long anEnrollNumber, long anNewsId)

Function: The identification No. of assigning notice for users Parameter: anEnrollNumber Register No.

anNewsId Identification No. Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others: 1 "apnNewsId" is set in2.4.6 SetNewsMessage.

2.5 Device Management 2.5.1 EnableDevice Format: long EnableDevice(long anEnabledFlag) Function: Set available or unavailable for device
29

Parameter:

anEnabledFlag License mark

Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others: 1. To stop the connection between PC and machine. 2.anEnabledFlag=0 Stop display Working news. anEnabledFlag=1 It means allow to operate device, display normal interface.

2.5.4 GetDeviceTime Format: long GetDeviceTime(DATE* apnDateTime)

Function: Obtain machine date and time. Parameter: apnDateTime Parameter indicator of date and time.

Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table

2.5.5 SetDeviceTime Format: long SetDeviceTime(DATE anDateTime)

Function: Set device date and time. Parameter: apnDateTime Date, time

Return: It implements return successfully 1. the error code for return fail.
30

Error code detail explanation please refer to 4.2 Error Code Table 2.5.6 GetDeviceStatus Format: long GetDeviceStatus(long anStatusIndex, long *apnValue)

Function: Obtain the status value which is stored in machine now. Parameter: anStatusIndex Recognizing No. of machine status apnValue Parameter indicator of status value Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others: 1. The function of this command is to know device status from PC. 2."anStatusIndex" as following : 1: GET_MANAGERS - the numbers of existing managers 2: GET_USERS- the numbers of existing users

3: GET_FPS- the numbers of existing fingerprints data 4: GET_PSWS-the numbers of existing password data 5: GET_SLOGS- the numbers of existing new manage records data 6: GET_GLOGS- the numbers of existing in and out records data
31

7: GET_ASLOGS- the numbers of existing all manage records data 8: GET_AGLOGS- the numbers of existing all manage records data 9: GET_CARDS- the numbers of existing card data

2.5.7 GetDeviceInfo Format: long GetDeviceInfo(long anInfoIndex, long *apnValue)

Function: Obtain device information Parameter: anInfoIndex Recognizing No. of device information

apnValue Parameter indicator of information value Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others: 1 "anInfoIndex" as following : 1: DI_MANAGERS - Max. register number of managers 2: DI_MACHINENUM - Machine No. 3: DI_LANGAUGE the display language on machine 4: DI_POWEROFF_TIME- Set close power yourself 5: DI_LOCK_CTRL - Control lock operating 6: DI_GLOG_WARNING - Max. in and out records
32

When the registration value is smaller than this value, then it will alarm. 7: DI_SLOG_WARNING - The Max. number of managers When the registration value is smaller than this value, then it will alarm. 8: DI_VERIFY_INTERVALS- It can repeat confirm time intervals. No records if repeat confirm in this time 9: DI_RSCOM_BPS - COM communication baudrate , each baudrate value as following: BPS_9600 = 3 BPS_19200 = 4 BPS_38400 = 5 BPS_57600 = 6 BPS_115200 = 7 10: DI_DATE_SEPARATE- Date, time display form

2.5.8 SetDeviceInfo Format: long SetDeviceInfo(long anInfoIndex, long anValue)

Function: Set device information Parameter: anInfoIndex Recognizing No. of device information apnValue information value
33

Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others: 1The occurrence of "anInfoIndex"is the same with 2.5.7

GetDeviceInfo. 2.6 Ring Management Not all versions have this function. 2.6.1 GetDoorStatus Format: long GetDoorStatus(long *apnStatusVal)

Function: Obtain open door status. Parameter: apnStatusVal Parameter indicator of status value

Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others: 1 "apnStatusVal": as following: 1: DOOR_OPEND - Door has opened 2: DOOR_CLOSED - Door has closed. 3: DOOR_COMMNAD- Operating door operating command.

2.6.2 SetDoorStatus Format: long SetDoorStatus(long anStatusVal)

Function: Operate open door status


34

Parameter:

apnStatusVal status value

Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others: 1 "anStatusVal": as following: 2: DOOR_OPEND Open door 3: DOOR_CLOSED Close door

2.6.3 GetPassTime Format: long GetPassTime(long anPassTimeID, long

*apnPassTime,long anPassTimeSize) Function: Obtain Timezone information of opening door/closing door Parameter: anPassTimeID Identification No. fo Timezone information

apnPassTime Parameter indicator of Timezone information structure. anPassTimeSize The length of Timezone information structure Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others: 1."anPassTimeID" The No. of Timezone information structure Max. you can set 50 structures, the value is '0'~'49'. 2."apnPassTime" reflects the value of Timezone information
35

structure which is specified by "anPassTimeID" According to each week, this structure has 7 Timezone. 4.1.2 PASSCTRLTIME Struture.. 3."anPassTimeSize" is the length of "apnPassTime" which is to judge whether the API structure length can be provided or not.

2.6.4 GetPassTimeWithString Format: long GetPassTimeWithString(long anPassTimeID, char

*apstrPassTime) Function: Its the same with GetPassTime, Timezone information is return in the form of text column. Parameter: anPassTime Identification No. of Timezone information. apnPassTime Parameter indicator of time period information structure text column Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others: 1 Detail explanation please refer to 2.7.3 GetPassTime.

2.6.5 SetPassTime Format: long SetPassTime(long anPassTimeID, long

*apnPassTime,long anPassTimeSize)
36

Function: Set Timezone information of opening door and closing door Parameter: anPassTimeID Identification No. of Timezone information. apnPassTime Parameter indicator of Timezone information structure anPassTimeSize The length of Timezone information structure Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others: 1 Detail explanation please refer to2.7.3 GetPassTime.

2.6.6 SetPassTimeWithString Format: long SetPassTimeWithString(long anPassTimeID, char

*apstrPassTime) Function: Its the same with SetPassTime, The Timezone information is input in the form of test column. Parameter: anPassTimeID Identification No. of Timezone information apnPassTime Parameter indicator of time period information structure text column Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others: 1 Detail explanation please refer to 2.7.3 GetPassTime.
37

2.6.7 GetUserPassTime Format: long GetUserPassTime(long anEnrollNumber, long

*apnGroupID, long *apnPassTimeID, long anPassTimeIDSize) Function: Obtain the Timezone information group which assign to users and individual assigned Timezone information Parameter: anEnrollNumber Register No.

apnGroupID Parameter indicator of group No. apnPassTimeID Parameter indicator of Timezone information identification No. structure anPassTimeIDSize The length of identification No. structure Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Other: 1."apnGroupID" explanation please refer to 2.7.11 GetGroupPassTime. 2."apnPassTimeID" is a arranged combined structure which assign all Timezone information identification No. for users, the definition of the structure please refer to 4.1.3 USERPASSINFO STRUCTURE, explanation of identification No. please refer to 2.7.3 GetPassTime.
38

3."anPassTimeSize" is the length of "apnPassTime" which is provided to check whether the length of API structure is enough or not.

2.6.8 GetUserPassTimeWithString Format: long GetUserPassTimeWithString(long anEnrollNumber, long

*apnGroupID, char *apstrPassTimeID) Function: It is the same with GetUserPassTime command, return the identification No. structure in the form of text column. Parameter: anEnrollNumber Register No.

apnGroupID Parameter indicator of group No. apstrPassTimeID Parameter indicator of time period information structure text column

Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others: 1 Detail explanation please refer to2.7.7 GetUserPassTime.

2.6.9 SetUserPassTime Format: long SetUserPassTime(long anEnrollNumber, long anGroupID,


39

long *apnPassTimeID, long anPassTimeIDSize) Function: Set Timezone information group for users and assign Timezone information for each Parameter: anEnrollNumber Register No.

anGroupID Group No. apnPassTimeID Parameter indicator of Timezone information identification No.Structure anPassTimeIDSize The length of identification No. structure Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others: 1 Detail explanation please refer to 2.7.7 GetUserPassTime.

2.6.10 SetUserPassTimeWithString Format: long SetUserPassTimeWithString(long anEnrollNumber, long

anGroupID, char *apstrPassTimeID) Function: Its the same with SetUserPassTime commandinput identification No. structure in the form of text column. Parameter: anEnrollNumber Register No.

anGroupID Group No.


40

apstrPassTimeID Parameter indicator of time period information structure text column Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others: 1 Detail explanation please refer to2.7.7 GetUserPassTime.

2.6.11 GetGroupPassTime Format: long GetGroupPassTime(long anGroupID, long

*apnPassTimeID, long anPassTimeIDSize) Function: Obtain identification No. of each time period information in time period information group. Parameter: anGroupID Group No.

apnPassTimeID Parameter indicator of time period information verification No. structure. anPassTimeIDSize verify the length of No. structure Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others: 1. Combine several time periods then combine again in machine can be used. "anGroupID" is the groups No., it can set Man. 5 groups,
41

the value is '1'~'5'. 2. 2."apnPassTimeID" is the arrangement group structure which assign to each group time period information identification No.. Each group can set 3 structure identification No., the definition of structure please refer to 4.1.4GROUPPASSINFO STUCTRUE, explanation about the identification No. please refer to 2.7.3 GetPassTime. 3."anPassTimeIDSize"is the length of "apnPassTimeID" the API is used to judge whether the length of structure is enough or not.

2.6.12 GetGroupPassTimeWithString Format: long GetGroupPassTimeWithString(long anGroupID, char

*apstrPassTimeID) Function: It is the same with GetGroupPassTime commandit returns the identification No. structure in the form of text column. Parameter: anGroupID Group No.

apstrPassTimeID Parameter indicator of time period information identification No. structure text column Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others: 1 Detail explanation please refer to2.7.11

GetGroupPassTime.
42

2.6.13 SetGroupPassTime Format: long SetGroupPassTime(long anGroupID, long

*apnPassTimeID, long anPassTimeIDSize) Function: Identification No. of setting time period information in time period information group Parameter: anGroupID Group No.

apnPassTimeID Parameter indicator of time period information identification No.structure anPassTimeIDSize The length of identify No. structure Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others: 1 Detail explanation please refer to2.7.11

GetGroupPassTime.

2.6.14 SetGroupPassTimeWithString Format: long SetGroupPassTimeWithString(long anGroupID, char

*apstrPassTimeID) Function: It is the same with SetGroupPassTime command; input the identification No. structure in the form of text column.
43

Parameter:

anGroupID Group No.

apstrPassTimeID Parameter indicator of time period information identification No. structure text column Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others: 1 Detail explanation please refer to2.7.11

GetGroupPassTime.

2.6.15 GetGroupMatch Format: long GetGroupMatch(long *apnGroupMatch, long

anGroupMatchSize) Function: Obtain the door operating group in the group of time period information structure Parameter: group anGroupMatchSize The length of group structure Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others: Organize the group of time period information structure to be used for opening door/closing door operation. You can set Max.10 groups, "apnGroupMatch" is the arrangement group structure of this group.
44

apnGroupMatch Parameter indicator of group structure of

The definition of structure please refer to 4.1.5 GROUPMATCHINFO STRUCTURE. The items in structure are continuously descript the group No. For example: the combination of No.1 and No.3 is 13, the combination of No.1, No.3 and No.5 is 135 2. "anPassTimeIDSize" is the length of "apnPassTimeID", its provided to judge whether the length of API structure is enough or not.

2.6.16 GetGroupMatchWithString Format: long GetGroupMatchWithString(char *apstrGroupMatch)

Function: It is the same with GetGroupMatchTime command, it returns the group structure in the form of text column. Parameter: apstrGroupMatch Parameter indicator of group structure

text column in group Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others: 1 Detail explanation please refer to 2.7.15 GetGroupMatch.

2.6.17 SetGroupMatch Format: long SetGroupMatch(long *apnGroupMatch, long

anGroupMatchSize)
45

Function: Set the door operating group in the group of time period information structure. Parameter: group anGroupMatchSize The length of group structure Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others: 1 Detail explanation please refer to 2.7.15 GetGroupMatch. apnGroupMatch Parameter indicator of group structure in

2.6.18 SetGroupMatchWithString Format: long SetGroupMatchWithString(char *apstrGroupMatch)

Function: It is the same with SetGroupMatch commandit register group structure in the form of text column. Parameter: apstrGroupMatch Parameter indicator of group structure

text column in group Return: It implements return successfully 1. the error code for return fail. Error code detail explanation please refer to 4.2 Error Code Table Others: 1 Detail explanation please refer to 2.7.15 GetGroupMatch

4.2 Error Code Table 1RUN_SUCCESS


46

It means the command run successfully. 0RUNERR_NOSUPPORT Error code of the machine cant support the corresponding command. -1RUNERR_UNKNOWNERROR Error code of unknowing. -2RUNERR_NO_OPEN_COMM Error code of machine isnt connected. -3RUNERR_WRITE_FAIL Error code of machine cant transfer data. -4RUNERR_READ_FAIL Error code of cant read data from machine. -5RUNERR_INVALID_PARAM Error code of the reading parameter is not correct. -6RUNERR_NON_CARRYOUT Error code of the command runs fail. -7RUNERR_DATAARRAY_END Notice of finishing read data. -8RUNERR_DATAARRAY_NONE Error code of the data is not exist. -9RUNERR_MEMORY Error code of the PC memory is not enough. -10RUNERR_MIS_PASSWORD
47

Error code of the license No. which connect machine is not correct. -11RUNERR_MEMORYOVER Error code for machine memory is not enough. -12RUNERR_DATADOUBLE Error code of the registered No. is existing in machine data. -14RUNERR_MANAGEROVER Error code of no space in machine, cant register manager -15RUNERR_FPDATAVERSION Error code of the fingerprint data version is incorrect.

48