3.01.Data-User.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	ReadAllUserID (LONG dwMachineNumber)
VARIANT_BOOL	GetAllUserID (LONG dwMachineNumber, LONG *dwEnrollNumber, LONG *dwEMachineNumber, LONG *dwBackupNumber, LONG *dwMachinePrivilege, LONG *dwEnable)
VARIANT_BOOL	GetAllUserInfo (LONG dwMachineNumber, LONG *dwEnrollNumber, BSTR *Name, BSTR *Password, LONG *Privilege, VARIANT_BOOL *Enabled)
VARIANT_BOOL	EnableUser (LONG dwMachineNumber, LONG dwEnrollNumber, LONG dwEMachineNumber, LONG dwBackupNumber, VARIANT_BOOL bFlag)
VARIANT_BOOL	SSR_EnableUser (LONG dwMachineNumber, BSTR dwEnrollNumber, VARIANT_BOOL bFlag)
VARIANT_BOOL	ModifyPrivilege (LONG dwMachineNumber, LONG dwEnrollNumber, LONG dwEMachineNumber, LONG dwBackupNumber, LONG dwMachinePrivilege)
VARIANT_BOOL	SetUserInfo (LONG dwMachineNumber, LONG dwEnrollNumber, BSTR Name, BSTR Password, LONG Privilege, VARIANT_BOOL Enabled)
VARIANT_BOOL	GetUserInfo (LONG dwMachineNumber, LONG dwEnrollNumber, BSTR *Name, BSTR *Password, LONG *Privilege, VARIANT_BOOL *Enabled)
VARIANT_BOOL	SetUserInfoEx (LONG dwMachineNumber, LONG dwEnrollNumber, LONG VerifyStyle, BYTE *Reserved)
VARIANT_BOOL	GetUserInfoEx (LONG dwMachineNumber, LONG dwEnrollNumber, LONG *VerifyStyle, BYTE *Reserved)
VARIANT_BOOL	DeleteUserInfoEx (LONG dwMachineNumber, LONG dwEnrollNumber)
VARIANT_BOOL	SSR_GetAllUserInfo (LONG dwMachineNumber, BSTR *dwEnrollNumber, BSTR *Name, BSTR *Password, LONG *Privilege, VARIANT_BOOL *Enabled)
VARIANT_BOOL	SSR_GetUserInfo (LONG dwMachineNumber, BSTR dwEnrollNumber, BSTR *Name, BSTR *Password, LONG *Privilege, VARIANT_BOOL *Enabled)
VARIANT_BOOL	SSR_SetUserInfo (LONG dwMachineNumber, BSTR dwEnrollNumber, BSTR Name, BSTR Password, LONG Privilege, VARIANT_BOOL Enabled)
VARIANT_BOOL	GetUserInfoByPIN2 (LONG dwMachineNumber, BSTR *Name, BSTR *Password, LONG *Privilege, VARIANT_BOOL *Enabled)
VARIANT_BOOL	GetUserInfoByCard (LONG dwMachineNumber, BSTR *Name, BSTR *Password, LONG *Privilege, VARIANT_BOOL *Enabled)
VARIANT_BOOL	GetUserIDByPIN2 (LONG PIN2, LONG *UserID)
VARIANT_BOOL	GetPIN2 (LONG UserID, LONG *PIN2)
VARIANT_BOOL	GetEnrollData (LONG dwMachineNumber, LONG dwEnrollNumber, LONG dwEMachineNumber, LONG dwBackupNumber, LONG *dwMachinePrivilege, LONG *dwEnrollData, LONG *dwPassWord)
VARIANT_BOOL	SetEnrollData (LONG dwMachineNumber, LONG dwEnrollNumber, LONG dwEMachineNumber, LONG dwBackupNumber, LONG dwMachinePrivilege, LONG *dwEnrollData, LONG dwPassWord)
VARIANT_BOOL	DeleteEnrollData (LONG dwMachineNumber, LONG dwEnrollNumber, LONG dwEMachineNumber, LONG dwBackupNumber)
VARIANT_BOOL	SSR_DeleteEnrollData (LONG dwMachineNumber, BSTR dwEnrollNumber, LONG dwBackupNumber)
VARIANT_BOOL	SSR_DeleteEnrollDataExt ([in]LONG dwMachineNumber, BSTR dwEnrollNumber, LONG dwBackupNumber)
VARIANT_BOOL	GetEnrollDataStr (LONG dwMachineNumber, LONG dwEnrollNumber, LONG dwEMachineNumber, LONG dwBackupNumber, LONG *dwMachinePrivilege, BSTR *dwEnrollData, LONG *dwPassWord)
VARIANT_BOOL	SetEnrollDataStr (LONG dwMachineNumber, LONG dwEnrollNumber, LONG dwEMachineNumber, LONG dwBackupNumber, LONG dwMachinePrivilege, BSTR dwEnrollData, LONG dwPassWord)
VARIANT_BOOL	ReadAllTemplate (LONG dwMachineNumber)
VARIANT_BOOL	DelUserTmp (LONG dwMachineNumber, LONG dwEnrollNumber, LONG dwFingerIndex)
VARIANT_BOOL	SSR_DelUserTmp (LONG dwMachineNumber, BSTR dwEnrollNumber, LONG dwFingerIndex)
VARIANT_BOOL	SSR_SetUserTmpExt (LONG dwMachineNumber, LONG IsDeleted, BSTR dwEnrollNumber, LONG dwFingerIndex, BYTE *TmpData)
VARIANT_BOOL	GetUserTmp (LONG dwMachineNumber, LONG dwEnrollNumber, LONG dwFingerIndex, BYTE *TmpData, LONG *TmpLength)
VARIANT_BOOL	SetUserTmp (LONG dwMachineNumber, LONG dwEnrollNumber, LONG dwFingerIndex, BYTE *TmpData)
VARIANT_BOOL	GetUserTmpStr (LONG dwMachineNumber, LONG dwEnrollNumber, LONG dwFingerIndex, BSTR *TmpData, LONG *TmpLength)
VARIANT_BOOL	SetUserTmpStr (LONG dwMachineNumber, [in]LONG dwEnrollNumber, LONG dwFingerIndex, [in]BSTR TmpData)
VARIANT_BOOL	GetUserTmpEx (LONG dwMachineNumber, BSTR dwEnrollNumber, LONG dwFingerIndex, LONG *Flag, BYTE *TmpData, LONG *TmpLength)
VARIANT_BOOL	SetUserTmpEx (LONG dwMachineNumber, LONG dwEnrollNumber, LONG dwFingerIndex, LONG Flag, BYTE *TmpData)
VARIANT_BOOL	GetUserTmpExStr (LONG dwMachineNumber, BSTR dwEnrollNumber, LONG dwFingerIndex, LONG *Flag, BSTR *TmpData, LONG *TmpLength)
VARIANT_BOOL	SetUserTmpExStr (LONG dwMachineNumber, LONG dwEnrollNumber, LONGdwFingerIndex, LONG Flag, BSTR TmpData)
VARIANT_BOOL	SSR_GetUserTmp (LONG dwMachineNumber, BSTR dwEnrollNumber, LONG dwFingerIndex, BYTE *TmpData, LONG *TmpLength)
VARIANT_BOOL	SSR_GetUserTmpStr (LONG dwMachineNumber, BSTR dwEnrollNumber, LONG dwFingerIndex, BSTR *TmpData, LONG *TmpLength)
VARIANT_BOOL	SSR_SetUserTmp (LONG dwMachineNumber, BSTR dwEnrollNumber, LONG dwFingerIndex, BYTE *TmpData)
VARIANT_BOOL	SSR_SetUserTmpStr (LONG dwMachineNumber, BSTR dwEnrollNumber, LONG dwFingerIndex, BSTR TmpData)
VARIANT_BOOL	GetFPTempLength (BYTE *dwEnrollData, LONG *Len)
VARIANT_BOOL	GetFPTempLengthStr (BSTR dwEnrollData, LONG *Len)
VARIANT_BOOL	FPTempConvert (BYTE *TmpData1, BYTE *TmpData2, LONG *Size)
VARIANT_BOOL	FPTempConvertStr (BSTR TmpData1, BSTR *TmpData2, LONG *Size)
VARIANT_BOOL	FPTempConvertNew (BYTE *TmpData1, BYTE *TmpData2, LONG *Size)
VARIANT_BOOL	FPTempConvertNewStr (BSTR TmpData1, BSTR *TmpData2, LONG *Size)
VARIANT_BOOL	SetUserFace (LONG dwMachineNumber, BSTR dwEnrollNumber, LONG dwFaceIndex, BYTE *TmpData, LONG TmpLength)
VARIANT_BOOL	GetUserFace (LONG dwMachineNumber, BSTR dwEnrollNumber, LONG dwFaceIndex, BYTE *TmpData, LONG *TmpLength)
VARIANT_BOOL	DelUserFace (LONG dwMachineNumber, BSTR dwEnrollNumber, LONG dwFaceIndex)
VARIANT_BOOL	GetUserFaceStr (LONG dwMachineNumber, BSTR dwEnrollNumber, LONG dwFaceIndex, BSTR *TmpData, LONG *TmpLength)
VARIANT_BOOL	SetUserFaceStr (LONG dwMachineNumber, BSTR dwEnrollNumber, LONG dwFaceIndex, [in]BSTR TmpData, LONG TmpLength)

Function Documentation

ReadAllUserID()

VARIANT_BOOL ReadAllUserID

(

LONG

dwMachineNumber

)

To read all user information to the memory of the PC, including the user ID, password, name, and card number. Fingerprint templates are not read. After this function is executed, invoke the function GetAllUserID to get the user information.

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

GetAllUserID()

VARIANT_BOOL GetAllUserID	(	LONG	dwMachineNumber,
		LONG *	dwEnrollNumber,
		LONG *	dwEMachineNumber,
		LONG *	dwBackupNumber,
		LONG *	dwMachinePrivilege,
		LONG *	dwEnable
	)

To get all user information. Before executing this function, invoke the function ReadAllUserID to read all user information to the memory. Each time GetAllUserID is executed, the pointer moves to the next user information record. After all user information is read, the function returns False. This function differs from GetAllUserInfo in that the GetAllUserInfo function can obtain user names and passwords.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID dwEnrollNumber LONG* [out] User ID dwEMachineNumber LONG* [out] Invalid parameter dwBackupNumber LONG* [out] Comment dwMachinePrivilege LONG* [out] User privilege dwEnable LONG* [out] Whether a user account is enabled

Returns

Value description:

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

See also

Attention

1. The value of dwEMachineNumber is always 0.

1. The dwMachinePrivilege parameter specifies the user privilege. The value 0 indicates common user, 1 registrar, 2 administrator, and 3 super administrator.
   
2. The dwEnable parameter specifies whether a user account is enabled. The value 1 indicates that the user account is enabled and 0 indicates that the user account is disabled.

Note

Applicable to BW

GetAllUserInfo()

VARIANT_BOOL GetAllUserInfo	(	LONG	dwMachineNumber,
		LONG *	dwEnrollNumber,
		BSTR *	Name,
		BSTR *	Password,
		LONG *	Privilege,
		VARIANT_BOOL *	Enabled
	)

To get all user information. Before executing this function, invoke the function ReadAllUserID to read all user information to the memory. Each time GetAllUserInfo is executed, the pointer moves to the next user information record. After all user information is read, the function returns False. The GetAllUserInfo function differs from GetAllUserID in that it can obtain more information.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [out] Machine ID dwEnrollNumber LONG* [out] User ID Name BSTR* [out] User name Name BSTR* [out] User password Privilege LONG* [out] User privilege Enabled BOOL* [out] Whether a user account is enabled

Returns

Value description:

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

See also

Attention

1. The dwMachinePrivilege parameter specifies the user privilege. The value 0 indicates common user, 1 registrar, 2 administrator, and 3 super administrator.

1. The dwEnable parameter specifies whether a user account is enabled. The value 1 indicates that the user account is enabled and 0 indicates that the user account is disabled.

Note

Applicable to BW

EnableUser()

VARIANT_BOOL EnableUser	(	LONG	dwMachineNumber,
		LONG	dwEnrollNumber,
		LONG	dwEMachineNumber,
		LONG	dwBackupNumber,
		VARIANT_BOOL	bFlag
	)

To set whether a user account is available.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID dwEnrollNumber LONG [in] User ID dwEMachineNumber LONG [in] Invalid parameter. It is meaningless. dwBackupNumber LONG [in] Invalid parameter. It is meaningless. bFlag BOOL [in] Flag that indicates whether a user account is enabled

Returns

Value description:

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

See also

Attention

The bFlag parameter is a flag that indicates whether a user account is enabled. The value True indicates that the user account is enabled and False indicates that the user account is disabled.

Note

Applicable to BW

SSR_EnableUser()

VARIANT_BOOL SSR_EnableUser	(	LONG	dwMachineNumber,
		BSTR	dwEnrollNumber,
		VARIANT_BOOL	bFlag
	)

To set whether a user account is available.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID dwEnrollNumber BSTR [in] User ID bFlag BOOL [in] Flag that indicates whether a user account is enabled

Returns

Value description:

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

See also

Attention

The bFlag parameter is a flag that indicates whether a user account is enabled. The value True indicates that the user account is enabled and False indicates that the user account is disabled.

Note

Applicable to TFT and IFACE devices

ModifyPrivilege()

VARIANT_BOOL ModifyPrivilege	(	LONG	dwMachineNumber,
		LONG	dwEnrollNumber,
		LONG	dwEMachineNumber,
		LONG	dwBackupNumber,
		LONG	dwMachinePrivilege
	)

To modify user privilege.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID dwEnrollNumber LONG [in] User ID dwEMachineNumber LONG [in] Invalid parameter. It is meaningless. dwBackupNumber LONG [in] Invalid parameter. It is meaningless. dwMachinePrivilege LONG [in] User privilege to be set

Returns

Value description:

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

See also

Attention

The dwMachinePrivilege parameter specifies the user privilege. The value 0 indicates common user, 1 registrar, 2 administrator, and 3 super administrator.

Note

Applicable to BW

SetUserInfo()

VARIANT_BOOL SetUserInfo	(	LONG	dwMachineNumber,
		LONG	dwEnrollNumber,
		BSTR	Name,
		BSTR	Password,
		LONG	Privilege,
		VARIANT_BOOL	Enabled
	)

To set information about a user. If the user does not exist on the machine, the user will be created.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID dwEnrollNumber LONG [in] User ID Name BSTR [in] User name to be set Password BSTR [in] User password to be set. If this parameter is left blank, the password of the user will be cleared on the machine. Privilege LONG [in] User privilege. The value 0 indicates common user, 1 registrar, 2 administrator, and 3 super administrator. Enabled BOOL [in] Flag that indicates whether a user account is enabled. The value 1 indicates that the user account is enabled and 0 indicates that the user account is disabled.

Returns

Value description:

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

See also

Attention

1. The Password parameter specifies the password to be set. If this parameter is left blank, the password of the user will be cleared on the machine.

1. The Privilege parameter specifies the user privilege. The value 0 indicates common user, 1 registrar, 2 administrator, and 3 super administrator.
   
2. The Enable parameter specifies whether a user account is enabled. The value 1 indicates that the user account is enabled and 0 indicates that the user account is disabled.

Note

Applicable to BW

GetUserInfo()

VARIANT_BOOL GetUserInfo	(	LONG	dwMachineNumber,
		LONG	dwEnrollNumber,
		BSTR *	Name,
		BSTR *	Password,
		LONG *	Privilege,
		VARIANT_BOOL *	Enabled
	)

To get information about a specified user.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID dwEnrollNumber LONG [in] User ID Name BSTR* [out] Returned user name Name BSTR* [out] User password Privilege LONG* [out] User privilege Enabled BOOL* [out] Flag that indicates whether a user account is enabled

Returns

Value description:

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

See also

Attention

1. The Password indicates the returned user password. If this parameter is left blank, the user does not use a password on the machine.

1. The Privilege parameter specifies the user privilege. The value 0 indicates common user, 1 registrar, 2 administrator, and 3 super administrator.
   
2. The Enable parameter specifies whether a user account is enabled. The value 1 indicates that the user account is enabled and 0 indicates that the user account is disabled.

Note

Applicable to BW

SetUserInfoEx()

VARIANT_BOOL SetUserInfoEx	(	LONG	dwMachineNumber,
		LONG	dwEnrollNumber,
		LONG	VerifyStyle,
		BYTE *	Reserved
	)

To upload the user verification mode or group verification mode.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID dwEnrollNumber LONG [in] User ID VerifyStyle LONG [in] Verification mode Reserved BYTE* [in] Reserved

Returns

Value description:

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

See also

Attention

1. This function is valid only on machines with multiple verification modes.

1. On a monochrome machine, the VerifyStyle parameter specifies the verification mode, and 15 verification modes are available. For details about the meanings of the values, see the description of the GetGeneralLogData parameter. If a group verification mode is used, the value of VerifyStyle ranges from 129 to 124, indicating group 1 to group 5 respectively.
   
2. On a color-screen machine, the VerifyStyle parameter specifies the verification mode. On the color-screen access control fingerprint machine, the value 0 indicates group verification. 128(FP/PW/RF), 129(FP), 130(PIN), 131(PW), 132(RF), 133(FP&RF), 134(FP/PW), 135(FP/RF), 136(PW/RF), 137(PIN&FP), 138(FP&PW), 139(PW&RF), 140(FP&PW&RF), 141(PIN&FP&PW), 142(FP&RF/PIN).
   

Note

Applicable to BW, TFT, and IFACE devices

GetUserInfoEx()

VARIANT_BOOL GetUserInfoEx	(	LONG	dwMachineNumber,
		LONG	dwEnrollNumber,
		LONG *	VerifyStyle,
		BYTE *	Reserved
	)

To obtain the user verification mode.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID dwEnrollNumber LONG [in] User ID VerifyStyle LONG* [out] The value is the user verification mode described by dwEnrollNumber. Reserved BYTE* [out] Reserved

Returns

Value description:

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

See also

Attention

1. This function is valid only on machines with multiple verification modes.

1. On a monochrome machine, the VerifyStyle parameter specifies the verification mode, and 15 verification modes are available. For details about the meanings of the values, see the description of the GetGeneralLogData parameter. If a group verification mode is used, the value of VerifyStyle ranges from 129 to 124, indicating group 1 to group 5 respectively.
2. On a color-screen machine, the VerifyStyle parameter specifies the verification mode. On the color-screen access control fingerprint machine, the value 0 indicates group verification. 128(FP/PW/RF), 129(FP), 130(PIN), 131(PW), 132(RF), 133(FP&RF), 134(FP/PW), 135(FP/RF), 136(PW/RF), 137(PIN&FP), 138(FP&PW), 139(PW&RF), 140(FP&PW&RF), 141(PIN&FP&PW), 142(FP&RF/PIN).

Note

Applicable to BW, TFT, and IFACE devices

DeleteUserInfoEx()

VARIANT_BOOL DeleteUserInfoEx	(	LONG	dwMachineNumber,
		LONG	dwEnrollNumber
	)

To delete the multiple verification modes set by a specified user.

Parameters

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

Returns

Value description:

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

See also

Attention

This function is valid only on machines with multiple verification modes.

Note

Applicable to BW, TFT, and IFACE devices

SSR_GetAllUserInfo()

VARIANT_BOOL SSR_GetAllUserInfo	(	LONG	dwMachineNumber,
		BSTR *	dwEnrollNumber,
		BSTR *	Name,
		BSTR *	Password,
		LONG *	Privilege,
		VARIANT_BOOL *	Enabled
	)

To get all user information. Before executing this function, invoke the function ReadAllUserID to read all user information to the memory. Each time SSR_GetAllUserInfo is executed, the pointer moves to the next user information record. After all user information is read, the function returns False.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID dwEnrollNumber BSTR* [out] User ID Name BSTR* [out] User name Name BSTR* [out] User password Privilege LONG* [out] User privilege Enabled BOOL* [out] Flag that indicates whether a user account is enabled

Returns

Value description:

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

See also

Attention

1. The Privilege parameter specifies the user privilege. The value 0 indicates common user, 1 registrar, 2 administrator, and 3 super administrator.

1. The Enable parameter specifies whether a user account is enabled. The value 1 indicates that the user account is enabled and 0 indicates that the user account is disabled.

Note

Applicable to TFT and IFACE devices

SSR_GetUserInfo()

VARIANT_BOOL SSR_GetUserInfo	(	LONG	dwMachineNumber,
		BSTR	dwEnrollNumber,
		BSTR *	Name,
		BSTR *	Password,
		LONG *	Privilege,
		VARIANT_BOOL *	Enabled
	)

To obtain information about a specified user.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID dwEnrollNumber BSTR [in] User ID Name BSTR* [out] The value is the user name described by dwEnrollNumber. Password BSTR* [out] The value is the user password described by dwEnrollNumber. Privilege LONG* [out] The value is the user privilege described by dwEnrollNumber. Enabled BOOL* [out] Flag that indicates whether a user account is enabled

Returns

Value description:

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

See also

Attention

1. The Privilege parameter specifies the user privilege. The value 0 indicates common user, 1 registrar, 2 administrator, and 3 super administrator.

1. The Enable parameter specifies whether a user account is enabled. The value 1 indicates that the user account is enabled and 0 indicates that the user account is disabled.

Note

Applicable to TFT and IFACE devices

SSR_SetUserInfo()

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

To set information about a user. If the user does not exist on the machine, the user will be created.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID dwEnrollNumber BSTR [in] User ID Name BSTR [in] User name Password BSTR [in] User password Privilege LONG [in] User privilege Enabled BOOL [in] Flag that indicates whether a user account is enabled

Returns

Value description:

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

See also

Attention

1. The Privilege parameter specifies the user privilege. The value 0 indicates common user, 1 registrar, 2 administrator, and 3 super administrator.

1. The Enable parameter specifies whether a user account is enabled. The value 1 indicates that the user account is enabled and 0 indicates that the user account is disabled.

Note

Applicable to TFT and IFACE devices

GetUserInfoByPIN2()

VARIANT_BOOL GetUserInfoByPIN2	(	LONG	dwMachineNumber,
		BSTR *	Name,
		BSTR *	Password,
		LONG *	Privilege,
		VARIANT_BOOL *	Enabled
	)

To obtain user information based on the current attribute value pin2.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID Name BSTR* [out] User name Name BSTR* [out] User password Privilege LONG* [out] User privilege Enabled BOOL* [out] Flag that indicates whether a user account is enabled

Returns

Value description:

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

See also

Attention

1. The Privilege parameter specifies the user privilege. The value 0 indicates common user, 1 registrar, 2 administrator, and 3 super administrator.

1. The Enable parameter specifies whether a user account is enabled. The value 1 indicates that the user account is enabled and 0 indicates that the user account is disabled.

Note

Applicable to BW

GetUserInfoByCard()

VARIANT_BOOL GetUserInfoByCard	(	LONG	dwMachineNumber,
		BSTR *	Name,
		BSTR *	Password,
		LONG *	Privilege,
		VARIANT_BOOL *	Enabled
	)

To obtain user information based on the current attribute value CardNumber.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID Name BSTR* [out] User name Name BSTR* [out] User password Privilege LONG* [out] User privilege Enabled BOOL* [out] Flag that indicates whether a user account is enabled

Returns

Value description:

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

See also

Attention

1. The Privilege parameter specifies the user privilege. The value 0 indicates common user, 1 registrar, 2 administrator, and 3 super administrator.

1. The Enable parameter specifies whether a user account is enabled. The value 1 indicates that the user account is enabled and 0 indicates that the user account is disabled.

Note

Applicable to BW

GetUserIDByPIN2()

VARIANT_BOOL GetUserIDByPIN2	(	LONG	PIN2,
		LONG *	UserID
	)

To obtain the user ID based on pin2.

Parameters

Parameter description: name type param direction description of param PIN2 LONG [in] Pin2 value UserID LONG* [out] User 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

GetPIN2()

VARIANT_BOOL GetPIN2	(	LONG	UserID,
		LONG *	PIN2
	)

To obtain the pin2 value based on the user ID.

Parameters

Parameter description: name type param direction description of param UserID LONG [in] User ID PIN2 LONG* [out] Pin2 value

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

GetEnrollData()

VARIANT_BOOL GetEnrollData	(	LONG	dwMachineNumber,
		LONG	dwEnrollNumber,
		LONG	dwEMachineNumber,
		LONG	dwBackupNumber,
		LONG *	dwMachinePrivilege,
		LONG *	dwEnrollData,
		LONG *	dwPassWord
	)

To obtain registration data (fingerprint template and part of the user information) based on the user ID and corresponding index.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID dwEnrollNumber LONG [in] Machine ID dwEMachineNumber LONG [in] User ID dwBackupNumber LONG [in] Fingerprint index dwMachinePrivilege LONG* [out] User privilege dwEnrollData LONG* [out] Fingerprint template dwPassWord LONG* [out] Password

Returns

Value description:

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

See also

Attention

1. The values of dwMachineNumber and dwEMachineNumber must be the same.

1. The fingerprint index ranges from 0 to 9. If the fingerprint template is obtained successfully, the password also is obtained. The index 10 indicates obtaining only the password.
   
2. The value 0 indicates common user, 1 registrar, 2 administrator, and 3 super administrator.

Note

Applicable to BW

SetEnrollData()

VARIANT_BOOL SetEnrollData	(	LONG	dwMachineNumber,
		LONG	dwEnrollNumber,
		LONG	dwEMachineNumber,
		LONG	dwBackupNumber,
		LONG	dwMachinePrivilege,
		LONG *	dwEnrollData,
		LONG	dwPassWord
	)

To set registration data (fingerprint template and part of the user information)

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID dwEnrollNumber LONG [in] Machine ID dwEMachineNumber LONG [in] User ID dwBackupNumber LONG [in] Fingerprint index dwMachinePrivilege LONG [in] User privilege dwEnrollData LONG* [in] Fingerprint template to be uploaded dwPassWord LONG [in] User password

Returns

Value description:

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

See also

Attention

1. The values of dwMachineNumber and dwEMachineNumber must be the same.

1. The fingerprint index ranges from 0 to 9. The index 10 indicates setting the user password.
   
2. The value 0 indicates common user, 1 registrar, 2 administrator, and 3 super administrator.

Note

Applicable to BW

DeleteEnrollData()

VARIANT_BOOL DeleteEnrollData	(	LONG	dwMachineNumber,
		LONG	dwEnrollNumber,
		LONG	dwEMachineNumber,
		LONG	dwBackupNumber
	)

To delete registration data.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID dwEnrollNumber LONG [in] Machine ID dwEMachineNumber LONG [in] User ID dwBackupNumber LONG [in] Fingerprint index

Returns

Value description:

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

See also

Attention

1. The values of dwMachineNumber and dwEMachineNumber must be the same.

1. The dwBackupNumber parameter specifies the fingerprint index. The meanings are described as follows:
   The index range is 0-9. The machine will also check whether a user has other fingerprints and passwords. If no, the machine will delete the user. The index 10 indicates deleting the password. The machine will also check whether the user has fingerprint data. If no, the machine will delete the user. The index 11 indicates deleting all fingerprint data of the user, and 12 indicates deleting the user (including the fingerprints, card number and password).

Note

Applicable to BW

SSR_DeleteEnrollData()

VARIANT_BOOL SSR_DeleteEnrollData	(	LONG	dwMachineNumber,
		BSTR	dwEnrollNumber,
		LONG	dwBackupNumber
	)

To delete registration data.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID dwEnrollNumber BSTR [in] User ID dwBackupNumber LONG [in] Fingerprint index

Returns

Value description:

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

See also

Attention

The dwBackupNumber parameter specifies the fingerprint index. The meanings are described as follows:
The index range is 0-9. The machine will also check whether a user has other fingerprints and passwords. If no, the machine will delete the user. The index 10 indicates deleting the password. The machine will also check whether the user has fingerprint data. If no, the machine will delete the user. The index 11 indicates deleting all fingerprint data of the user, and 12 indicates deleting the user (including the fingerprints, card number and password).

Note

Applicable to TFT and IFACE devices

SSR_DeleteEnrollDataExt()

VARIANT_BOOL SSR_DeleteEnrollDataExt	(	[in] LONG	dwMachineNumber,
		BSTR	dwEnrollNumber,
		LONG	dwBackupNumber
	)

To delete registration data.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID dwEnrollNumber BSTR [in] User ID dwBackupNumber LONG [in] Fingerprint index

Returns

Value description:

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

See also

Attention

1. The dwBackupNumber parameter specifies the fingerprint index. The meanings are described as follows:
The index range is 0-9. The machine will also check whether a user has other fingerprints and passwords. If no, the machine will delete the user. The index 10 indicates deleting the password. The machine will also check whether the user has fingerprint data. If no, the machine will delete the user. The indexes 11 and 13 indicate deleting all fingerprint data of the user. The index 12 indicates deleting the user, including the fingerprints, card number and password.

1. This function differs from SSR_DeleteEnrollData in that it can delete all fingerprint data by using parameter 13, and therefore this function has higher efficiency.
   

Note

Applicable to TFT and IFACE devices

GetEnrollDataStr()

VARIANT_BOOL GetEnrollDataStr	(	LONG	dwMachineNumber,
		LONG	dwEnrollNumber,
		LONG	dwEMachineNumber,
		LONG	dwBackupNumber,
		LONG *	dwMachinePrivilege,
		BSTR *	dwEnrollData,
		LONG *	dwPassWord
	)

To obtain registration data (fingerprint template and part of the user information) based on the user ID and corresponding index. This function differs from GetEnrollData only in the fingerprint template format.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID dwEnrollNumber LONG [in] Machine ID dwEMachineNumber LONG [in] User ID dwBackupNumber LONG [in] Fingerprint index dwMachinePrivilege LONG* [out] User privilege dwEnrollData BSTR* [out] Fingerprint template to be uploaded dwPassWord LONG* [out] User password

Returns

Value description:

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

See also

Attention

1. The values of dwMachineNumber and dwEMachineNumber must be the same.

1. The fingerprint index ranges from 0 to 9. If the fingerprint template is obtained successfully, the password also is obtained. The index 10 indicates obtaining only the password.
   
2. The value 0 indicates common user, 1 registrar, 2 administrator, and 3 super administrator.

Note

Applicable to BW

SetEnrollDataStr()

VARIANT_BOOL SetEnrollDataStr	(	LONG	dwMachineNumber,
		LONG	dwEnrollNumber,
		LONG	dwEMachineNumber,
		LONG	dwBackupNumber,
		LONG	dwMachinePrivilege,
		BSTR	dwEnrollData,
		LONG	dwPassWord
	)

To set registration data (fingerprint template and part of the user information)

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID. The two values must be the same. dwEnrollNumber LONG [in] Machine ID. The two values must be the same. dwEMachineNumber LONG [in] User ID dwBackupNumber LONG [in] Fingerprint index dwMachinePrivilege LONG [in] User privilege dwEnrollData BSTR [in] Fingerprint template to be uploaded dwPassWord LONG [in] User password

Returns

Value description:

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

See also

Attention

1. The values of dwMachineNumber and dwEMachineNumber must be the same.

1. The fingerprint index ranges from 0 to 9. If the fingerprint template is obtained successfully, the password also is obtained. The index 10 indicates obtaining only the password.
   
2. The value 0 indicates common user, 1 registrar, 2 administrator, and 3 super administrator.
   
3. The dwEnrollData parameter specifies the uploaded fingerprint template, which is a character string.

Note

Applicable to BW

ReadAllTemplate()

VARIANT_BOOL ReadAllTemplate

(

LONG

dwMachineNumber

)

To read all fingerprint templates on the machine to the memory of the PC. This function reads all fingerprint data to the memory at a time. Compared with the function that reads data records from the machine one by one, this function has higher efficiency.

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

DelUserTmp()

VARIANT_BOOL DelUserTmp	(	LONG	dwMachineNumber,
		LONG	dwEnrollNumber,
		LONG	dwFingerIndex
	)

To delete a specified fingerprint template.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID dwEnrollNumber LONG [in] User ID dwFingerIndex LONG [in] Fingerprint index

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

SSR_DelUserTmp()

VARIANT_BOOL SSR_DelUserTmp	(	LONG	dwMachineNumber,
		BSTR	dwEnrollNumber,
		LONG	dwFingerIndex
	)

To delete a fingerprint template.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID dwEnrollNumber BSTR [in] User ID dwFingerIndex LONG [in] Fingerprint index, ranging from 0 to 9

Returns

Value description:

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

See also

Attention

Note

Applicable to TFT and IFACE devices

SSR_SetUserTmpExt()

VARIANT_BOOL SSR_SetUserTmpExt	(	LONG	dwMachineNumber,
		LONG	IsDeleted,
		BSTR	dwEnrollNumber,
		LONG	dwFingerIndex,
		BYTE *	TmpData
	)

To upload a fingerprint template. This function is an enhanced version of SSR_SetUserTmp.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID IsDeleted LONG [in] Deletion flag dwEnrollNumber BSTR [in] User ID dwFingerIndex LONG [in] Fingerprint index, ranging from 0 to 9 TmpData BYTE* [in] Fingerprint template

Returns

Value description:

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

See also

Attention

IsDeleted is a deletion flag. If a fingerprint with the specified index already exists on the machine when you upload a fingerprint template, this parameter specifies whether to overwrite the original fingerprint. The value 1 indicates overwriting the original fingerprint and 0 indicates not overwriting the original fingerprint.

Note

Applicable to TFT and IFACE devices

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID IsDeleted LONG [in] Deletion flag dwEnrollNumber BSTR [in] User ID dwFingerIndex LONG [in] Fingerprint index, ranging from 0 to 9 TmpData BYTE* [in] Fingerprint template

Returns

Value description:

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

See also

Attention

IsDeleted is a deletion flag. If a fingerprint with the specified index already exists on the machine when you upload a fingerprint template, this parameter specifies whether to overwrite the original fingerprint. The value 1 indicates overwriting the original fingerprint and 0 indicates not overwriting the original fingerprint.

Note

Applicable to TFT

GetUserTmp()

VARIANT_BOOL GetUserTmp	(	LONG	dwMachineNumber,
		LONG	dwEnrollNumber,
		LONG	dwFingerIndex,
		BYTE *	TmpData,
		LONG *	TmpLength
	)

To obtain a fingerprint template in binary format. This function differs from GetUserTmpStr only in the fingerprint template format.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID dwEnrollNumber LONG [in] User ID dwFingerIndex LONG [in] Fingerprint index TmpData BYTE* [out] Fingerprint template data TmpLength LONG* [out] Length of the fingerprint template

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

SetUserTmp()

VARIANT_BOOL SetUserTmp	(	LONG	dwMachineNumber,
		LONG	dwEnrollNumber,
		LONG	dwFingerIndex,
		BYTE *	TmpData
	)

To upload a fingerprint template in binary format. This function differs from SetUserTmpStr only in the fingerprint template format.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID dwEnrollNumber LONG [in] User ID dwFingerIndex LONG [in] Fingerprint index TmpData BYTE* [in] Fingerprint template data

Returns

Value description:

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

See also

Attention

The user must already exist on the machine. If the index number of a user has been registered, the fingerprint template will be overwritten.

Note

Applicable to BW

GetUserTmpStr()

VARIANT_BOOL GetUserTmpStr	(	LONG	dwMachineNumber,
		LONG	dwEnrollNumber,
		LONG	dwFingerIndex,
		BSTR *	TmpData,
		LONG *	TmpLength
	)

To obtain a fingerprint template in character string format. This function differs from GetUserTmp only in the fingerprint template format.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID dwEnrollNumber LONG [in] User ID dwFingerIndex LONG [in] Fingerprint index TmpData BSTR* [out] Fingerprint template data TmpLength LONG* [out] Length of the fingerprint template

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

SetUserTmpStr()

VARIANT_BOOL SetUserTmpStr	(	LONG	dwMachineNumber,
		[in] LONG	dwEnrollNumber,
		LONG	dwFingerIndex,
		[in] BSTR	TmpData
	)

To obtain a fingerprint template in character string format. This function differs from SetUserTmp only in the fingerprint template format.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID dwEnrollNumber LONG [in] User ID dwFingerIndex LONG [in] Fingerprint index TmpData BSTR [in] Fingerprint template

Returns

Value description:

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

See also

Attention

The user must already exist on the machine. If the index number of a user has been registered, the fingerprint template will be overwritten.

Note

Applicable to BW

GetUserTmpEx()

VARIANT_BOOL GetUserTmpEx	(	LONG	dwMachineNumber,
		BSTR	dwEnrollNumber,
		LONG	dwFingerIndex,
		LONG *	Flag,
		BYTE *	TmpData,
		LONG *	TmpLength
	)

To obtain fingerprint template ZKFinger 10.0 in binary format.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID dwEnrollNumber BSTR [in] User ID dwFingerIndex LONG [in] Fingerprint index Flag LONG* [out] Flag that indicates whether the fingerprint template is valid or a duress fingerprint TmpData BYTE* [out] Fingerprint template TmpLength LONG* [out] Length of the fingerprint template

Returns

Value description:

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

See also

Attention

1. The machine firmware must support the duress fingerprint function. That is, the internal version of the firmware must be Ver6.60 or later.

1. The Flag parameter specifies whether the fingerprint template is valid or a duress fingerprint. The value 0 indicates that the fingerprint template is invalid, 1 indicates that the fingerprint template is valid, and 3 indicates that the fingerprint template is a duress fingerprint.

Note

Applicable to BW, TFT, and IFACE devices

SetUserTmpEx()

VARIANT_BOOL SetUserTmpEx	(	LONG	dwMachineNumber,
		LONG	dwEnrollNumber,
		LONG	dwFingerIndex,
		LONG	Flag,
		BYTE *	TmpData
	)

To upload fingerprint template ZKFinger 10.0 in binary format.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID dwEnrollNumber LONG [in] User ID dwFingerIndex LONG [in] Fingerprint index Flag LONG [in] Flag that indicates whether the fingerprint template is valid or a duress fingerprint TmpData BYTE* [in] Fingerprint template data

Returns

Value description:

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

See also

Attention

1. The machine firmware must support the duress fingerprint function. That is, the internal version of the firmware must be Ver6.60 or later.

1. The Flag parameter specifies whether the fingerprint template is valid or a duress fingerprint. The value 0 indicates that the fingerprint template is invalid, 1 indicates that the fingerprint template is valid, and 3 indicates that the fingerprint template is a duress fingerprint.

Note

Applicable to BW, TFT, and IFACE devices

GetUserTmpExStr()

VARIANT_BOOL GetUserTmpExStr	(	LONG	dwMachineNumber,
		BSTR	dwEnrollNumber,
		LONG	dwFingerIndex,
		LONG *	Flag,
		BSTR *	TmpData,
		LONG *	TmpLength
	)

To obtain fingerprint template ZKFinger 10.0 in character string format.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID dwEnrollNumber BSTR [in] User ID dwFingerIndex LONG [in] Fingerprint index Flag LONG* [out] Flag that indicates whether the fingerprint template is valid or a duress fingerprint TmpData BSTR* [out] Fingerprint template TmpLength LONG* [out] Length of the fingerprint template

Returns

Value description:

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

See also

Attention

1. The machine firmware must support the duress fingerprint function. That is, the internal version of the firmware must be Ver6.60 or later.

1. The Flag parameter specifies whether the fingerprint template is valid or a duress fingerprint. The value 0 indicates that the fingerprint template is invalid, 1 indicates that the fingerprint template is valid, and 3 indicates that the fingerprint template is a duress fingerprint.

Note

Applicable to BW, TFT, and IFACE devices

SetUserTmpExStr()

VARIANT_BOOL SetUserTmpExStr	(	LONG	dwMachineNumber,
		LONG	dwEnrollNumber,
		LONGdwFingerIndex	,
		LONG	Flag,
		BSTR	TmpData
	)

To upload fingerprint template ZKFinger 10.0 in character string format.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID dwEnrollNumber LONG [in] User ID dwFingerIndex LONG [in] Fingerprint index Flag LONG [in] Flag that indicates whether the fingerprint template is valid or a duress fingerprint TmpData BSTR [in] Fingerprint template

Returns

Value description:

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

See also

Attention

1. The machine firmware must support the duress fingerprint function. That is, the internal version of the firmware must be Ver6.60 or later.

1. The Flag parameter specifies whether the fingerprint template is valid or a duress fingerprint. The value 0 indicates that the fingerprint template is invalid, 1 indicates that the fingerprint template is valid, and 3 indicates that the fingerprint template is a duress fingerprint.

Note

Applicable to BW, TFT, and IFACE devices

SSR_GetUserTmp()

VARIANT_BOOL SSR_GetUserTmp	(	LONG	dwMachineNumber,
		BSTR	dwEnrollNumber,
		LONG	dwFingerIndex,
		BYTE *	TmpData,
		LONG *	TmpLength
	)

To obtain a fingerprint template in binary format. This function differs from SSR_GetUserTmpStr only in the fingerprint template format.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID dwEnrollNumber BSTR [in] User ID dwFingerIndex LONG [in] Fingerprint index, ranging from 0 to 9 TmpData BYTE* [in] Fingerprint template data TmpLength LONG* [in] Length of the fingerprint template

Returns

Value description:

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

See also

Attention

Note

Applicable to TFT

SSR_GetUserTmpStr()

VARIANT_BOOL SSR_GetUserTmpStr	(	LONG	dwMachineNumber,
		BSTR	dwEnrollNumber,
		LONG	dwFingerIndex,
		BSTR *	TmpData,
		LONG *	TmpLength
	)

To obtain a fingerprint template in character string format. This function differs from SSR_GetUserTmp only in the fingerprint template format.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID dwEnrollNumber BSTR [in] User ID dwFingerIndex LONG [in] Fingerprint index, ranging from 0 to 9 TmpData BSTR* [out] Fingerprint template data TmpLength LONG* [out] Length of the fingerprint template

Returns

Value description:

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

See also

Attention

Note

Applicable to TFT

SSR_SetUserTmp()

VARIANT_BOOL SSR_SetUserTmp	(	LONG	dwMachineNumber,
		BSTR	dwEnrollNumber,
		LONG	dwFingerIndex,
		BYTE *	TmpData
	)

To upload a fingerprint template in binary format. This function differs from SSR_SetUserTmpStr only in the fingerprint template format.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID dwEnrollNumber BSTR [in] User ID dwFingerIndex LONG [in] Fingerprint index, ranging from 0 to 9 TmpData BYTE* [in] Fingerprint template

Returns

Value description:

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

See also

Attention

Note

Applicable to TFT

SSR_SetUserTmpStr()

VARIANT_BOOL SSR_SetUserTmpStr	(	LONG	dwMachineNumber,
		BSTR	dwEnrollNumber,
		LONG	dwFingerIndex,
		BSTR	TmpData
	)

To upload a fingerprint template in character string format. This function differs from SSR_SetUserTmp only in the fingerprint template format.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID dwEnrollNumber BSTR [in] User ID LONG dwFingerIndex LONG [in] Fingerprint index, ranging from 0 to 9 TmpData BSTR [in] Fingerprint template

Returns

Value description:

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

See also

Attention

Note

Applicable to TFT

GetFPTempLength()

VARIANT_BOOL GetFPTempLength	(	BYTE *	dwEnrollData,
		LONG *	Len
	)

To calculate length of a specified fingerprint template.

Parameters

Parameter description: name type param direction description of param dwEnrollData BYTE* [in] Pointer that points to the fingerprint template Len LONG* [out] The value is the fingerprint template length described by dwEnrollData.

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

GetFPTempLengthStr()

VARIANT_BOOL GetFPTempLengthStr	(	BSTR	dwEnrollData,
		LONG *	Len
	)

To calculate length of a specified fingerprint template.

Parameters

Parameter description: name type param direction description of param dwEnrollData BSTR [in] Fingerprint template in character string format Len LONG* [out] The value is the fingerprint template length described by dwEnrollData.

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

FPTempConvert()

VARIANT_BOOL FPTempConvert	(	BYTE *	TmpData1,
		BYTE *	TmpData2,
		LONG *	Size
	)

To convert an offline fingerprint template into a BIOKEY fingerprint template. This function differs from FPTempConvertStr only in the data format.

Parameters

Parameter description: name type param direction description of param TmpData1 BYTE* [in] Offline fingerprint template to be converted TmpData2 BYTE* [out] The value is the BIOKEY fingerprint template after conversion. Size LONG* [out] The value is the size of the BIOKEY fingerprint template after conversion.

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

FPTempConvertStr()

VARIANT_BOOL FPTempConvertStr	(	BSTR	TmpData1,
		BSTR *	TmpData2,
		LONG *	Size
	)

To convert an offline fingerprint template into a BIOKEY fingerprint template in character string format. This function differs from FPTempConvert only in the data format.

Parameters

Parameter description: name type param direction description of param TmpData1 BSTR [in] Offline fingerprint template to be converted TmpData2 BSTR* [out] The value is the BIOKEY fingerprint template after conversion. Size LONG* [out] The value is the size of the BIOKEY fingerprint template after conversion.

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

FPTempConvertNew()

VARIANT_BOOL FPTempConvertNew	(	BYTE *	TmpData1,
		BYTE *	TmpData2,
		LONG *	Size
	)

To convert a BIOKEY fingerprint template into an offline fingerprint template. This function differs from FPTempConvertNewStr only in the data format.

Parameters

Parameter description: name type param direction description of param TmpData1 BYTE* [in] Offline fingerprint template to be converted TmpData2 BYTE* [out] The value is the offline fingerprint template after conversion. Size LONG* [out] The value is the size of the offline fingerprint template after conversion.

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

FPTempConvertNewStr()

VARIANT_BOOL FPTempConvertNewStr	(	BSTR	TmpData1,
		BSTR *	TmpData2,
		LONG *	Size
	)

To convert a BIOKEY fingerprint template into an offline fingerprint template in character string format. This function differs from FPTempConvertNew only in the data format.

Parameters

Parameter description: name type param direction description of param TmpData1 BSTR [in] Offline fingerprint template to be converted TmpData2 BSTR* [out] The value is the offline fingerprint template after conversion. Size LONG* [out] The value is the size of the offline fingerprint template after conversion.

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

SetUserFace()

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

To upload a face template. This function differs from SetUserFaceStr only in the face template format.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID dwEnrollNumber BSTR [in] User ID (not more than 24 digits) dwFaceIndex LONG [in] Face index TmpData BYTE* [in] Face template TmpLength LONG [in] Length of the face template

Returns

Value description:

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

See also

Attention

The value of dwFaceIndex is always 50, which indicates uploading all face templates of a user.

Note

Applicable to IFACE

GetUserFace()

VARIANT_BOOL GetUserFace	(	LONG	dwMachineNumber,
		BSTR	dwEnrollNumber,
		LONG	dwFaceIndex,
		BYTE *	TmpData,
		LONG *	TmpLength
	)

To download a face template. This function differs from GetUserFaceStr only in the face template format.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID dwEnrollNumber BSTR [in] User ID (not more than 24 digits) dwFaceIndex LONG [in] Face index TmpData BYTE* [out] Face template TmpLength LONG* [out] Length of the face template

Returns

Value description:

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

See also

Attention

The value of dwFaceIndex is always 50, which indicates downloading all face templates of a user.

Note

Applicable to IFACE

DelUserFace()

VARIANT_BOOL DelUserFace	(	LONG	dwMachineNumber,
		BSTR	dwEnrollNumber,
		LONG	dwFaceIndex
	)

To delete a face template.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID dwEnrollNumber BSTR [in] User ID (not more than 24 digits) dwFaceIndex LONG [in] Face index

Returns

Value description:

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

See also

Attention

The value of dwFaceIndex is always 50, which indicates downloading all face templates of a user.

Note

Applicable to IFACE

GetUserFaceStr()

VARIANT_BOOL GetUserFaceStr	(	LONG	dwMachineNumber,
		BSTR	dwEnrollNumber,
		LONG	dwFaceIndex,
		BSTR *	TmpData,
		LONG *	TmpLength
	)

To download a face template. This function differs from GetUserFace in that it returns a face template in character string format.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID dwEnrollNumber BSTR [in] User ID (not more than 24 digits) dwFaceIndex LONG [in] Face index TmpData BSTR* [out] Face template TmpLength LONG* [out] Length of the face template

Returns

Value description:

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

See also

Attention

The value of dwFaceIndex is always 50, which indicates downloading all face templates of a user.

Note

Applicable to IFACE

SetUserFaceStr()

VARIANT_BOOL SetUserFaceStr	(	LONG	dwMachineNumber,
		BSTR	dwEnrollNumber,
		LONG	dwFaceIndex,
		[in] BSTR	TmpData,
		LONG	TmpLength
	)

To upload a face template. This function differs from SetUserFace only in the face template format.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID dwEnrollNumber BSTR [in] User ID (not more than 24 digits) dwFaceIndex LONG [in] Face index TmpData BSTR [in] Face template TmpLength LONG [in] Length of the face template

Returns

Value description:

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

See also

Attention

The value of dwFaceIndex is always 50, which indicates uploading all face templates of a user.

Note

Applicable to IFACE