Detailed Description

Author: http://www.zkteco.com

Date: 2017-10-01

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

Note

Functions
VARIANT_BOOL	ClearAdministrators (LONG dwMachineNumber)

VARIANT_BOOL	EnableDevice (LONG dwMachineNumber, VARIANT_BOOL bFlag)

VARIANT_BOOL	EnableClock (LONG Enabled)

VARIANT_BOOL	DisableDeviceWithTimeOut (LONG dwMachineNumber, LONG TimeOutSec)

VARIANT_BOOL	PowerOffDevice (LONG dwMachineNumber)

VARIANT_BOOL	RestartDevice (LONG dwMachineNumber)

VARIANT_BOOL	StartEnroll (LONG UserID, LONG FingerID)

VARIANT_BOOL	StartEnrollEx (BSTR UserID, LONG FingerID, LONG Flag)

VARIANT_BOOL	StartVerify (LONG UserID, LONG FingerID)

VARIANT_BOOL	StartIdentify ()

VARIANT_BOOL	CancelOperation ()

VARIANT_BOOL	WriteLCD (LONG Row, LONG Col, BSTR Text)

VARIANT_BOOL	ClearLCD ()

VARIANT_BOOL	WriteCard (LONG dwMachineNumber, LONG dwEnrollNumber, LONG dwFingerIndex1, BYTE TmpData1, LONG dwFingerIndex2, BYTE TmpData2, LONG dwFingerIndex3, BYTE TmpData3, LONG dwFingerIndex4, BYTE TmpData4,)

VARIANT_BOOL	EmptyCard (LONG dwMachineNumber)

VARIANT_BOOL	GetHIDEventCardNumAsStr (BSTR *strHIDEventCardNum)

VARIANT_BOOL	CaptureImage (VARIANT_BOOL FullImage, LONG Width, LONG Height, BYTE *Image, BSTR ImageFile)

VARIANT_BOOL	UpdateFirmware (BSTR FirmwareFile)

VARIANT_BOOL	BeginBatchUpdate (LONG dwMachineNumber, LONG UpdateFlagl)

VARIANT_BOOL	BatchUpdate (LONG dwMachineNumber)

VARIANT_BOOL	CancelBatchUpdate (LONG dwMachineNumber)

VARIANT_BOOL	PlayVoice (LONG Position, LONG Length)

VARIANT_BOOL	PlayVoiceByIndex (LONG Index)

VARIANT_BOOL	ReadAttRule (LONG dwMachineNumber)

VARIANT_BOOL	SaveTheDataToFile (LONG dwMachineNumber, BSTR TheFilePath, LONG FileFlag)

VARIANT_BOOL	ReadTurnInfo (LONG dwMachineNumber)

VARIANT_BOOL	SSR_OutPutHTMLRep (LONG dwMachineNumber, BSTR dwEnrollNumber, BSTR AttFile, BSTR UserFile, BSTR DeptFile, BSTR TimeClassFile, BSTR AttruleFile, LONG BYear, LONG BMonth, LONG BDay, LONG BHour, LONG BMinute, LONG BSecond, LONG EYear, LONG EMonth, LONG EDay, LONG EHour, LONG EMinute, LONG ESecond, BSTR TempPath, BSTR OutFileName, LONG HTMLFlag, LONG resv1, BSTR resv2)

VARIANT_BOOL	Connect_P4P (BSTR uid)

LONG	GetDeviceStatusEx (LONG dwMachineNumber)

VARIANT_BOOL	GetConnectStatus (LONG *dwErrorCode) VARIANT_BOOL GetSysOption(LONG dwMachineNumber

VARIANT_BOOL	SetSysOption (LONG dwMachineNumber, BSTR Option, BSTR Value)

VARIANT_BOOL	SearchDevice (BSTR commType, BSTR address, BSTR *DevBuffer, LONG DevBufferSize)

VARIANT_BOOL	SetCommProType (LONG proType)

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

Function Documentation

◆ ClearAdministrators()

VARIANT_BOOL ClearAdministrators ( LONG dwMachineNumber )

To clear the operation rights of all administrators.

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

◆ EnableDevice()

VARIANT_BOOL EnableDevice	(	LONG	dwMachineNumber,
		VARIANT_BOOL	bFlag
	)

To enable or disable the machine. After the machine is disabled, the fingerprint, keyboard, and card modules are unavailable.

Parameters

Parameter description:

name	type	param direction	description of param
dwMachineNumber	LONG	[in]	Machine ID
bFlag	BOOL	[in]	Flag that indicates whether the machine is enabled. The value 1 indicates that the machine is enabled and 0 indicates that the machine is disabled.

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

◆ EnableClock()

VARIANT_BOOL EnableClock ( LONG Enabled )

To enable or disable the display of the colon (:) in the time of the machine. The colon is displayed on the main screen of the machine if enabled, and not displayed if disabled.

Parameters

Parameter description:

name	type	param direction	description of param
Enabled	LONG	[in]	Whether to enable the display of the colon. The value 1 indicates enabling the display of the colon and 0 indicates disabling the display of the colon.

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

◆ DisableDeviceWithTimeOut()

VARIANT_BOOL DisableDeviceWithTimeOut	(	LONG	dwMachineNumber,
		LONG	TimeOutSec
	)

To disable the machine for a period of time.

Parameters

Parameter description:

name	type	param direction	description of param
dwMachineNumber	LONG	[in]	Machine ID
TimeOutSec	LONG	[in]	Time period during which the machine is disabled

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

◆ PowerOffDevice()

VARIANT_BOOL PowerOffDevice ( LONG dwMachineNumber )

To shut down 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

◆ RestartDevice()

VARIANT_BOOL RestartDevice ( LONG dwMachineNumber )

To restart 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

◆ StartEnroll()

VARIANT_BOOL StartEnroll	(	LONG	UserID,
		LONG	FingerID
	)

To register a user. The machine will then enter the user registration state and waits for the user to scan fingerprints.

Parameters

Parameter description:

name	type	param direction	description of param
UserID	LONG	[in]	ID of the user to be registered
FingerID	LONG	[in]	Index of the fingerprint of the user, 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: After this function is invoked and the user scans fingerprints for three times, the machine may not respond when the user scans fingerprints again. In this case, invoke StartIdentify to enable the machine to enter the waiting state.

Note: Applicable to BW

◆ StartEnrollEx()

VARIANT_BOOL StartEnrollEx	(	BSTR	UserID,
		LONG	FingerID,
		LONG	Flag
	)

To register a user. The machine will then enter the user registration state and waits for the user to scan fingerprints.

Parameters

Parameter description:

name	type	param direction	description of param
UserID	BSTR	[in]	ID of the user to be registered
FingerID	LONG	[in]	Index of the fingerprint of the user, ranging from 0 to 9
Flag	LONG	[in]	Flag that indicates whether the fingerprint template is valid or a duress fingerprint

Returns

Value description:

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

See also

Attention

1. After this function is invoked and the user scans fingerprints for three times, the machine may not respond when the user scans fingerprints again. In this case, invoke StartIdentify to enable the machine to enter the waiting state.

The Flag parameter indicates whether the fingerprint template is valid, or the fingerprint template is 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 TFT

◆ StartVerify()

VARIANT_BOOL StartVerify	(	LONG	UserID,
		LONG	FingerID
	)

To start 1:1 comparison.

Parameters

Parameter description:

name	type	param direction	description of param
UserID	LONG	[in]	ID of the user to be verified
FingerID	LONG	[in]	Index of the fingerprint of the user, 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 BW and TFT devices

◆ StartIdentify()

VARIANT_BOOL StartIdentify ( )

To start 1:N comparison. Then the machine will enter the 1:N verification state.

Parameters

None

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 and TFT devices

◆ CancelOperation()

VARIANT_BOOL CancelOperation ( )

To cancel the current fingerprint registration state of the machine.

Parameters

None

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 and TFT devices

◆ WriteLCD()

VARIANT_BOOL WriteLCD	(	LONG	Row,
		LONG	Col,
		BSTR	Text
	)

To write data. Specifically, this function is used to write a character string to any row of any column on the machine.

Parameters

Parameter description:

name	type	param direction	description of param
Row	LONG	[in]	Start row
Col	LONG	[in]	Start column
Text	BSTR	[in]	Content to be written on the screen of the machine

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

◆ ClearLCD()

VARIANT_BOOL ClearLCD ( )

To clear the screen of the machine. Specifically, this function is used to clear all information displayed on the LCD screen of the machine.

Parameters

None

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

◆ WriteCard()

VARIANT_BOOL WriteCard	(	LONG	dwMachineNumber,
		LONG	dwEnrollNumber,
		LONG	dwFingerIndex1,
		BYTE *	TmpData1,
		LONG	dwFingerIndex2,
		BYTE *	TmpData2,
		LONG	dwFingerIndex3,
		BYTE *	TmpData3,
		LONG	dwFingerIndex4,
		BYTE *	TmpData4
	)

To write a specified user and the fingerprint template of the user to the MF card. After this function is invoked, the user needs to punch the MF card on the machine.

Parameters

Parameter description:

name	type	param direction	description of param
dwMachineNumber	LONG	[in]	Machine ID
dwEnrollNumber	LONG	[in]	User ID
dwFingerIndex1	LONG	[in]	Fingerprint index, ranging from 0 to 3
TmpData1	BYTE*	[in]	Fingerprint template corresponding to the fingerprint index
dwFingerIndex2	LONG	[in]	Fingerprint index, ranging from 0 to 3
TmpData2	BYTE*	[in]	Fingerprint template corresponding to the fingerprint index
dwFingerIndex3	LONG	[in]	Fingerprint index, ranging from 0 to 3
TmpData3	BYTE*	[in]	Fingerprint template corresponding to the fingerprint index
dwFingerIndex4	LONG	[in]	Fingerprint index, ranging from 0 to 3
TmpData4	BYTE*	[in]	Fingerprint template corresponding to the fingerprint index

Returns

Value description:

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

See also

Attention: TmpData1 cannot be left blank

Note: Applicable to BW, TFT, and IFACE devices

◆ EmptyCard()

VARIANT_BOOL EmptyCard ( LONG dwMachineNumber )

To clear the MF card.

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

◆ GetHIDEventCardNumAsStr()

VARIANT_BOOL GetHIDEventCardNumAsStr ( BSTR * strHIDEventCardNum )

To query the number of the card that is punched most recently.

Parameters

Parameter description:

name	type	param direction	description of param
strHIDEventCardNum	BSTR*	[out]	Number of the punched card

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

◆ CaptureImage()

VARIANT_BOOL CaptureImage	(	VARIANT_BOOL	FullImage,
		LONG *	Width,
		LONG *	Height,
		BYTE *	Image,
		BSTR	ImageFile
	)

To capture an image of the finger of which the fingerprint is being scanned.

Parameters

Parameter description:

name	type	param direction	description of param
FullImage	BOOL	[in]	Whether to capture an image of the entire finger. The value True indicates capturing an image of the entire finger and False indicates capturing an image of only the fingerprint.
Width	LONG*	[in]	Width of the captured image
Height	LONG*	[in]	Height of the captured image
Image	BYTE*	[in]	Fingerprint image in binary format
ImageFile	BSTR	[in]	Name of the file of captured image to be saved (including the path)

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

◆ UpdateFirmware()

VARIANT_BOOL UpdateFirmware ( BSTR FirmwareFile )

To upgrade the firmware. To use this function, obtain the firmware from the technical support engineers of our company beforehand.

Parameters

Parameter description:

name	type	param direction	description of param
FirmwareFile	BSTR	[in]	Name of the firmware file to be upgraded (including the path)

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

◆ BeginBatchUpdate()

VARIANT_BOOL BeginBatchUpdate	(	LONG	dwMachineNumber,
		LONG	UpdateFlagl
	)

To get ready for uploading data in batches. For example, if you invoke this function before uploading data such as fingerprint templates or user information, the SDK will temporarily store the data in the buffer. Then you can invoke BatchUpdate to upload the data to the machine.

Parameters

Parameter description:

name	type	param direction	description of param
dwMachineNumber	LONG	[in]	Machine ID
UpdateFlagl	LONG	[in]	Whether to overwrite the original fingerprint template

Returns

Value description:

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

See also

Attention: The UpdateFlag1 parameter specifies whether to overwrite the original fingerprint template if a fingerprint with the same index already exists when you upload a fingerprint template. The value 1 indicates overwriting the original fingerprint template and 0 indicates not overwriting the original fingerprint template.

Note: Applicable to BW, TFT, and IFACE devices

◆ BatchUpdate()

VARIANT_BOOL BatchUpdate ( LONG dwMachineNumber )

To upload data in batches. Generally you are advised to invoke BeginBatchUpdate to upload the data to the buffer before invoking this function.

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

◆ CancelBatchUpdate()

VARIANT_BOOL CancelBatchUpdate ( LONG dwMachineNumber )

To cancel bulk data uploading. You can invoke this function after invoking BeginBatchUpdate but before invoking BatchUpdate. This function aims to release the buffer allocated for bulk data uploading.

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

◆ PlayVoice()

VARIANT_BOOL PlayVoice	(	LONG	Position,
		LONG	Length
	)

To play announcements with specified consecutive indexes. The indexes depend on the machine. You can view the indexes, which range from 0 to 11, in voice testing on the machine.

Parameters

Parameter description:

name	type	param direction	description of param
Position	LONG	[in]	Index of the start announcement
Length	LONG	[in]	Index of the end announcement

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

◆ PlayVoiceByIndex()

VARIANT_BOOL PlayVoiceByIndex ( LONG Index )

To play an announcement with the specified index. The index depends on the machine. You can view the index, which ranges from 0 to 11, in voice testing on the machine.

Parameters

Parameter description:

name	type	param direction	description of param
Index	LONG	[in]	Index of the announcement to be played

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

◆ ReadAttRule()

VARIANT_BOOL ReadAttRule ( LONG dwMachineNumber )

To read the attendance rule of the machine. This function supports OP1000.

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 devices

◆ SaveTheDataToFile()

VARIANT_BOOL SaveTheDataToFile	(	LONG	dwMachineNumber,
		BSTR	TheFilePath,
		LONG	FileFlag
	)

To save the data in the buffer as a file. This function supports OP1000.

Parameters

Parameter description:

name	type	param direction	description of param
dwMachineNumber	LONG	[in]	Machine ID
TheFilePath	BSTR	[in]	Path for saving the file
FileFlag	LONG	[in]	File type flag

Returns

Value description:

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

See also

Attention: The FileFlag parameter specifies the file type. The values are described as follows:
1 Attendance records
2 User
3 Attendance rule
4 Department list
5 Shift

Note: Applicable to BW devices

◆ ReadTurnInfo()

VARIANT_BOOL ReadTurnInfo ( LONG dwMachineNumber )

To read the shift information on the machine. This function supports OP1000.

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 devices

◆ SSR_OutPutHTMLRep()

VARIANT_BOOL SSR_OutPutHTMLRep	(	LONG	dwMachineNumber,
		BSTR	dwEnrollNumber,
		BSTR	AttFile,
		BSTR	UserFile,
		BSTR	DeptFile,
		BSTR	TimeClassFile,
		BSTR	AttruleFile,
		LONG	BYear,
		LONG	BMonth,
		LONG	BDay,
		LONG	BHour,
		LONG	BMinute,
		LONG	BSecond,
		LONG	EYear,
		LONG	EMonth,
		LONG	EDay,
		LONG	EHour,
		LONG	EMinute,
		LONG	ESecond,
		BSTR	TempPath,
		BSTR	OutFileName,
		LONG	HTMLFlag,
		LONG	resv1,
		BSTR	resv2
	)

To generate the attendance report of a user within the specified time period in HTML format. This function supports OP1000.

Parameters

Parameter description:

name	type	param direction	description of param
dwMachineNumber	LONG	[in]	Machine ID
dwEnrollNumber	BSTR	[in]	User ID
AttFile	BSTR	[in]	Name of the attendance record file
UserFile	BSTR	[in]	Name of the user information file
DeptFile	BSTR	[in]	Name of the department information file
TimeClassFile	BSTR	[in]	Name of the shift information file
AttruleFile	BSTR	[in]	Name of the attendance rule file
BYear	LONG	[in]	Start time of the time period
BMonth	LONG	[in]	End time of the time period
BDay	LONG	[in]	Start time of the time period
BHour	LONG	[in]	Start time of the time period
BMinute	LONG	[in]	Start time of the time period
BSecond	LONG	[in]	Start time of the time period
EYear	LONG	[in]	End time of the time period
EMonth	LONG	[in]	End time of the time period
EDay	LONG	[in]	End time of the time period
EHour	LONG	[in]	End time of the time period
EMinute	LONG	[in]	End time of the time period
ESecond	LONG	[in]	End time of the time period
TempPath	BSTR	[in]	Path where other exception files are saved
OutFileName	BSTR	[in]	Attendance report file name (including the path)
HTMLFlag	LONG	[in]	HTML report format
resv1	LONG	[in]	Reserved
resv2	BSTR	[in]	Flow report name

Returns

Value description:

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

See also

Attention: The HTMLFlag parameter specifies the HTML report type. The values are described as follows:
1 Flow report
2 Exception report
3 Statistics report

Note: Applicable to BW devices

◆ Connect_P4P()

VARIANT_BOOL Connect_P4P ( BSTR uid )

To connect P2P devices.

Parameters

Parameter description:

name	type	param direction	description of param
uid	BSTR	[in]	Machine ID

Returns

Value description:

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

See also

Attention: uid is the factory number, used as the identify ID of the P2P devices

Note: Applicable to some P2P devices, such as the K Pro series attendace machine

◆ GetDeviceStatusEx()

LONG GetDeviceStatusEx ( LONG dwMachineNumber )

To get the status of the P2P devices.

Parameters

Parameter description:

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

Returns

Value description:

name	type	description of value
1	LONG	Machine is reading data
2	LONG	Machine is writing data
3	LONG	Machine is working
greater than 3	LONG	The machine is free and the software can operate the machine

See also

Attention: P2P devices could not do multi-threaded work. Must get the device status and when the device isfree the software can operate the machine.

Note: Applicable to some P2P devices, such as the K Pro series attendace machine

◆ GetConnectStatus()

VARIANT_BOOL GetConnectStatus ( LONG * dwErrorCode )

Get the error code return from the function BatchUpdate()

Parameters

Parameter description:

name	type	param direction	description of param
dwErrorCode	LONG*	[out]	Error code

Returns

Value description:

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

See also

Attention: When (dwErrorCode >= -11004 && dwErrorCode <= -10004), the software will disconnect and re-connect the device.

Note: Only used to get the error code return from the function BatchUpdate(), without the limitation of devices. To get parameter value

Parameters

Parameter description:

name	type	param direction	description of param
dwMachineNumber	LONG	[in]	Machine ID
Option	BSTR	[in]	Parameter name
Value	BSTR*	[out]	Parameter 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 and TFT devices

◆ SetSysOption()

VARIANT_BOOL SetSysOption	(	LONG	dwMachineNumber,
		BSTR	Option,
		BSTR	Value
	)

To set parameter value.

Parameters

Parameter description:

name	type	param direction	description of param
dwMachineNumber	LONG	[in]	Machine ID
Option	BSTR	[in]	Parameter name
Value	BSTR	[in]	Parameter 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 and TFT devices

◆ SearchDevice()

VARIANT_BOOL SearchDevice	(	BSTR	commType,
		BSTR	address,
		BSTR *	DevBuffer,
		LONG	DevBufferSize
	)

Use web search devices.

Parameters

Parameter description:

name	type	param direction	description of param
commType	BSTR	[in]	Communication type
address	BSTR	[in]	Communication data
DevBuffer	BSTR*	[out]	Device list
DevBufferSize	LONG	[in]	Size of device list

Returns

Value description:

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

See also

Attention: commType=UDP
address=255.255.255.255 The return data include the IP address, serial number, firmware version, etc.

Note: Applicable to some customized devices

◆ SetCommProType()

VARIANT_BOOL SetCommProType ( LONG proType )

Set the priority to use PULL or Standlone SDK to connect the device.

Parameters

Parameter description:

name	type	param direction	description of param
proType	LONG	[in]	Priority protocol type

Returns

Value description:

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

See also

Attention: proType=1 Priority to use the Standlone SDK protocol proType=2 Priority to use the PULL SDK protocol Default to use Standlone SDK protocol to connect devices. If the customer does not develop PULL devices, this interface is not recommended by the developer.

Note: No dependency with device.

◆ SSR_DelUserTmpExt()

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

Deletes the specified fingerprint template for the specified user.

Parameters

Parameter description:

name	type	param direction	description of param
dwMachineNumber	LONG	[in]	Machine ID
dwEnrollNumber	BSTR	[in]	User ID
dwFingerIndex	LONG	[in]	Fingerprint template ID of the specified user

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 devices

Detailed Description

Functions

Function Documentation

◆ ClearAdministrators()

◆ EnableDevice()

◆ EnableClock()

◆ DisableDeviceWithTimeOut()

◆ PowerOffDevice()

◆ RestartDevice()

◆ StartEnroll()

◆ StartEnrollEx()

◆ StartVerify()

◆ StartIdentify()

◆ CancelOperation()

◆ WriteLCD()

◆ ClearLCD()

◆ WriteCard()

◆ EmptyCard()

◆ GetHIDEventCardNumAsStr()

◆ CaptureImage()

◆ UpdateFirmware()

◆ BeginBatchUpdate()

◆ BatchUpdate()

◆ CancelBatchUpdate()

◆ PlayVoice()

◆ PlayVoiceByIndex()

◆ ReadAttRule()

◆ SaveTheDataToFile()

◆ ReadTurnInfo()

◆ SSR_OutPutHTMLRep()

◆ Connect_P4P()

◆ GetDeviceStatusEx()

◆ GetConnectStatus()

◆ SetSysOption()

◆ SearchDevice()

◆ SetCommProType()

◆ SSR_DelUserTmpExt()