Detailed Description

Author: http://www.zkteco.com

Date: 2017-10-01

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

Note

Functions
VARIANT_BOOL	SetSMS (LONG dwMachineNumber, LONG ID, LONG Tag, LONG ValidMinutes, BSTR StartTime, BSTR Content)

VARIANT_BOOL	SetUserSMS (LONG dwMachineNumber, LONG dwEnrollNumber, LONG SMSID)

VARIANT_BOOL	SSR_SetUserSMS (LONG dwMachineNumber, BSTR dwEnrollNumber, LONG SMSID)

VARIANT_BOOL	GetSMS (LONG dwMachineNumber, LONG ID, LONG Tag, LONG ValidMinutes, BSTR StartTime, BSTR Content)

VARIANT_BOOL	DeleteSMS (LONG dwMachineNumber, LONG ID)

VARIANT_BOOL	DeleteUserSMS (LONG dwMachineNumber, LONG dwEnrollNumber, LONG SMSID)

VARIANT_BOOL	SSR_DeleteUserSMS (LONG dwMachineNumber, BSTR dwEnrollNumber, LONG SMSID)

VARIANT_BOOL	ClearUserSMS (LONG dwMachineNumber)

VARIANT_BOOL	ClearSMS (LONG dwMachineNumber)

Function Documentation

◆ SetSMS()

VARIANT_BOOL SetSMS	(	LONG	dwMachineNumber,
		LONG	ID,
		LONG	Tag,
		LONG	ValidMinutes,
		BSTR	StartTime,
		BSTR	Content
	)

To add a short message to the machine. To set the short message for a user, invoke SetUserSMS to assign the short message to the user.

Parameters

Parameter description:

name	type	param direction	description of param
dwMachineNumber	LONG	[in]	Machine ID
ID	LONG	[in]	Short message ID
Tag	LONG	[in]	Short message type
ValidMinutes	LONG	[in]	Validity period of the short message
StartTime	BSTR	[in]	Effective time of the short message
Content	BSTR	[in]	Content of the short message

Returns

Value description:

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

See also

Attention

1. Tag specifies the short message type. The value 253 indicates public short message, 254 personal short message, and 255 reserved short message.

ValidMinutes specifies the validity period of the short message. The value ranges from 0 to 65535. The short message will take effect at the time specified by StartTime and will last for a period of time specified by ValidMinutes.
StartTime specifies the effective time of the short message, in the format of yyyy-mm-dd hh:mm:ss.

Note: Applicable to BW and TFT devices

◆ SetUserSMS()

VARIANT_BOOL SetUserSMS	(	LONG	dwMachineNumber,
		LONG	dwEnrollNumber,
		LONG	SMSID
	)

To set the short message of a user. Specifically, this function is used to assign a short message with a specific ID to a user.

Parameters

Parameter description:

name	type	param direction	description of param
dwMachineNumber	LONG	[in]	Machine ID
dwEnrollNumber	LONG	[in]	User ID
SMSID	LONG	[in]	Short message 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

◆ SSR_SetUserSMS()

VARIANT_BOOL SSR_SetUserSMS	(	LONG	dwMachineNumber,
		BSTR	dwEnrollNumber,
		LONG	SMSID
	)

To set the short message of a user. Specifically, this function is used to assign a short message with a specific ID to a user.

Parameters

Parameter description:

name	type	param direction	description of param
dwMachineNumber	LONG	[in]	Machine ID
dwEnrollNumber	BSTR	[in]	User ID
SMSID	LONG	[in]	Short message 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 TFT

◆ GetSMS()

VARIANT_BOOL GetSMS	(	LONG	dwMachineNumber,
		LONG	ID,
		LONG *	Tag,
		LONG *	ValidMinutes,
		BSTR *	StartTime,
		BSTR *	Content
	)

To obtain details about a short message from the machine based on the short message ID, including the content, effective time, message type, and validity period.

Parameters

Parameter description:

name	type	param direction	description of param
dwMachineNumber	LONG	[in]	Machine ID
ID	LONG	[in]	Short message ID
Tag	LONG*	[out]	Short message type
ValidMinutes	LONG*	[out]	Validity period of the short message
StartTime	BSTR*	[out]	Effective time of the short message
Content	BSTR*	[out]	Content of the short message

Returns

Value description:

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

See also

Attention

1. Tag specifies the short message type. The value 253 indicates public short message, 254 personal short message, and 255 reserved short message.

ValidMinutes specifies the validity period of the short message. The value ranges from 0 to 65535. The short message will take effect at the time specified by StartTime and will last for a period of time specified by ValidMinutes.
StartTime specifies the effective time of the short message, in the format of yyyy-mm-dd hh:mm:ss.

Note: Applicable to BW and TFT devices

◆ DeleteSMS()

VARIANT_BOOL DeleteSMS	(	LONG	dwMachineNumber,
		LONG	ID
	)

To delete a short message with a specified ID from the machine.

Parameters

Parameter description:

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

◆ DeleteUserSMS()

VARIANT_BOOL DeleteUserSMS	(	LONG	dwMachineNumber,
		LONG	dwEnrollNumber,
		LONG	SMSID
	)

To delete the short message with a specified ID for a specified user. Only the mapping relationship between the user and the short message is deleted, and the short message is not deleted.

Parameters

Parameter description:

name	type	param direction	description of param
dwMachineNumber	LONG	[in]	Machine ID
dwEnrollNumber	LONG	[in]	User ID
SMSID	LONG	[in]	Short message 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

◆ SSR_DeleteUserSMS()

VARIANT_BOOL SSR_DeleteUserSMS	(	LONG	dwMachineNumber,
		BSTR	dwEnrollNumber,
		LONG	SMSID
	)

To delete the short message with a specified ID for a specified user. Only the mapping relationship between the user and the short message is deleted, and the short message is not deleted.

Parameters

Parameter description:

name	type	param direction	description of param
dwMachineNumber	LONG	[in]	Machine ID
dwEnrollNumber	BSTR	[in]	User ID
SMSID	LONG	[in]	Short message 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 TFT

◆ ClearUserSMS()

VARIANT_BOOL ClearUserSMS ( LONG dwMachineNumber )

To clear all mapping relationships between short messages and users. The short messages are not deleted.

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

◆ ClearSMS()

VARIANT_BOOL ClearSMS ( LONG dwMachineNumber )

To clear all short messages on the machine. All short messages will be deleted from 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 and TFT devices

Detailed Description

Functions

Function Documentation

◆ SetSMS()

◆ SetUserSMS()

◆ SSR_SetUserSMS()

◆ GetSMS()

◆ DeleteSMS()

◆ DeleteUserSMS()

◆ SSR_DeleteUserSMS()

◆ ClearUserSMS()

◆ ClearSMS()