3.02.Data-Record.h File Reference

Detailed Description

Author

http://www.zkteco.com

Date

2017-10-01

copyright:

Copyright 2017 ZKTECO CO., LTD. All Rights Reserved.

Note

Functions
VARIANT_BOOL	SSR_SetDeviceData (LONG dwMachineNumber, BSTR TableName, BSTR Datas, BSTR Options)
VARIANT_BOOL	SSR_GetDeviceData (LONG dwMachineNumber, BSTR *Buffer, LONG BufferSize, BSTR TableName, BSTR FiledNames, BSTR Filter, BSTR Options)
VARIANT_BOOL	ReadGeneralLogData (LONG dwMachineNumber)
VARIANT_BOOL	ReadAllGLogData (LONG dwMachineNumber)
VARIANT_BOOL	GetGeneralLogData (LONG dwMachineNumber, LONG *dwTMachineNumber, LONG *dwEnrollNumber, LONG *dwEMachineNumber, LONG *dwVerifyMode, LONG *dwInOutMode, LONG *dwYear, LONG *dwMonth, LONG *dwDay, LONG *dwHour, LONG *dwMinute)
VARIANT_BOOL	SSR_GetGeneralLogData (LONG dwMachineNumber, BSTR *dwEnrollNumber, LONG *dwVerifyMode, LONG *dwInOutMode, LONG *dwYear, LONG *dwMonth, LONG *dwDay, LONG *dwHour, LONG *dwMinute, LONG *dwSecond, LONG *dwWorkcode)
VARIANT_BOOL	GetAllGLogData (LONGdwMachineNumber, LONG *dwTMachineNumber, LONG *dwEnrollNumber, LONG *dwEMachineNumber, LONG *dwVerifyMode, LONG *dwInOutMode, LONG *dwYear, LONG *dwMonth, LONG *dwDay, LONG *dwHour, LONG *dwMinute)
VARIANT_BOOL	GetGeneralLogDataStr (LONG dwMachineNumber, LONG *dwEnrollNumber, LONG *dwVerifyMode, LONG *dwInOutMode, BSTR *TimeStr)
VARIANT_BOOL	GetGeneralExtLogData (LONG dwMachineNumber, LONG *dwEnrollNumber, LONG *dwVerifyMode, LONG *dwInOutMode, LONG *dwYear, LONG *dwMonth, LONG *dwDay, LONG *dwHour, LONG *dwMinute, LONG *dwSecond, LONG *dwWorkCode, LONG *dwReserved)
VARIANT_BOOL	ClearGLog (LONG dwMachineNumber)
VARIANT_BOOL	ReadSuperLogData (LONG dwMachineNumber)
VARIANT_BOOL	ReadAllSLogData (LONG dwMachineNumber)
VARIANT_BOOL	GetSuperLogData (LONG dwMachineNumber, LONG *dwTMachineNumber, LONG *dwSEnrollNumber, LONG *Params4, LONG *Params1, LONG *Params2, LONG *dwManipulation, LONG *Params3, LONG *dwYear, LONG *dwMonth, LONG *dwDay, LONG *dwHour, LONG *dwMinute)
	GetAllSLogData (LONG dwMachineNumber, LONG *dwTMachineNumber, LONG *dwSEnrollNumber, LONG *dwSMachineNumber, LONG *dwGEnrollNumber, LONG *dwGMachineNumber, LONG *dwManipulation, LONG *dwBackupNumber, LONG *dwYear, LONG *dwMonth, LONG *dwDay, LONG *dwHour, LONG *dwMinute)
VARIANT_BOOL	ClearSLog (LONG dwMachineNumber)
VARIANT_BOOL	GetSuperLogData2 (LONG dwMachineNumber, LONG *dwTMachineNumber, LONG *dwSEnrollNumber, LONG *Params4, LONG *Params1, LONG *Params2, LONG *dwManipulation, LONG *Params3, LONG *dwYear, LONG *dwMonth, LONG *dwDay, LONG *dwHour, LONG *dwMinute, LONG *dwSecs)
VARIANT_BOOL	ClearKeeperData (LONG dwMachineNumber)
VARIANT_BOOL	ClearData (LONG dwMachineNumber, LONG DataFlag)
VARIANT_BOOL	GetDataFile (LONG dwMachineNumber, LONG DataFlag, BSTR FileName)
VARIANT_BOOL	SendFile (LONG dwMachineNumber, BSTR FileName)
VARIANT_BOOL	ReadFile (LONG dwMachineNumber, BSTR FileName, BSTR FilePath)
VARIANT_BOOL	RefreshData (LONG dwMachineNumber)
VARIANT_BOOL	ReadTimeGLogData (LONG dwMachineNumber, BSTR sTime, BSTR eTime)
VARIANT_BOOL	ReadNewGLogData (LONG dwMachineNumber)
VARIANT_BOOL	DeleteAttlogBetweenTheDate (LONG dwMachineNumber, BSTR sTime, BSTR eTime)
VARIANT_BOOL	DeleteAttlogByTime (LONG dwMachineNumber, BSTR sTime)

Function Documentation

SSR_SetDeviceData()

VARIANT_BOOL SSR_SetDeviceData	(	LONG	dwMachineNumber,
		BSTR	TableName,
		BSTR	Datas,
		BSTR	Options
	)

This function is applicable to an attendance machine on which the new firmware supports the PULL protocol. This function is used to set data, including the time segment, user information, and holiday settings. The data can be one or more records. If the primary key of an inserted record already exists, the original record will be overwritten.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID TableName BSTR [in] Data table name. For details about the available tables, see attachment 1 PULL Data Dictionary for the New Firmware. Datas BSTR [in] Data records. The data is in .txt format. Records are separated with \r\n, and fields with values are separated with \t. Options BSTR [in] It is left blank by default and for extension.

Returns

Value description:

name	type	description of value
True	BOOL	Function execution success
False	BOOL	Function execution failure

See also

Attention

Note

This interface is applicable to the new architecture firmware.

SSR_GetDeviceData()

VARIANT_BOOL SSR_GetDeviceData	(	LONG	dwMachineNumber,
		BSTR *	Buffer,
		LONG	BufferSize,
		BSTR	TableName,
		BSTR	FiledNames,
		BSTR	Filter,
		BSTR	Options
	)

This function is applicable to an attendance machine on which the new firmware supports the PULL protocol. This function is used to read data from the machine, including the punch records, time segments, user information, and holiday settings. The data can be one or more records.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID Buffer BSTR* [out] Buffer for storing returned data. The returned data is in .txt format and may contain multiple records, which are separated with \r\n. BufferSize LONG [in] Size of the buffer for storing returned data TableName BSTR [in] Data table name. For details about the available tables, see attachment 1 PULL Data Dictionary for the New Firmware. FiledNames BSTR [in] Field name list. The fields are separated with \t. * indicates all fields. The field names are on the first line in the returned data. Filter BSTR [in] Filter criteria for reading data. If the data is a character string in the format of "field name operator value", multiple filter criteria separated with a comma (,) are supported. The details are as follows: Options BSTR [in] Options

Returns

Value description:

name	type	description of value
True	BOOL	Function execution success
False	BOOL	Function execution failure

See also

Attention

Note

This interface is applicable to the new architecture firmware.

ReadGeneralLogData()

VARIANT_BOOL ReadGeneralLogData

(

LONG

dwMachineNumber

)

To read attendance records to the internal buffer of the PC. The function is the same as ReadAllGLogData.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID

Returns

Value description:

name	type	description of value
True	BOOL	Function execution success
False	BOOL	Function execution failure

See also

Attention

Note

Applicable to BW, TFT, and IFACE devices

ReadAllGLogData()

VARIANT_BOOL ReadAllGLogData

(

LONG

dwMachineNumber

)

To read attendance records to the internal buffer of the PC. The function is the same as ReadGeneralLogData.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID

Returns

Value description:

name	type	description of value
True	BOOL	Function execution success
False	BOOL	Function execution failure

See also

Attention

Note

Applicable to BW, TFT, and IFACE devices

GetGeneralLogData()

VARIANT_BOOL GetGeneralLogData	(	LONG	dwMachineNumber,
		LONG *	dwTMachineNumber,
		LONG *	dwEnrollNumber,
		LONG *	dwEMachineNumber,
		LONG *	dwVerifyMode,
		LONG *	dwInOutMode,
		LONG *	dwYear,
		LONG *	dwMonth,
		LONG *	dwDay,
		LONG *	dwHour,
		LONG *	dwMinute
	)

To read attendance records from the internal buffer one by one. Before using this function, execute ReadAllGLogData or ReadGeneralLogData to read the attendance records from the machine to the internal buffer of the PC. Each time this function is executed, the pointer moves to the next attendance record. This function is the same as GetAllGLogData. They differ only in the interface name for compatibility.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID dwTMachineNumber LONG* [out] Pointer that points to the LONG variable. Its value is the machine ID of an attendance record. dwEnrollNumber LONG* [out] Pointer that points to the LONG variable. Its value is the user ID of an attendance record. dwEMachineNumber LONG* [out] Pointer that points to the LONG variable. Its value is the machine ID of an attendance record. dwVerifyMode LONG* [out] Pointer that points to the LONG variable. Its value is the verification mode of an attendance record. dwInOutMode LONG* [out] Pointer that points to the LONG variable. Its value is the attendance status of an attendance record. dwYear LONG* [out] Pointer that points to the LONG variable. Its value is the year of an attendance record. dwMonth LONG* [out] Pointer that points to the LONG variable. Its value is the month of an attendance record. dwDay LONG* [out] Pointer that points to the LONG variable. Its value is the day of an attendance record. dwHour LONG* [out] Pointer that points to the LONG variable. Its value is the hour of an attendance record. dwMinute LONG* [out] Pointer that points to the LONG variable. Its value is the minute of an attendance record.

Returns

Value description:

name	type	description of value
True	BOOL	Function execution success
False	BOOL	Function execution failure

See also

Attention

1. The dwVerifyMode parameter specifies the verification mode. The values are described as follows:
Generally:
0 indicates password verification, 1 indicates fingerprint verification and 2 indicates card verification.
Under multiple verification modes:
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

1. The dwInOutMode parameter specifies the attendance status. The values are described as follows:
   0¡ªCheck-In Default
   1¡ªCheck-Out
   2¡ªBreak-Out
   3¡ªBreak-In
   4¡ªOT-In
   5¡ªOT-Out
   

Note

Applicable to BW

SSR_GetGeneralLogData()

VARIANT_BOOL SSR_GetGeneralLogData	(	LONG	dwMachineNumber,
		BSTR *	dwEnrollNumber,
		LONG *	dwVerifyMode,
		LONG *	dwInOutMode,
		LONG *	dwYear,
		LONG *	dwMonth,
		LONG *	dwDay,
		LONG *	dwHour,
		LONG *	dwMinute,
		LONG *	dwSecond,
		LONG *	dwWorkcode
	)

To read attendance records from the internal buffer one by one. Before using this function, execute ReadAllGLogData or ReadGeneralLogData to read the attendance records from the machine to the internal buffer of the PC. Each time this function is executed, the pointer moves to the next attendance record. This function is the same as GetGeneralLogData. The difference is that this function applies to color-screen machines.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID dwEnrollNumber BSTR* [out] Pointer that points to the BSTR variable. Its value is the user ID of an attendance record. A user ID contains a maximum of 24 digits. dwVerifyMode LONG* [out] Pointer that points to the LONG variable. Its value is the verification mode of an attendance record. dwInOutMode LONG* [out] Pointer that points to the LONG variable. Its value is the attendance status of an attendance record. dwYear LONG* [out] Pointer that points to the LONG variable. Its value is the year of an attendance record. dwMonth LONG* [out] Pointer that points to the LONG variable. Its value is the month of an attendance record. dwDay LONG* [out] Pointer that points to the LONG variable. Its value is the day of an attendance record. dwHour LONG* [out] Pointer that points to the LONG variable. Its value is the hour of an attendance record. dwMinute LONG* [out] Pointer that points to the LONG variable. Its value is the minute of an attendance record. dwSecond LONG* [out] Pointer that points to the LONG variable. Its value is the second of an attendance record. dwWorkcode LONG* [out] Pointer that points to the LONG variable. Its value is the work code of an attendance record.

Returns

Value description:

name	type	description of value
True	BOOL	Function execution success
False	BOOL	Function execution failure

See also

Attention

1. The dwVerifyMode parameter specifies the verification mode. The values are described as follows:
Generally:
0 indicates password verification, 1 indicates fingerprint verification and 2 indicates card verification.
Under multiple verification modes:
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

1. The dwInOutMode parameter specifies the attendance status. The values are described as follows:
   0¡ªCheck-In Default
   1¡ªCheck-Out
   2¡ªBreak-Out
   3¡ªBreak-In
   4¡ªOT-In
   5¡ªOT-Out
   

Note

Applicable to TFT and IFACE devices

GetAllGLogData()

VARIANT_BOOL GetAllGLogData	(	LONGdwMachineNumber	,
		LONG *	dwTMachineNumber,
		LONG *	dwEnrollNumber,
		LONG *	dwEMachineNumber,
		LONG *	dwVerifyMode,
		LONG *	dwInOutMode,
		LONG *	dwYear,
		LONG *	dwMonth,
		LONG *	dwDay,
		LONG *	dwHour,
		LONG *	dwMinute
	)

To read attendance records from the internal buffer one by one. Before using this function, execute ReadAllGLogData or ReadGeneralLogData to read the attendance records from the machine to the internal buffer of the PC. Each time this function is executed, the pointer moves to the next attendance record. This function is the same as GetGeneralLogData. They differ only in the interface name for compatibility.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID dwTMachineNumber LONG* [out] Pointer that points to the LONG variable. Its value is the machine ID of an attendance record. dwEnrollNumber LONG* [out] Pointer that points to the LONG variable. Its value is the user ID of an attendance record. dwEMachineNumber LONG* [out] Pointer that points to the LONG variable. Its value is the machine ID of an attendance record. dwVerifyMode LONG* [out] Pointer that points to the LONG variable. Its value is the verification mode of an attendance record. dwInOutMode LONG* [out] Pointer that points to the LONG variable. Its value is the attendance status of an attendance record. dwYear LONG* [out] Pointer that points to the LONG variable. Its value is the year of an attendance record. dwMonth LONG* [out] Pointer that points to the LONG variable. Its value is the month of an attendance record. dwDay LONG* [out] Pointer that points to the LONG variable. Its value is the day of an attendance record. dwHour LONG* [out] Pointer that points to the LONG variable. Its value is the hour of an attendance record. dwMinute LONG* [out] Pointer that points to the LONG variable. Its value is the minute of an attendance record.

Returns

Value description:

name	type	description of value
True	BOOL	Function execution success
False	BOOL	Function execution failure

See also

GetGeneralLogData

Attention

1. The dwVerifyMode parameter specifies the verification mode. The meanings of the values are the same as those of the GetGeneralLogData parameter.

1. The dwInOutMode parameter specifies the attendance status. The meanings of the values are the same as those of the GetGeneralLogData parameter.
   

Note

Applicable to BW

GetGeneralLogDataStr()

VARIANT_BOOL GetGeneralLogDataStr	(	LONG	dwMachineNumber,
		LONG *	dwEnrollNumber,
		LONG *	dwVerifyMode,
		LONG *	dwInOutMode,
		BSTR *	TimeStr
	)

To read attendance records from the internal buffer one by one. Before using this function, execute ReadAllGLogData or ReadGeneralLogData to read the attendance records from the machine to the internal buffer of the PC. Each time this function is executed, the pointer moves to the next attendance record. This function is the same as GetGeneralLogData. They differ in the format of time in the returned values.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID dwEnrollNumber LONG* [out] Pointer that points to the LONG variable. Its value is the user ID of an attendance record. dwVerifyMode LONG* [out] Pointer that points to the LONG variable. Its value is the verification mode of an attendance record. The meanings of the values are the same as those of the GetGeneralLogData parameter. dwInOutMode LONG* [out] Pointer that points to the LONG variable. Its value is the attendance status of an attendance record. The meanings of the values are the same as those of the GetGeneralLogData parameter. TimeStr BSTR* [out] Pointer that points to the LONG variable. Its value is the attendance time of an attendance record.

Returns

Value description:

name	type	description of value
True	BOOL	Function execution success
False	BOOL	Function execution failure

See also

GetGeneralLogData

Attention

1. The dwVerifyMode parameter specifies the verification mode. The meanings of the values are the same as those of the GetGeneralLogData parameter.

1. The dwInOutMode parameter specifies the attendance status. The meanings of the values are the same as those of the GetGeneralLogData parameter.
   

Note

Applicable to BW

GetGeneralExtLogData()

VARIANT_BOOL GetGeneralExtLogData	(	LONG	dwMachineNumber,
		LONG *	dwEnrollNumber,
		LONG *	dwVerifyMode,
		LONG *	dwInOutMode,
		LONG *	dwYear,
		LONG *	dwMonth,
		LONG *	dwDay,
		LONG *	dwHour,
		LONG *	dwMinute,
		LONG *	dwSecond,
		LONG *	dwWorkCode,
		LONG *	dwReserved
	)

To read attendance records from the internal buffer one by one. Before using this function, execute ReadAllGLogData or ReadGeneralLogData to read the attendance records from the machine to the internal buffer of the PC. Each time this function is executed, the pointer moves to the next attendance record. This function is an enhanced version of GetGeneralLogData. They are compatible.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID dwEnrollNumber LONG* [out] Pointer that points to the LONG variable. Its value is the user ID of an attendance record. dwVerifyMode LONG* [out] Pointer that points to the LONG variable. Its value is the verification mode of an attendance record. dwInOutMode LONG* [out] Pointer that points to the LONG variable. Its value is the attendance status of an attendance record. dwYear LONG* [out] Pointer that points to the LONG variable. Its value is the year of an attendance record. dwMonth LONG* [out] Pointer that points to the LONG variable. Its value is the month of an attendance record. dwDay LONG* [out] Pointer that points to the LONG variable. Its value is the day of an attendance record. dwHour LONG* [out] Pointer that points to the LONG variable. Its value is the hour of an attendance record. dwMinute LONG* [out] Pointer that points to the LONG variable. Its value is the minute of an attendance record. dwSecond LONG* [out] Pointer that points to the LONG variable. Its value is the second of an attendance record. dwWorkCode LONG* [out] Pointer that points to the LONG variable. Its value is the work code of an attendance record. dwReserved LONG* [out] Reserved parameter. It is meaningless.

Returns

Value description:

name	type	description of value
True	BOOL	Function execution success
False	BOOL	Function execution failure

See also

GetGeneralLogData

Attention

1. The dwVerifyMode parameter specifies the verification mode. The meanings of the values are the same as those of the GetGeneralLogData parameter.

1. The dwInOutMode parameter specifies the attendance status. The meanings of the values are the same as those of the GetGeneralLogData parameter.
   

Note

Applicable to BW

ClearGLog()

VARIANT_BOOL ClearGLog

(

LONG

dwMachineNumber

)

To clear all attendance records on the machine.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID

Returns

Value description:

name	type	description of value
True	BOOL	Function execution success
False	BOOL	Function execution failure

See also

Attention

Note

Applicable to BW, TFT, and IFACE devices

ReadSuperLogData()

VARIANT_BOOL ReadSuperLogData

(

LONG

dwMachineNumber

)

To read operation records to the internal buffer of the PC. The function is the same as ReadAllSLogData.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID

Returns

Value description:

name	type	description of value
True	BOOL	Function execution success
False	BOOL	Function execution failure

See also

Attention

Note

Applicable to BW, TFT, and IFACE devices

ReadAllSLogData()

VARIANT_BOOL ReadAllSLogData

(

LONG

dwMachineNumber

)

To read operation records to the internal buffer of the PC. The function is the same as ReadSuperLogData.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID

Returns

Value description:

name	type	description of value
True	BOOL	Function execution success
False	BOOL	Function execution failure

See also

Attention

Note

Applicable to BW, TFT, and IFACE devices

GetSuperLogData()

VARIANT_BOOL GetSuperLogData	(	LONG	dwMachineNumber,
		LONG *	dwTMachineNumber,
		LONG *	dwSEnrollNumber,
		LONG *	Params4,
		LONG *	Params1,
		LONG *	Params2,
		LONG *	dwManipulation,
		LONG *	Params3,
		LONG *	dwYear,
		LONG *	dwMonth,
		LONG *	dwDay,
		LONG *	dwHour,
		LONG *	dwMinute
	)

To read operation records from the internal buffer one by one. Before using this function, execute ReadAllSLogData or ReadSuperLogData to read the operation records from the machine to the internal buffer of the PC. Each time this function is executed, the pointer moves to the next operation record. This function differs from GetSuperLogData2 in that the GetSuperLogData2 function can obtain the operation record time accurate to seconds.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID dwTMachineNumber LONG* [out] Pointer that points to the LONG variable. Its value is the machine ID of an operation record. dwSEnrollNumber LONG* [out] Pointer that points to the LONG variable. Its value is the administrator ID of an operation record. Params4 LONG* [out] Pointer that points to the LONG variable. The value varies according to that of dwManipulation. Params1 LONG* [out] Pointer that points to the LONG variable. The value varies according to that of dwManipulation. Params2 LONG* [out] Pointer that points to the LONG variable. The value varies according to that of dwManipulation. dwManipulation LONG* [out] Pointer that points to the LONG variable. Its value is the operation type. Params3 LONG* [out] Pointer that points to the LONG variable. The value varies according to that of dwManipulation. dwYear LONG* [out] Pointer that points to the LONG variable. Its value is the year of an operation record. dwMonth LONG* [out] Pointer that points to the LONG variable. Its value is the month of an operation record. dwDay LONG* [out] Pointer that points to the LONG variable. Its value is the day of an operation record. dwHour LONG* [out] Pointer that points to the LONG variable. Its value is the hour of an operation record. dwMinute LONG* [out] Pointer that points to the LONG variable. Its value is the minute of an operation record.

Returns

Value description:

name	type	description of value
True	BOOL	Function execution success
False	BOOL	Function execution failure

See also

Attention

: The meaning of different combinations of the dwManipulation, Params1, Params2, Params3 and Params4 parameters is as follows:

1. dwManipulation=0: dwManipulation indicates starting the machine.
   
2. dwManipulation=1: dwManipulation indicates shutting down the machine.
   
3. dwManipulation=3: dwManipulation indicates that an alarm is raised. Params1 specifies the alarm type. The value 58 indicates a misoperation alarm, 54 door sensor alarm, 53 door opening alarm, 55 tamper alarm, and 65535 shutdown alarm.
   
4. dwManipulation=4: dwManipulation indicates accessing the menu.
   
5. dwManipulation=5: dwManipulation indicates changing settings. Params1 specifies the number of the option that is set.
   
6. dwManipulation=6: dwManipulation indicates registering fingerprints. Params1 specifies the ID of the operated user. Params2 specifies the operation result, the value 0 indicates operation success, and other values indicate operation failure. Params3 specifies the registered fingerprint index. Params4 specifies the length of the fingerprint template, and the value 2 indicates duress fingerprint.
   
7. dwManipulation=7: dwManipulation indicates registering the password. Params1 specifies the ID of the operated user. Params2 specifies the operation result, the value 0 indicates operation success, and other values indicate operation failure.
   
8. dwManipulation=14: dwManipulation indicates creating an MF card. Params1 specifies the ID of the operated user. Params2 specifies the operation result, the value 0 indicates operation success, and other values indicate operation failure. Params3 specifies the number of fingerprints written to the MF card. Params4 specifies the size of fingerprint data written to the MF card.
   
9. dwManipulation=20: dwManipulation indicates copying data from the MF card to the machine. Params1 specifies the ID of the operated user. Params2 specifies the operation result, the value 0 indicates operation success, and other values indicate operation failure. Params3 specifies the number of fingerprints read to the MF card.
   
10. dwManipulation=22: dwManipulation indicates restoring factory settings.
    
11. dwManipulation=30: dwManipulation indicates registering a new user. Params1 specifies the ID of the operated user. Params2 specifies the operation result, the value 0 indicates operation success, and other values indicate operation failure.
    
12. dwManipulation=32: dwManipulation indicates duress alarm. Params1 specifies whether the alarm is a verification alarm, the value 0 indicates a key alarm, and 1 indicates a verification alarm. Note: If the alarm is a verification alarm, dwSEnrollNumber will return the duress user ID.
    
13. dwManipulation=34: dwManipulation indicates blockade. Params1 specifies whether to block.
    

Note

Applicable to BW, TFT, and IFACE devices

GetAllSLogData()

GetAllSLogData	(	LONG	dwMachineNumber,
		LONG *	dwTMachineNumber,
		LONG *	dwSEnrollNumber,
		LONG *	dwSMachineNumber,
		LONG *	dwGEnrollNumber,
		LONG *	dwGMachineNumber,
		LONG *	dwManipulation,
		LONG *	dwBackupNumber,
		LONG *	dwYear,
		LONG *	dwMonth,
		LONG *	dwDay,
		LONG *	dwHour,
		LONG *	dwMinute
	)

To read operation records from the internal buffer one by one. Before using this function, execute ReadAllSLogData or ReadSuperLogData to read the operation records from the machine to the internal buffer of the PC. Each time this function is executed, the pointer moves to the next operation record. This function is the same as GetSuperLogData. They differ only in the interface name for compatibility.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID dwTMachineNumber LONG* [out] Pointer that points to the LONG variable. Its value is the machine ID of an operation record. dwSEnrollNumber LONG* [out] Pointer that points to the LONG variable. Its value is the administrator ID of an operation record. dwSMachineNumber LONG* [out] Pointer that points to the LONG variable. The value varies according to that of dwManipulation. dwGEnrollNumber LONG* [out] Pointer that points to the LONG variable. The value varies according to that of dwManipulation. dwGMachineNumber LONG* [out] Pointer that points to the LONG variable. The value varies according to that of dwManipulation. dwManipulation LONG* [out] Pointer that points to the LONG variable. Its value is the operation type. The meanings of the values are as follows: dwBackupNumber LONG* [out] Pointer that points to the LONG variable. The value varies according to that of dwManipulation. dwYear LONG* [out] Pointer that points to the LONG variable. Its value is the year of an operation record. dwMonth LONG* [out] Pointer that points to the LONG variable. Its value is the month of an operation record. dwDay LONG* [out] Pointer that points to the LONG variable. Its value is the day of an operation record. dwHour LONG* [out] Pointer that points to the LONG variable. Its value is the hour of an operation record. dwMinute LONG* [out] Pointer that points to the LONG variable. Its value is the minute of an operation record.*

Returns

Returns

Value description:

name	type	description of value
True	BOOL	Function execution success
False	BOOL	Function execution failure

See also

GetSuperLogData

Attention

The meanings of the parameters are the same as those of GetSuperLogData.

Note

Applicable to BW, TFT, and IFACE devices

ClearSLog()

VARIANT_BOOL ClearSLog

(

LONG

dwMachineNumber

)

To clear all operation records on the machine.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID

Returns

Value description:

name	type	description of value
True	BOOL	Function execution success
False	BOOL	Function execution failure

See also

Attention

Note

Applicable to BW, TFT, and IFACE devices

GetSuperLogData2()

VARIANT_BOOL GetSuperLogData2	(	LONG	dwMachineNumber,
		LONG *	dwTMachineNumber,
		LONG *	dwSEnrollNumber,
		LONG *	Params4,
		LONG *	Params1,
		LONG *	Params2,
		LONG *	dwManipulation,
		LONG *	Params3,
		LONG *	dwYear,
		LONG *	dwMonth,
		LONG *	dwDay,
		LONG *	dwHour,
		LONG *	dwMinute,
		LONG *	dwSecs
	)

To read operation records from the internal buffer one by one. Before using this function, execute ReadAllSLogData or ReadSuperLogData to read the operation records from the machine to the internal buffer of the PC. Each time this function is executed, the pointer moves to the next operation record. GetSuperLogData and GetSuperLogData2 differ in that the GetSuperLogData2 function can obtain the operation record time accurate to seconds.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID dwTMachineNumber LONG* [out] Pointer that points to the LONG variable. Its value is the machine ID of an operation record. dwSEnrollNumber LONG* [out] Pointer that points to the LONG variable. Its value is the administrator ID of an operation record. Params4 LONG* [out] Pointer that points to the LONG variable. The value varies according to that of dwManipulation. Params1 LONG* [out] Pointer that points to the LONG variable. The value varies according to that of dwManipulation. Params2 LONG* [out] Pointer that points to the LONG variable. The value varies according to that of dwManipulation. dwManipulation LONG* [out] Pointer that points to the LONG variable. Its value is the operation type. The meanings of the values are as follows: Params3 LONG* [out] Pointer that points to the LONG variable. The value varies according to that of dwManipulation. dwYear LONG* [out] Pointer that points to the LONG variable. Its value is the year of an operation record. dwMonth LONG* [out] Pointer that points to the LONG variable. Its value is the month of an operation record. dwDay LONG* [out] Pointer that points to the LONG variable. Its value is the day of an operation record. dwHour LONG* [out] Pointer that points to the LONG variable. Its value is the hour of an operation record. dwMinute LONG* [out] Pointer that points to the LONG variable. Its value is the minute of an operation record. dwSecs LONG* [out] Pointer that points to the LONG variable. Its value is the second of an operation record.

Returns

Value description:

name	type	description of value
True	BOOL	Function execution success
False	BOOL	Function execution failure

See also

GetSuperLogData

Attention

dwYear, dwMonth, dwDay, dwHour, dwMinute and dwSecs are all pointers that point to the LONG variable. Their values indicate the date and time of an operation record, accurate to seconds.

Note

Applicable to BW, TFT, and IFACE devices

ClearKeeperData()

VARIANT_BOOL ClearKeeperData

(

LONG

dwMachineNumber

)

To clear all data on the machine.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID

Returns

Value description:

name	type	description of value
True	BOOL	Function execution success
False	BOOL	Function execution failure

See also

Attention

Note

Applicable to BW, TFT, and IFACE devices

ClearData()

VARIANT_BOOL ClearData	(	LONG	dwMachineNumber,
		LONG	DataFlag
	)

To clear the records specified by DataFlag on the machine.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID DataFlag LONG [in] This parameter specifies the type of records to be cleared.

Returns

Value description:

name	type	description of value
True	BOOL	Function execution success
False	BOOL	Function execution failure

See also

Attention

The DataFlag parameter specifies the type of records to be cleared. The value range is 1-5. The meanings are as follows:
1 Attendance records
2 Fingerprint template data
3 None
4 Operation records
5 User information
If the value of this parameter is 5, all users on the machine will be deleted. Note: All fingerprint templates will also be deleted.

Note

Applicable to BW, TFT, and IFACE devices

GetDataFile()

VARIANT_BOOL GetDataFile	(	LONG	dwMachineNumber,
		LONG	DataFlag,
		BSTR	FileName
	)

To obtain a specified data file from the machine.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID DataFlag LONG [in] Type of the data file to be obtained FileName BSTR [in] Name of the data file that is stored

Returns

Value description:

name	type	description of value
True	BOOL	Function execution success
False	BOOL	Function execution failure

See also

Attention

The DataFlag parameter specifies the type of records to be cleared. The values are described as follows:
1 Attendance records
2 Fingerprint template data
3 None
4 Operation records
5 User information
6 Short message data file
7 Data file of short messages and user relationships
8 Extended user information data file
9 Work code information data file

Note

Applicable to BW, TFT, and IFACE devices

SendFile()

VARIANT_BOOL SendFile	(	LONG	dwMachineNumber,
		BSTR	FileName
	)

To send a file to the machine, usually to the directory /mnt/mtdblock/.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID FileName BSTR [in] Name of the file to be sent

Returns

Value description:

name	type	description of value
True	BOOL	Function execution success
False	BOOL	Function execution failure

See also

Attention

If the color-screen machine transfers user pictures or advertisement pictures, name the pictures properly and then the pictures will be automatically saved to the corresponding directory.
Name format of advertisement pictures: ad_Number.jpg. The value of number ranges from 1 to 20. For example, ad_4.jpg.
Name format of user pictures: User ID.jpg. For example, 1.jpg.

Note

Applicable to BW, TFT, and IFACE devices

ReadFile()

VARIANT_BOOL ReadFile	(	LONG	dwMachineNumber,
		BSTR	FileName,
		BSTR	FilePath
	)

To read a specified file from the machine, usually under the directory /mnt/mtdblock/.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID FileName BSTR [in] Name of the file to be read FilePath BSTR [in] Path for saving the file

Returns

Value description:

name	type	description of value
True	BOOL	Function execution success
False	BOOL	Function execution failure

See also

Attention

Note

Applicable to BW

RefreshData()

VARIANT_BOOL RefreshData

(

LONG

dwMachineNumber

)

To refresh the data on the machine. This function is typically invoked after user information or a fingerprint is uploaded, so that the modification takes effect immediately.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID

Returns

Value description:

name	type	description of value
True	BOOL	Function execution success
False	BOOL	Function execution failure

See also

Attention

Note

Applicable to BW, TFT, and IFACE devices

ReadTimeGLogData()

VARIANT_BOOL ReadTimeGLogData	(	LONG	dwMachineNumber,
		BSTR	sTime,
		BSTR	eTime
	)

To download attendance records based on the specified start time and end time, accurate to seconds.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID sTime BSTR [in] Start time in the format of YYYY-MM-DD hh:mm:ss eTime BSTR [in] End time in the format of YYYY-MM-DD hh:mm:ss

Returns

Value description:

name	type	description of value
True	BOOL	Function execution success
False	BOOL	Function execution failure

See also

Attention

Note

This interface is applicable to the new architecture firmware.

ReadNewGLogData()

VARIANT_BOOL ReadNewGLogData

(

LONG

dwMachineNumber

)

To download the new generated attendance records.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID

Returns

Value description:

name	type	description of value
True	BOOL	Function execution success
False	BOOL	Function execution failure

See also

Attention

Note

This interface is applicable to the new architecture firmware.

DeleteAttlogBetweenTheDate()

VARIANT_BOOL DeleteAttlogBetweenTheDate	(	LONG	dwMachineNumber,
		BSTR	sTime,
		BSTR	eTime
	)

To delete attendance records based on the specified start time and end time, accurate to seconds.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID sTime BSTR [in] Start time in the format of YYYY-MM-DD hh:mm:ss eTime BSTR [in] End time in the format of YYYY-MM-DD hh:mm:ss

Returns

Value description:

name	type	description of value
True	BOOL	Function execution success
False	BOOL	Function execution failure

See also

Attention

Note

This interface is applicable to the new architecture firmware.

DeleteAttlogByTime()

VARIANT_BOOL DeleteAttlogByTime	(	LONG	dwMachineNumber,
		BSTR	sTime
	)

To delete all attendance records generated before the specified time point, accurate to seconds.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID sTime BSTR [in] Start time point in the format of YYYY-MM-DD hh:mm:ss

Returns

Value description:

name	type	description of value
True	BOOL	Function execution success
False	BOOL	Function execution failure

See also

Attention

Note

This interface is applicable to the new architecture firmware.