Detailed Description

Author: http://www.zkteco.com

Date: 2017-10-01

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

Note

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

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

VARIANT_BOOL	SSR_GetDeviceDataCount (BSTR TableName, BSTR Filter, BSTR Options)

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

Variables
	BiometricType

	BiometricVersion

	BiometricMaxCount

	BiometricUsedCount

Function Documentation

◆ SSR_SetDeviceData()

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

Set The unification of multiple Biometric Template,The data is sent to the machine.

Parameters

Parameters are shown below:

name	type	param direction	description of param
dwMachineNumber	LONG	[in]	Device ID
TableName	BSTR	[in]	Name of Table
Datas	BSTR	[in]	data records
Options	BSTR	[in]	default is blank for external.

Returns

returned value specification:

name	type	description of value
True	BOOL	Success
False	BOOL	Fault

See also

Attention

TableName: only allow pers_biotemplate(for unified template), firmware doesn't support others.
Datas: data records, data is text format, multiple record using symbol separate, multi-field "field=Value" separate by symbol \t.
Type=1 means FP
Type=2 means Face

Pers_BioTemplate Tablestructure:

Field	Value	Type	annotations
id	Not Null	int4	Self growth field
person_id	Not Null	int4	foreign key,UserID
create_operator		varchar(30)	Createperson
create_time		datatime	Createtime(2015-06-11 09:48:11)
valid_flag	Not Null	char(1)	valid:0:invalid,1:valuedasdefault
is_duress	Not Null	char(1)	Duress:0:Noas default,1:Yes
bio_type	Not Null	int2	Biometrics type:0:general 1:FP 2:Face 3:Voice 4:Iris 5:Retina 6:Palm 7:Vein 8:Palm Vein
major_ver	Not Null	char(1)	FP algorithm: 9.0, 10.3 Face Algorithm: 5.0,7.0, 8.0 FP vein Algorithm: 3.0 Palm algorithm:10 LikeFPalgorithm 10.3, major_ver is 10, minor_ver is 3.
minor_ver	Not Null	char(1)	FP algorithm: 9.0, 10.3 Face Algorithm: 5.0,7.0, 8.0 FP vein Algorithm: 3.0 Palm algorithm:10 LikeFPalgorithm 10.3, major_ver is 10, minor_ver is 3.
data_format		int2	Format of template,FPhasZK 0:ZK 1:ISO 2:ANSI
template_id	Not Null	int4	ForeignKey(FK), template data ID
template_no	Not Null	int2	Biometricsitem index,FP: 0~9 (left hand, little finger/ringfinger/middle finger/index finger/thumb finger, right hand: thumb finger/index finger/middle finger/ring finger/little finger.FP veinissamewithFP,Face: template_no=0,Iris: 0 left eye, 1 right eye,Palm: 0 left hand, 1 right hand,If template_no is not define, default is 0.
template_no_index	Not Null	int2	Sequence Numberoftemplate, like one finger have multi-template, start from 0.

Pers_BioTemplateData Tablestructure:

Field	Value	Type	annotations
id	Not Null	int4	Self growth field
template_data	Not Null	varchar(3000)	Template data

Note: This interface is applicable to BW,TFT devices.

◆ SSR_GetDeviceData()

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

Get The unification of multiple Biometric Template,The Data pull to software.

Parameters

Parameters are shown below:

name	type	param direction	description of param
dwMachineNumber	LONG	[in]	Device ID
Buffer	BSTR	[out]	The buffer used to save data from device, returned data is text format, and multiple record using \r\n separate
BufferSize	LONG	[in]	The buffer space size.
TableName	BSTR	[in]	Name of Table
FiledNames	BSTR	[in]	field name list
Filter	BSTR	[in]	Filter condition
Options	BSTR	[in]	parameter

Returns

returned value specification:

name	type	description of value
True	BOOL	Success
False	BOOL	Fault

See also

Attention: Buffer: The buffer used to save data from device, returned data is text format, and multiple record using \r\n separate.
BufferSize: The buffer space size.
TableName: only allow pers_biotemplate(for unified template), firmware doesn't support user.
FiledNames: multiple field using \t separation. "*" means all of fields, and returned first line is field name.
Filter: Filter condition, if only one field, using symbol "," to separate multi-value, like: <field>=<value> (there is no bland between "=")
Type=1 means FP
Type=2 means Face
Options: Blank value means download all record;When download Access record, value is "NewRecord" means download all new record, value is blank means download all record.

Note: This interface is applicable to BW,TFT devices,For The unification of multiple Biometric Template Tablestructure, see the SSR_SetDeviceData interface Attention

◆ SSR_GetDeviceDataCount()

VARIANT_BOOL SSR_GetDeviceDataCount	(	BSTR	TableName,
		BSTR	Filter,
		BSTR	Options
	)

Query the number of The unification of multiple Biometric Templates within the device.

Parameters

Parameters are shown below:

name	type	param direction	description of param
TableName	BSTR	[in]	Name of Table
Filter	BSTR	[in]	Filter condition
Options	BSTR	[in]	parameter

Returns

returned value specification:

name	type	description of value
True	BOOL	Success
False	BOOL	Fault

See also

Attention

Note: This interface is applicable to BW,TFT devices,For The unification of multiple Biometric Template Tablestructure, see the SSR_SetDeviceData interface Attention

◆ SSR_DeleteDeviceData()

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

Delete The unification of multiple Biometric Templates within the device.

Parameters

Parameters are shown below:

name	type	param direction	description of param
TableName	BSTR	[in]	Name of Table
Datas	BSTR	[in]	Filter condition
Options	BSTR	[in]	parameter

Returns

returned value specification:

name	type	description of value
True	BOOL	Success
False	BOOL	Fault

See also

Attention

Note: This interface is applicable to BW,TFT devices,For The unification of multiple Biometric Template Tablestructure, see the SSR_SetDeviceData interface Attention

Variable Documentation

◆ BiometricType

BiometricType

BiometricType.

Parameters

BiometricType Get the supported biometric type by retrieving the parameter and return 8-bit numeric string. Each represents a type of biometric type. (0 not support ; 1 support;e.g.:BiometricType=01100000 ,device support FP and Face) Character index 0 1 2 3 4 5 6 7 8
Related Type General FP Face Voice Iris Retina Palmprint FingerVein Palmvein

See also

Attention

Note: Applicable to interface of unification of multiple Biometric Template

◆ BiometricVersion

BiometricVersion

BiometricVersion.

Parameters

BiometricVersion Get the version of the supported biometric type Get the version of the supported biometric type of the device by retrieving the parameter and return the version of the supported biometric type seperated by ":" (e.g.:BiometricVersion=0:10.0:7.0:::::device support FP10.0 and Face7.0) Character index 0 1 2 3 4 5 6 7 8
Related Type General FP Face Voice Iris Retina Palmprint FingerVein Palmvein

See also

Attention: TableName��

Note: Applicable to interface of unification of multiple Biometric Template

◆ BiometricMaxCount

BiometricMaxCount

BiometricMaxCount.

Parameters

BiometricMaxCount Get the supported biometric type data capacity by retrieving the parameter and return the supported biometric type data capacity seperated by ":" (e.g.:BiometricMaxCount=0:3000:1000:::::,device support 3000 FP and 1000 Face templates) Character index 0 1 2 3 4 5 6 7 8
Related Type General FP Face Voice Iris Retina Palmprint FingerVein Palmvein The new device is directly returned by the firmware, and the old firmware is SDK compatible.(supported)

See also

Attention: TableName��

Note: Applicable to interface of unification of multiple Biometric Template

◆ BiometricUsedCount

BiometricUsedCount

BiometricUsedCount.

Parameters

BiometricUsedCount Get the number of supported biometric type data by retrieving the padameter and return the number of supported biometric type data seperated by ":" (e.g.:BiometricUsedCount=0:100:10:::::,indicate there are 100 FP templates, 10 faces) Character index 0 1 2 3 4 5 6 7 8
Related Type General FP Face Voice Iris Retina Palmprint FingerVein Palmvein

See also

Attention: TableName��

Note: Applicable to interface of unification of multiple Biometric Template

Detailed Description

Functions

Variables

Function Documentation

◆ SSR_SetDeviceData()

◆ SSR_GetDeviceData()

◆ SSR_GetDeviceDataCount()

◆ SSR_DeleteDeviceData()

Variable Documentation

◆ BiometricType

◆ BiometricVersion

◆ BiometricMaxCount

◆ BiometricUsedCount