Standalone SDK API Doc  V1.0.4
Functions | Variables
2.Property.h File Reference

Detailed Description

Author
http://www.zkteco.com
Date
2016-01-01
copyright:
Copyright 2017 ZKTECO CO., LTD. All Rights Reserved.
Note

Functions

VARIANT_BOOL GetStrCardNumber (BSTR *ACardNumber)
 
VARIANT_BOOL SetStrCardNumber (BSTR ACardNumber)
 
VARIANT_BOOL IsNewFirmwareMachine (LONG dwMachineNumber)
 
VARIANT_BOOL GetDeviceFirmwareVersion (LONG dwMachineNumber, BSTR *strVersion)
 

Variables

LONG AccGroup
 
LONG AccTimeZones
 
LONG BASE64
 
LONG CardNumber
 
LONG CommPort
 
LONG ConvertBIG5
 
LONG PINWidth
 

Function Documentation

◆ GetStrCardNumber()

VARIANT_BOOL GetStrCardNumber ( BSTR *  ACardNumber)

To query the value of the SDK attribute cardnumber. You can invoke this function to query the card number of a user after obtaining the information about this user.

Parameters
Parameter description:
name type param direction description of param
ACardNumber BSTR* [out] Card number
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

◆ SetStrCardNumber()

VARIANT_BOOL SetStrCardNumber ( BSTR  ACardNumber)

To set the value of the SDK attribute cardnumber. Before setting user information, you are advised to invoke this function to set the card number of the user.

Parameters
Parameter description:
name type param direction description of param
ACardNumber BSTR [in] Card number
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

◆ IsNewFirmwareMachine()

VARIANT_BOOL IsNewFirmwareMachine ( LONG  dwMachineNumber)

To identify whether the current device firmware are new architecture firmware.

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
Apply to BW, TFT, IFACE devices

◆ GetDeviceFirmwareVersion()

VARIANT_BOOL GetDeviceFirmwareVersion ( LONG  dwMachineNumber,
BSTR *  strVersion 
)

To query the firmware version.

Parameters
Parameter description:
name type param direction description of param
dwMachineNumber LONG [in] Machine ID
strVersion BSTR* [out] Firmware version 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
This interface is applicable to the new architecture firmware.

Variable Documentation

◆ AccGroup

LONG AccGroup

To set or query the group to which a specified user belongs.

See also
Attention
If this attribute is set before uploading the user, set the group to which this user belongs when invoking SetUserInfo. Otherwise, the default group 1 takes effect. This attribute is configurable.
Note
Applicable to BW, TFT, and IFACE devices

◆ AccTimeZones

LONG AccTimeZones

To set the usage period of a user.

See also
Attention
1. If this attribute is set before uploading the user, set the usage period of the user when invoking SetUserInfo.
  1. This attribute is of the LONG* type. It is a LONG-type array with the subscript 3. This attribute is configurable.
Note
Applicable to BW, TFT, and IFACE devices

◆ BASE64

LONG BASE64

To set the code type.

See also
Attention
If this attribute is set to True, the SDK will output a Base64 code when outputting the character string template. Otherwise, it will output a hexadecimal code.
Note
Applicable to BW, TFT, and IFACE devices

◆ CardNumber

LONG CardNumber

To set or read the card number of a user.

See also
Attention
If this attribute cannot be used, invoke GetStrCardnumber and SetStrCardnumber. This attribute is configurable.
Note
Applicable to BW, TFT, and IFACE devices

◆ CommPort

LONG CommPort

To set a serial port number, or a port number used for RS485 connection.

See also
Attention
The attribute is of the LONG type and is configurable.
Note
Applicable to BW, TFT, and IFACE devices

◆ ConvertBIG5

LONG ConvertBIG5

To convert simplified Chinese characters into traditional Chinese characters.

See also
Attention
1. If the value of this attribute is set to True, the SDK will automatically convert simplified Chinese characters into traditional Chinese characters for further development. This function is invalid on a multi-language machine. Therefore, do not set this attribute.
  1. This attribute is invalid on a multi-language machine and later versions. Therefore, do not set this attribute. You do not need to modify this attribute in versions later than ZEM100 5.22 and ZEM200 5.30.
Note
Applicable to BW, TFT, and IFACE devices

◆ PINWidth

LONG PINWidth

To label the maximum length of the user code, which is an Arabic numeral.

See also
Attention
The attribute is of the LONG type and is read-only.
Note
Applicable to BW, TFT, and IFACE devices