MBA

Time & Attendance System

SDK Manual
 1.1 Connect_Net
[Definition]
VARIANT_BOOL Connect_Net( [in] BSTR IPAdd, [in] long Portl)
[Usage]
Connect to the device via the IP address and set up a network connection with the device.
[Parameter]
IPAdd:
IP address of the device
Port:
Port number used for connecting to the device. The default value is 4370.
[Return Value]
Return True if it is successful, or return False.

1.2 Disconnect
[Definition]
Disconnect(void)
[Usage]
Disconnect from the device and release related resources.
[Parameter]
None
[Return Value]
None

1.3 EnableDevice (Enable / Disable Device)

[Definition]
VARIANT_BOOL EnableDevice([in] long dwMachineNumber, [in] VARIANT_BOOL bFlag)
[Usage]
Enable or disable the device. If the device is disabled, the fingerprint sensor, keypad, card
modules, etc. are disabled.
[Parameter]
dwMachineNumber
Device number
bFlag
User enable flag. 1: Enabled. 0: Disabled.
[Return Value]
Return True if it is successful, or return False.
1.4 RestartDevice
[Definition]
VARIANT_BOOL RestartDevice([in] LONG dwMachineNumber)
[Usage]
Restart the device.
[Parameter]
dwMachineNumber
Device number
[Return Value]
Return True if it is successful, or return False.

1.5 IsTFTMachine (Check if it is OLD K300 (TFT Machine) / Fingerprint Machine)

[Definition]
VARIANT_BOOL IsTFTMachine([in] LONG dwMachineNumber)
[Usage]
Determine whether the current device is a TFT device.
[Parameter]
dwMachineNumber
Device number
[Return Value]
Return True if the current device is a TFT device. Return False if the current device is a
black & white device.

1.6 SetDeviceTime
[Definition]
VARIANT_BOOL SetDeviceTime([in] long dwMachineNumber)
[Usage]
Set the local computer time to the device time. To set the specified time, see
SetDeviceTime2.
[Parameter]
dwMachineNumber
Device number
[Return Value]
Return True if it is successful, or return False.

1.7 GetDeviceTime
[Definition]
VARIANT_BOOL GetDeviceTime([in] long dwMachineNumber, [out] long* dwYear, [out]
long* dwMonth, [out] long* dwDay, [out] long* dwHour, [out] long* dwMinute, [out] long*
dwSecond)
[Usage]
Obtain the device time.
[Parameter]
dwMachineNumber
Device number
dwYear, dwMonth, dwDay, dwHour, dwMinute, dwSecond
Long pointers pointing to variables. The values are the date and time of the device.
[Return Value]
Return True if it is successful, or return False.

2.1 GetDeviceStatus (Get Attdendance Rec Count)

[Definition]
VARIANT_BOOL GetDeviceStatus( [in] long dwMachineNumber, [in] long dwStatus, [out]
long* dwValue)
[Usage]
Obtain the data storage status of the device, for example, number of administrators and
number of current users.
[Parameter]
dwMachineNumber
Device number
dwStatus
Data to be obtained. The value ranges from 1 to 22. Values:
1 Number of administrators
2 Number of registered users
3 Number of fingerprint templates in the device
4 Number of passwords
5 Number of operation records
6 Number of attendance records
7 Fingerprint template capacity
8 User capacity
9 Attendance record capacity
10 Residual fingerprint template capacity
11 Residual user capacity
12 Residual attendance record capacity
21 Number of faces
22 Face capacity
Returned 0 in other cases.
dwValue
Value of dwStatus
[Return Value]
Return True if it is successful, or return False.

2.2 ReadGeneralLogData
[Definition]
VARIANT_BOOL ReadGeneralLogData( [in] long dwMachineNumber)
[Usage]
Read attendance records and write them into the internal buffer of the PC. This function is
the same as ReadAllGLogData.
[Parameter]
dwMachineNumber:
Device number
[Return Value]
Return True if it is successful, or return False.

2.3 GetGeneralLogDataStr (For OLD K300)

[Definition]
VARIANT_BOOL GetGeneralLogDataStr( [in] long dwMachineNumber, [out] long*
dwEnrollNumber, [out] long* dwVerifyMode, [out] long* dwInOutMode, [out] BSTR
*TimeStr)
[Usage]
Read attendance records one by one from the internal buffer. Before using this function, you
can use ReadAllGLogData or ReadGeneralLogData to read attendance records from the
device and write them into the internal buffer of the PC. Each time this function is executed,
the pointer points to the next attendance record. The difference between this function and
GetGeneralLogData is the returned time type.
[Parameter]
dwMachineNumber
Device number
dwEnrollNumber
Pointer pointing to a long variable. The value is the user ID of the received
attendance record.
dwVerifyMode
Pointer pointing to a long variable. The value is the verification mode of the received
attendance record. The specific values are the same as those of
GetGeneralLogData.
dwInOutMode
Pointer pointing to a long variable. The value is the attendance state of the reserved
attendance record. The specific values are the same as those of
GetGeneralLogData.
TimeStr
Pointer pointing to a BSTR variable. The value is the attendance time of the received
attendance record.
[Return Value]
Return True if it is successful, or return False.

2.4 SSR_GetGeneralLogData (For Fingerprint Machine)

[Definition]
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)
[Usage]
Read attendance records one by one from the internal buffer. Before using this function, you
can use ReadAllGLogData or ReadGeneralLogData to read attendance records from the
device and write them into the internal buffer of the PC. Each time this function is executed,
the pointer points to the next attendance record.
[Parameter]
dwMachineNumber
Device number
dwEnrollNumber
Pointer pointing to a BSTR variable. The value is the user ID of the received
attendance record. The value consists of up to 24 bits.
dwVerifyMode
Pointer pointing to a long variable. The value is the verification mode of the received
attendance record. The values are as follows:
Generally, 0: password verification, 1: fingerprint verification, 2: card verification.
In multi-verification mode:
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
Pointer pointing to a long variable. The value is the AttState of the received
attendance record. The values are as follows:
0—Check-In (default value) 1—Check-Out 2—Break-Out
3—Break-In 4—OT-In 5—OT-Out
dwYear, dwMonth, dwDay, dwHour, dwMinute, dwSecond
Pointers pointing to long variables. The values are the date and time of the received
attendance record.
dwWorkcode
Pointer pointing to a long variable. The value is the work code of the received
attendance record.
[Return Value]
Return True if it is successful, or return False.

2.5 ClearGLog
[Definition]
VARIANT_BOOL ClearGLog([in] long dwMachineNumber)
[Usage]
Clear all attendance records from the device.
[Parameter]
dwMachineNumber
Device number
[Return Value]
Return True if it is successful, or return False.

3.1 ReadAllUserID
[Definition]
VARIANT_BOOL ReadAllUserID([in] long dwMachineNumber)
[Usage]
Read all user information except fingerprint templates, such as user ID, password, name,
and card number, and write the user information into the memory of the PC. After this
function is executed, you can use GetAllUserID to take out user information.
[Parameter]
dwMachineNumber
Device number
[Return Value]
Return True if it is successful, or return False.

3.2 GetAllUserInfo (For OLD K300)

[Definition]
VARIANT_BOOL GetAllUserInfo([out] long dwMachineNumber, [out] long*
dwEnrollNumber, [out] BSTR * Name, [out] BSTR * Password, [out] long * Privilege, [out]
VARIANT_BOOL * Enabled)
[Usage]
Obtain all user information. Before executing this function, you can use ReadAllUserID to
read out all user information and write it into the memory. Each time GetAllUserInfo is
executed, the pointer points to the next user information. After all user information is read,
False is returned. The difference between this function and GetAllUserID is that this function
can obtain more information.
[Parameter]
dwMachineNumber
Device number
dwEnrollNumber
User ID
Name
User name
Password
User password
Privilege
User privilege. 0: common user, 1: enroller, 2: administrator, 3: super administrator
dwEnable
Whether the user is enabled. 1: Enabled. 0: Disabled.
[Return Value]
Return True if it is successful, or return False.

3.3 SSR_GetAllUserInfo (For Fingerprint Machine)

[Definition]
VARIANT_BOOL GetAllUserInfo([out] long dwMachineNumber, [out] long*
dwEnrollNumber, [out] BSTR * Name, [out] BSTR * Password, [out] long * Privilege, [out]
VARIANT_BOOL * Enabled)
[Usage]
Obtain all user information. Before executing this function, you can use ReadAllUserID to
read out all user information and write it into the memory. Each time SSR_GetAllUserInfo is
executed, the pointer points to the next user information. After all user information is read,
False is returned.
[Parameter]
dwMachineNumber
Device number
dwEnrollNumber
User ID
Name
User name
Password
User password
Privilege
User privilege. 3: super administrator 0: common user,
dwEnable
Whether the user is enabled. 1: Enabled. 0: Disabled.
[Return Value]
Return True if it is successful, or return False.
[Related Function]

3.4 GetStrCardNumber
[Definition]
VARIANT_BOOL GetStrCardNumber([out] BSTR* ACardNumber)
[Usage]
Obtain the value of cardnumber of the SDK. Generally, this function can be used to obtain
the card number of a user immediately after the user information is obtained.
[Parameter]
AcardNumber
Card number
[Return Value]
Return True if it is successful, or return False.

3.5 ReadAllTemplate
[Definition]
VARIANT_BOOL ReadAllTemplate([in] LONG dwMachineNumber)
[Usage]
Read out all fingerprint templates from the device and write them into the memory of the PC.
This function is used to read out and write all the fingerprints into the memory at a time. This
function achieves a higher speed in comparison with the way of obtaining fingerprints one
by one.
[Parameter]
dwMachineNumber
Device number
[Return Value]
Return True if it is successful, or return False.

3.6 GetUserTmpExStr
[Definition]
VARIANT_BOOL GetUserTmpExStr([in] LONG dwMachineNumber, [in] BSTR
dwEnrollNumber, [in] LONG dwFingerIndex,[out] LONG * Flag, [out] BSTR* TmpData, [out]
LONG* TmpLength)
[Usage]
Download ordinary fingerprint templates or threatened fingerprint templates of a user in
string mode. The only difference between this function and GetUserTmpEx is the
fingerprint template format. Note: TFT devices supporting threatened fingerprints (with
firmware version 6.60 or later) can support this function.
[Parameter]
dwMachineNumber
Device number
dwEnrollNumber
User ID
dwFingerIndex
Fingerprint index
Flag
Flag used to indicate whether the fingerprint template is valid or is a threatened
fingerprint template. 0: Invalid; 1: Valid; 3: Threatened fingerprint template.
TmpData
Fingerprint template data
TmpLength
Fingerprint template length
[Return Value]
Return True if it is successful, or return False.
4.1 SetUserInfo (For Old K300)
[Definition]
VARIANT_BOOL SetUserInfo([in] long dwMachineNumber, [in] long dwEnrollNumber, [in]
BSTR Name, [in] BSTR Password, [in] long Privilege, [in] VARIANT_BOOL Enabled)
[Usage]
Set user information. If the user is unavailable, the device automatically creates the user.
[Parameter]
dwMachineNumber
Device number
dwEnrollNumber
User ID
Name
User name to be set
Password
User password to be set. If the value is null, the user password on the device is
cleared.
Privilege
User privilege. 0: common user, 1: enroller, 2: administrator, 3: super administrator
Enabled
User enable flag. 1: Enabled. 0: Disabled
[Return Value]
Return True if it is successful, or return False.

4.2 SSR_SetUserInfo (For Fingerprint Machine)

[Definition]
VARIANT_BOOL SetUserInfo([in] long dwMachineNumber, [in] long dwEnrollNumber, [in]
BSTR Name, [in] BSTR Password, [in] long Privilege, [in] VARIANT_BOOL Enabled)
[Usage]
Set user information. If the user is unavailable, the device automatically creates the user.
[Parameter]
dwMachineNumber
Device number
dwEnrollNumber
User ID
Name
User name
Password
User password
Privilege
User privilege. 3: super administrator,0: common user
Enabled
User enable flag. 1: Enabled. 0: Disabled
[Return Value]
Return True if it is successful, or return False.

4.3 SetStrCardNumber
[Definition]
VARIANT_BOOL SetStrCardNumber([in] BSTR ACardNumber)
[Usage]
Set the value of cardnumber of the SDK. Generally, this function can be used to set the card
number of a user before the user information is set.
[Parameter]
AcardNumber
Card number
[Return Value]
Return True if it is successful, or return False.

4.4 SetUserTmpExStr
[Definition]
VARIANT_BOOL SetUserTmpExStr([in] LONG dwMachineNumber, [in] BSTR
dwEnrollNumber, [in] LONG dwFingerIndex,[in] LONG Flag, [in] BSTR TmpData)
[Usage]
Upload ordinary fingerprint templates or threatened fingerprint templates of a user in string
mode. The only difference between this function and SetUserTmpEx is the fingerprint
template format. Caution: The user must have been created on the device, or the user
information must be uploaded together with the fingerprint templates. If the template with
the same index is already registered by the same user, the fingerprint template will be
overwritten. Note: TFT devices supporting threatened fingerprints (with firmware version
6.60 or later) can support this function.
[Parameter]
dwMachineNumber
Device number
dwEnrollNumber
User ID
dwFingerIndex
Fingerprint index
Flag
Flag used to indicate whether the fingerprint template is valid or is a threatened
fingerprint template. 0: Invalid; 1: Valid; 3: Threatened fingerprint template.
TmpData
Fingerprint template data
TmpLength
Fingerprint template length
[Return Value]
Return True if it is successful, or return False.

4.5 RefreshData
[Definition]
VARIANT_BOOL RefreshData([in] long dwMachineNumber)
[Usage]
Refresh the data in the device. This function is usually called after user information or
fingerprints are uploaded. In this way, the modifications take effect immediately.
[Parameter]
dwMachineNumber
Device number
[Return Value]
Return True if it is successful, or return False.

5.1 DeleteEnrollData (For Old K300)

[Definition]
VARIANT_BOOL DeleteEnrollData([in] long dwMachineNumber, [in] long dwEnrollNumber,
[in] long dwEMachineNumber, [in] long dwBackupNumber)
[Usage]
Delete registration data.
[Parameter]
dwMachineNumber, dwEMachineNumber
Device number
dwEnrollNumber
User ID
dwBackupNumber
Index of the fingerprint
The value ranges from 0 to 9. It this case, the device also checks whether the user
has other fingerprints or passwords. If no, the device deletes the user.
When the value is 10, the device deletes the password. The device also checks
whether the user has fingerprint data. If no, the device deletes the user.
When the value is 11 or 13, the device deletes all fingerprint data of the user. When the
value is 12, the device deletes the user (including all fingerprints, card numbers and
passwords of the user).
[Return Value]
Return True if it is successful, or return False.

5.2 SSR_DeleteEnrollData (For Fingerprint Machine)

[Definition]
VARIANT_BOOL DeleteEnrollData([in] long dwMachineNumber, [in] long dwEnrollNumber,
[in] long dwEMachineNumber, [in] long dwBackupNumber)
[Usage]
Delete enrollment data.
[Parameter]
dwMachineNumber
Device number
dwEnrollNumber
User ID
dwBackupNumber
Index of the fingerprint
The value ranges from 0 to 9. It this case, the device also checks whether the user
has other fingerprints or passwords. If no, the device deletes the user.
When the value is 10, the device deletes the password. The device also checks
whether the user has fingerprint data. If no, the device deletes the user.
When the value is 11, the device deletes all fingerprint data of the user. When the value is
12, the device deletes the user (including all fingerprints, card numbers and passwords of
the user).
[Return Value]
Return True if it is successful, or return False.