4.Access.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	GetUserGroup (LONG dwMachineNumber, LONG dwEnrollNumber, LONG *UserGrp)
VARIANT_BOOL	SetUserGroup (LONG dwMachineNumber, LONG dwEnrollNumber, LONG UserGrp)
VARIANT_BOOL	GetTZInfo (LONG dwMachineNumber, LONG TZIndex, BSTR *TZ)
VARIANT_BOOL	SetTZInfo (LONG dwMachineNumber, LONG TZIndex, BSTR TZ)
VARIANT_BOOL	GetUnlockGroups (LONG dwMachineNumber, BSTR *Grps)
VARIANT_BOOL	SetUnlockGroups (LONG dwMachineNumber, BSTR Grps)
VARIANT_BOOL	SSR_SetUnLockGroup (LONG dwMachineNumber, LONG CombNo, LONG Group1, LONG Group2, LONG Group3, LONG Group4, LONG Group5)
VARIANT_BOOL	SSR_GetUnLockGroup (LONG dwMachineNumber, LONG CombNo, LONG *Group1, LONG *Group2, LONG *Group3, LONG *Group4, LONG *Group5)
VARIANT_BOOL	GetGroupTZs (LONG dwMachineNumber, LONG GroupIndex, LONG *TZs)
VARIANT_BOOL	SetGroupTZs (LONG dwMachineNumber, LONG GroupIndex, LONG *TZs)
VARIANT_BOOL	SSR_SetGroupTZ (LONG dwMachineNumber, LONG GroupNo, LONG Tz1, LONG Tz2, LONG Tz3, LONG ValidHoliday, LONG VerifyStyle)
VARIANT_BOOL	SSR_GetGroupTZ (LONG dwMachineNumber, LONG GroupNo, LONG *Tz1, LONG *Tz2, LONG *Tz3, LONG *ValidHoliday, LONG *VerifyStyle)
VARIANT_BOOL	GetGroupTZStr (LONG dwMachineNumber, LONG GroupIndex, BSTR *TZs)
VARIANT_BOOL	SetGroupTZStr (LONG dwMachineNumber, LONG GroupIndex, BSTR TZs)
VARIANT_BOOL	GetUserTZs (LONG dwMachineNumber, LONG UserID, LONG *TZs)
VARIANT_BOOL	SetUserTZs (LONG dwMachineNumber, LONG UserID, LONG *TZs)
VARIANT_BOOL	GetUserTZStr (LONG dwMachineNumber, LONG UserID, BSTR *TZs)
VARIANT_BOOL	SetUserTZStr (LONG dwMachineNumber, LONG UserID, BSTR TZs)
VARIANT_BOOL	ACUnlock (LONG dwMachineNumber, LONG Delay)
VARIANT_BOOL	GetACFun (LONG *ACFun)
VARIANT_BOOL	GetDoorState (LONG MachineNumber, LONG *State)
VARIANT_BOOL	UseGroupTimeZone ()
VARIANT_BOOL	SetHoliday (LONG dwMachineNumber, BSTR Holiday)
VARIANT_BOOL	GetHoliday (LONG dwMachineNumber, BSTR *Holiday)
VARIANT_BOOL	SSR_GetHoliday (LONG dwMachineNumber, LONG HolidayID, LONG *BeginMonth, LONG *BeginDay, LONG *EndMonth, LONG *EndDay, LONG *TimeZoneID)
VARIANT_BOOL	SSR_SetHoliday (LONG dwMachineNumber, LONG HolidayID, LONG BeginMonth, LONG BeginDay, LONG EndMonth, LONG EndDay, LONG TimeZoneID)
VARIANT_BOOL	SetDaylight (LONG dwMachineNumber, LONG Support, BSTR BeginTime, BSTR EndTime)
VARIANT_BOOL	GetDaylight (LONG dwMachineNumber, LONG *Support, BSTR *BeginTime, BSTR *EndTime)

Function Documentation

GetUserGroup()

VARIANT_BOOL GetUserGroup	(	LONG	dwMachineNumber,
		LONG	dwEnrollNumber,
		LONG *	UserGrp
	)

To obtain the ID of the group to which a specified user belongs.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID dwEnrollNumber LONG [in] User ID UserGrp LONG* [out] Returned group ID

Returns

Value description:

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

See also

Attention

The value of UserGrp is the ID of the group to which the user specified by dwEnrollNumber belongs. The value range is 1-5.

Note

Applicable to BW, TFT, and IFACE devices

SetUserGroup()

VARIANT_BOOL SetUserGroup	(	LONG	dwMachineNumber,
		LONG	dwEnrollNumber,
		LONG	UserGrp
	)

To set the group to which a specified user belongs.

Parameters

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

Returns

Value description:

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

See also

Attention

The value of UserGrp is the ID of the group to which the user specified by dwEnrollNumber belongs. The value range is 1-5.

Note

Applicable to BW, TFT, and IFACE devices

GetTZInfo()

VARIANT_BOOL GetTZInfo	(	LONG	dwMachineNumber,
		LONG	TZIndex,
		BSTR *	TZ
	)

To obtain the information about a time segment with a specified index.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID TZIndex LONG [in] Time segment index TZ BSTR* [out] The value is the information about the time segment with the index specified by TZIndex.

Returns

Value description:

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

See also

Attention

The value of the TZ parameter is the information about the time segment with the index specified by TZIndex. Every eight digits indicate a time segment in the format of hhmmhhmm. For example, 10111223000023590000235900002359000023590000235900002359 indicates the time segment from 10:11 to 12:23 on Sunday and the whole day from Monday to Saturday.

Note

Applicable to BW, TFT, and IFACE devices

SetTZInfo()

VARIANT_BOOL SetTZInfo	(	LONG	dwMachineNumber,
		LONG	TZIndex,
		BSTR	TZ
	)

To set the information about a time segment with a specified index.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID TZIndex LONG [in] Time segment index TZ BSTR [in] Time segment information 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 TZ parameter specifies the time segment information to be set. Every eight digits indicate a time segment in the format of hhmmhhmm. For example, 10111223000023590000235900002359000023590000235900002359 indicates the time segment from 10:11 to 12:23 on Sunday and the whole day from Monday to Saturday.

Note

Applicable to BW, TFT, and IFACE devices

GetUnlockGroups()

VARIANT_BOOL GetUnlockGroups	(	LONG	dwMachineNumber,
		BSTR *	Grps
	)

To obtain unlock combinations of the machine.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID Grps BSTR* [out] Current unlock combination of the machine

Returns

Value description:

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

See also

Attention

The value of the Grps parameter is an unlock combination. There are totally 10 unlock combinations, separated with a colon (:). For example, 12:23:14:15 represents four valid combinations, which are combination 1 (12 represents groups 1 and 2), combination 2 (23 represents groups 2 and 3), combination 3 (14 represents groups 1 and 4), and combination 4 (15 represents groups 1 and 5).

Note

Applicable to BW

SetUnlockGroups()

VARIANT_BOOL SetUnlockGroups	(	LONG	dwMachineNumber,
		BSTR	Grps
	)

To set unlock combinations.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID Grps BSTR [in] Unlock combination

Returns

Value description:

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

See also

Attention

Totally 10 unlock combinations need to be set, and separate these combinations with a colon (:). For example, 12:23:14:15 represents four valid combinations, which are combination 1 (12 represents groups 1 and 2), combination 2 (23 represents groups 2 and 3), combination 3 (14 represents groups 1 and 4), and combination 4 (15 represents groups 1 and 5).

Note

Applicable to BW

SSR_SetUnLockGroup()

VARIANT_BOOL SSR_SetUnLockGroup	(	LONG	dwMachineNumber,
		LONG	CombNo,
		LONG	Group1,
		LONG	Group2,
		LONG	Group3,
		LONG	Group4,
		LONG	Group5
	)

To set unlock combinations.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID CombNo LONG [in] Unlock combination ID ranging from 1 to 10. The machine supports at most 10 unlock combinations. Group1 LONG [in] Unlock combination group 1 Group2 LONG [in] Unlock combination group 2 Group3 LONG [in] Unlock combination group 3 Group4 LONG [in] Unlock combination group 4 Group5 LONG [in] Unlock combination group 5

Returns

Value description:

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

See also

Attention

Group1, Group2, Group3, Group4 and Group5 are group IDs of an unlock combination. Each unlock combination contains five group IDs. The group ID ranges from 1 to 99. For example, SSR_SetUnLockGroup(1,1,2,23,14,0,56) indicates that the personnel of groups 2, 23, 14 and 56 need to verify together to open the door.

Note

Applicable to TFT and IFACE devices

SSR_GetUnLockGroup()

VARIANT_BOOL SSR_GetUnLockGroup	(	LONG	dwMachineNumber,
		LONG	CombNo,
		LONG *	Group1,
		LONG *	Group2,
		LONG *	Group3,
		LONG *	Group4,
		LONG *	Group5
	)

To obtain unlock combination information based on the group ID.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID CombNo LONG [in] Unlock combination ID ranging from 1 to 10 Group1 LONG* [out] Unlock combination group 1 Group2 LONG* [out] Unlock combination group 2 Group3 LONG* [out] Unlock combination group 3 Group4 LONG* [out] Unlock combination group 4 Group5 LONG* [out] Unlock combination group 5

Returns

Value description:

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

See also

Attention

The values of Group1, Group2, Group3, Group4, and Group5 are group IDs of the specified unlock combination. The group IDs are returned. Each unlock combination contains a maximum of five groups. The group ID ranges from 1 to 99.

Note

Applicable to TFT and IFACE devices

GetGroupTZs()

VARIANT_BOOL GetGroupTZs	(	LONG	dwMachineNumber,
		LONG	GroupIndex,
		LONG *	TZs
	)

To obtain the time segments of a specified group. This function differs from GetGroupTZStr in the format of the returned values.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID GroupIndex LONG [in] Group index, ranging from 1 to 5 TZs LONG* [out] Time segment index

Returns

Value description:

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

See also

Attention

The TZs parameter is a LONG pointer. Its value is the indexes of the three time segments used by the group specified by GroupIndex, indicated by TZs[0], TZs[1] and TZs[2] respectively.

Note

Applicable to BW

SetGroupTZs()

VARIANT_BOOL SetGroupTZs	(	LONG	dwMachineNumber,
		LONG	GroupIndex,
		LONG *	TZs
	)

To set the three time segments of a specified group. This function differs from SetGroupTZStr in the format of the specified values.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID GroupIndex LONG [in] Group index, ranging from 1 to 5 TZs LONG* [in] Time segment index

Returns

Value description:

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

See also

Attention

The TZs parameter is a LONG pointer. The three time segments are specified by TZs[0], TZs[1], and TZs[2] respectively.

Note

Applicable to BW

SSR_SetGroupTZ()

VARIANT_BOOL SSR_SetGroupTZ	(	LONG	dwMachineNumber,
		LONG	GroupNo,
		LONG	Tz1,
		LONG	Tz2,
		LONG	Tz3,
		LONG	ValidHoliday,
		LONG	VerifyStyle
	)

To set the time segments of a group.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID GroupNo LONG [in] Group ID, ranging from 1 to 99 Tz1 LONG [in] Time segment 1 Tz2 LONG [in] Time segment 2 Tz3 LONG [in] Time segment 3 ValidHoliday LONG [in] Whether the time segments are valid on holidays VerifyStyle LONG [in] Group verification mode

Returns

Value description:

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

See also

Attention

The VerifyStyle parameter specifies the group verification mode. 0(FP/PW/RF), 1(FP), 2(PIN), 3(PW), 4(RF), 5(FP&RF), 6(FP/PW), 7(FP/RF), 8(PW/RF), 9(PIN&FP), 10(FP&PW), 11(PW&RF), 12(FP&PW&RF), 13(PIN&FP&PW), 14(FP&RF/PIN).

Note

Applicable to TFT and IFACE devices

SSR_GetGroupTZ()

VARIANT_BOOL SSR_GetGroupTZ	(	LONG	dwMachineNumber,
		LONG	GroupNo,
		LONG *	Tz1,
		LONG *	Tz2,
		LONG *	Tz3,
		LONG *	ValidHoliday,
		LONG *	VerifyStyle
	)

To obtain the time segments of a group.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Fingerprint machine ID GroupNo LONG [in] Group ID, ranging from 1 to 99 Tz1 LONG* [out] The indexes of the three time segments of the specified group are returned. The index ranges from 1 to 50. Tz2 LONG* [out] The indexes of the three time segments of the specified group are returned. The index ranges from 1 to 50. Tz3 LONG* [out] The indexes of the three time segments of the specified group are returned. The index ranges from 1 to 50. ValidHoliday LONG* [out] Whether the time segments are valid on holidays. The value 1 indicates that the time segments are valid on holidays and 0 indicates that the time segments are invalid on holidays. VerifyStyle LONG* [out] Verification mode of the fingerprint machine

Returns

Value description:

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

See also

Attention

The VerifyStyle parameter specifies the group verification mode. 0(FP/PW/RF), 1(FP), 2(PIN), 3(PW), 4(RF), 5(FP&RF), 6(FP/PW), 7(FP/RF), 8(PW/RF), 9(PIN&FP), 10(FP&PW), 11(PW&RF), 12(FP&PW&RF), 13(PIN&FP&PW), 14(FP&RF/PIN).

Note

Applicable to TFT and IFACE devices

GetGroupTZStr()

VARIANT_BOOL GetGroupTZStr	(	LONG	dwMachineNumber,
		LONG	GroupIndex,
		BSTR *	TZs
	)

To obtain the time segments of a specified group. This function differs from GetGroupTZs in the format of the returned values.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID GroupIndex LONG [in] Group index, ranging from 1 to 5 TZs BSTR* [out] Time segment 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 TZs is the indexes of the time segments of the group specified by GroupIndex. Each group contains three time segments separated with a colon (:). For example, if the returned value is 1:23:13, the indexes of the three time segments are 1, 23 and 13 respectively.

Note

Applicable to BW

SetGroupTZStr()

VARIANT_BOOL SetGroupTZStr	(	LONG	dwMachineNumber,
		LONG	GroupIndex,
		BSTR	TZs
	)

To set the time segments of a specified group. This function differs from SetGroupTZs in the format of the specified values.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID GroupIndex LONG [in] Group index, ranging from 1 to 5 TZs BSTR [in] Time segment index

Returns

Value description:

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

See also

Attention

The TZs parameter specifies the indexes of the time segments of the group described by GroupIndex. Each group contains three time segments separated with a colon (:). For example, if the value is set to 1:23:13, the indexes of the three time segments are 1, 23 and 13 respectively.

Note

Applicable to BW

GetUserTZs()

VARIANT_BOOL GetUserTZs	(	LONG	dwMachineNumber,
		LONG	UserID,
		LONG *	TZs
	)

To obtain the time segments of a user. Each user has three time segments. This function differs from GetUserTZStr in the format of the returned time segments.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID UserID LONG [in] User ID TZs LONG* [out] Time segments during which the user can open the door

Returns

Value description:

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

See also

Attention

The TZs pointer has three values that store three time segment indexes, which can be read from TZs[0], TZs[1] and TZs[2] respectively.

Note

Applicable to BW, TFT, and IFACE devices

SetUserTZs()

VARIANT_BOOL SetUserTZs	(	LONG	dwMachineNumber,
		LONG	UserID,
		LONG *	TZs
	)

To set the time segments of a user. At most three time segments can be set for a user. This function differs from SetUserTZStr in the format of specified time segments.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID UserID LONG [in] User ID TZs LONG* [in] Time segment index

Returns

Value description:

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

See also

Attention

The TZs parameter specifies the indexes of the time segments of the user described by UserID. The three indexes can be specified by TZs[0], TZs[1] and TZs[2] respectively. When TZs[0] is 0, the group setting takes effect. When it is 1, a user-defined setting takes effect.

Note

Applicable to BW, TFT, and IFACE devices

GetUserTZStr()

VARIANT_BOOL GetUserTZStr	(	LONG	dwMachineNumber,
		LONG	UserID,
		BSTR *	TZs
	)

To obtain the time segments of a user. This function differs from GetUserTZs in the format of returned time segments.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID UserID LONG [in] User ID TZs BSTR* [out] Unlock time segments of the user

Returns

Value description:

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

See also

Attention

The TZs parameter specifies the unlock time segments of the user. The details are as follows:
Monochrome access control panel: X1:X2:X3. X1, X2 and X3 are indexes of user-defined time segments. If X1 is 0, the group time segments are used. To query whether a user uses the group time segments, invoke the UseGroupTimeZone function and check the returned value. If user A uses user-defined time segments 1 and 2, the fingerprint machine will return 1:2:0. If user B uses the group time segments, the fingerprint machine will return 0:0:0.
Color-screen access control panel: X1:X2:X3:X4. X4 specifies whether to use the group time segments. The value 0 indicates using the group time segments and 1 indicates using user-defined time segments. X1, X2 and X3 are indexes of used time segments. For example, if user A uses user-defined time segments 1 and 2, the fingerprint machine will return 1:2:0:1. If user B uses the group time segments defined as 1:1:1:0, the fingerprint machine will return 0:0:0:0.

Note

Applicable to BW, TFT, and IFACE devices

SetUserTZStr()

VARIANT_BOOL SetUserTZStr	(	LONG	dwMachineNumber,
		LONG	UserID,
		BSTR	TZs
	)

To set the time segments of a user. The time segments are separated with a colon (:). This function differs from SetUserTZs in the format of specified time segments.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID UserID LONG [in] User ID TZs BSTR [in] Unlock time segments of the user

Returns

Value description:

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

See also

Attention

The TZs parameter specifies the unlock time segments of the user. The details are as follows:
Monochrome access control panel: X1:X2:X3. X1, X2 and X3 are indexes of user-defined time segments. If X1 is 0, the group time segments are used. To query whether a user uses the group time segments, invoke the UseGroupTimeZone function and check the returned value. If user A uses user-defined time segments 1 and 2, the fingerprint machine will return 1:2:0. If user B uses the group time segments, the fingerprint machine will return 0:0:0.
Color-screen access control panel: X1:X2:X3:X4. X4 specifies whether to use the group time segments. The value 0 indicates using the group time segments and 1 indicates using user-defined time segments. X1, X2 and X3 are indexes of used time segments. For example, if user A uses user-defined time segments 1 and 2, the fingerprint machine will return 1:2:0:1. If user B uses the group time segments defined as 1:1:1:0, the fingerprint machine will return 0:0:0:0.

Note

Applicable to BW, TFT, and IFACE devices

ACUnlock()

VARIANT_BOOL ACUnlock	(	LONG	dwMachineNumber,
		LONG	Delay
	)

To enable the access control panel to output door opening level and close the door after Delay/10 seconds.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID Delay LONG [in] Delay in closing the door

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

GetACFun()

VARIANT_BOOL GetACFun

(

LONG *

ACFun

)

To check whether the machine has the access control function.

Parameters

Parameter description: name type param direction description of param ACFun LONG* [out] Flag of the access control function

Returns

Value description:

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

See also

Attention

The ACFun parameter is an access control flag. The value 0 indicates that access control is unavailable, 1 indicates simple access control, 2 indicates medium-level access control, 6 indicates advanced access control, and 14 indicates advanced access control+normal open.

Note

Applicable to BW, TFT, and IFACE devices

GetDoorState()

VARIANT_BOOL GetDoorState	(	LONG	MachineNumber,
		LONG *	State
	)

To query the current door status. The value 1 indicates that the door is opened and 0 indicates that the door is closed.

Parameters

Parameter description: name type param direction description of param MachineNumber LONG [in] Machine ID State LONG* [out] Door status

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

UseGroupTimeZone()

VARIANT_BOOL UseGroupTimeZone

(

)

To query whether a user uses the group time segments.

Parameters

None

Returns

Value description:

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

See also

Attention

This function must be used together with GetUserTZs or GetUserTZStr. Specifically, invoke the GetUserTZs or GetUserTZStr function to obtain the time segment information about a user, and then invoke UseGroupTimeZone to check whether the user uses the group time segments.

Note

Applicable to BW, TFT, and IFACE devices

SetHoliday()

VARIANT_BOOL SetHoliday	(	LONG	dwMachineNumber,
		BSTR	Holiday
	)

To set holidays.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID Holiday BSTR [in] Holiday 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 Holiday parameter specifies holidays in the format of mmddmmdd. For example, 04140511 indicates a holiday that lasts from April 14 to May 11.

Note

Applicable to BW

GetHoliday()

VARIANT_BOOL GetHoliday	(	LONG	dwMachineNumber,
		BSTR *	Holiday
	)

To query the holiday that is set on the machine.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID Holiday BSTR* [out] Holiday specified on the machine

Returns

Value description:

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

See also

Attention

The Holiday parameter specifies holidays in the format of mmddmmdd. For example, 04140511 indicates a holiday that lasts from April 14 to May 11.

Note

Applicable to BW

SSR_GetHoliday()

VARIANT_BOOL SSR_GetHoliday	(	LONG	dwMachineNumber,
		LONG	HolidayID,
		LONG *	BeginMonth,
		LONG *	BeginDay,
		LONG *	EndMonth,
		LONG *	EndDay,
		LONG *	TimeZoneID
	)

To query holiday settings on the machine based on the holiday ID.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID HolidayID LONG [in] Holiday ID BeginMonth LONG* [out] Start date of the holiday BeginDay LONG* [out] Start date of the holiday EndMonth LONG* [out] End date of the holiday EndDay LONG* [out] End date of the holiday TimeZoneID LONG* [out] Index of the time segment of the holiday

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_SetHoliday()

VARIANT_BOOL SSR_SetHoliday	(	LONG	dwMachineNumber,
		LONG	HolidayID,
		LONG	BeginMonth,
		LONG	BeginDay,
		LONG	EndMonth,
		LONG	EndDay,
		LONG	TimeZoneID
	)

To set holidays.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID HolidayID LONG [in] Holiday ID BeginMonth LONG [in] Start date of the holiday BeginDay LONG [in] Start date of the holiday EndMonth LONG [in] End date of the holiday EndDay LONG [in] Start date of the holiday TimeZoneID LONG [in] Index of the time segment of the holiday

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

SetDaylight()

VARIANT_BOOL SetDaylight	(	LONG	dwMachineNumber,
		LONG	Support,
		BSTR	BeginTime,
		BSTR	EndTime
	)

To set whether to enable DST, and the DST start time and end time.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID Support LONG [in] Whether to enable DST BeginTime BSTR [in] DST start time EndTime BSTR [in] DST end time

Returns

Value description:

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

See also

Attention

1. The Support parameter specifies whether to enable DST. The value 1 indicates enabling DST and 0 indicates disabling DST.

1. The values of BeginTime and EndTime are in the format of mm-dd hh:mm.
   

Note

Applicable to BW, TFT, and IFACE devices

GetDaylight()

VARIANT_BOOL GetDaylight	(	LONG	dwMachineNumber,
		LONG *	Support,
		BSTR *	BeginTime,
		BSTR *	EndTime
	)

To query the DST settings on the machine.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID Support LONG* [out] Whether to enable DST BeginTime BSTR* [out] DST start time EndTime BSTR* [out] DST end time

Returns

Value description:

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

See also

Attention

1. The Support parameter specifies whether to enable DST. The value 1 indicates enabling DST and 0 indicates disabling DST.

1. The values of BeginTime and EndTime are in the format of mm-dd hh:mm.
   

Note

Applicable to BW, TFT, and IFACE devices