3.05.Data-WorkCode.h File Reference

Detailed Description

Author

http://www.zkteco.com

Date

2017-10-01

copyright:

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

Note

Functions
VARIANT_BOOL	SetWorkCode (LONG WorkCodeID, LONG AWorkCode)
VARIANT_BOOL	GetWorkCode (LONG WorkCodeID, LONG *AWorkCode)
VARIANT_BOOL	SSR_GetWorkCode (LONG AWorkCode, BSTR *Name)
VARIANT_BOOL	SSR_SetWorkCode (LONG AWorkCode, BSTR Name)
VARIANT_BOOL	SSR_DeleteWorkCode (LONG AWorkCode)
VARIANT_BOOL	SSR_ClearWorkCode ()
VARIANT_BOOL	DeleteWorkCode (LONG WorkCodeID)
VARIANT_BOOL	ClearWorkCode ()
VARIANT_BOOL	SSR_GetWorkCodeIDByName (LONG dwMachineNumber, BSTR WorkCodeName, LONG *WorkCodeId)

Function Documentation

SetWorkCode()

VARIANT_BOOL SetWorkCode	(	LONG	WorkCodeID,
		LONG	AWorkCode
	)

To define a work code with a specified ID.

Parameters

Parameter description: name type param direction description of param WorkCodeID LONG [in] Work code ID AWorkCode LONG [in] Value of work code described by WorkCodeID

Returns

Value description:

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

See also

Attention

A work code value within any range can be input on a monochrome machine. After the work code is defined by using this function, the user can input only the defined work code. For example, if the work code is defined as SetWorkCode(1,345) and SetWorkCode(2,567), the user can input only the work code with the values 345 and 567.

Note

Applicable to BW

GetWorkCode()

VARIANT_BOOL GetWorkCode	(	LONG	WorkCodeID,
		LONG *	AWorkCode
	)

To obtain the name of a specified work code ID. For details, see the description of SetWorkCode.

Parameters

Parameter description: name type param direction description of param WorkCodeID LONG [in] Work code ID AWorkCode LONG* [out] Obtained value of work code described by WorkCodeID

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

VARIANT_BOOL SSR_GetWorkCode	(	LONG	AWorkCode,
		BSTR *	Name
	)

To obtain the name of a specified work code ID.

Parameters

Parameter description: name type param direction description of param AWorkCode LONG [in] Work code ID Name BSTR* [out] Obtained value of work code described by WorkCodeID

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

SSR_SetWorkCode()

VARIANT_BOOL SSR_SetWorkCode	(	LONG	AWorkCode,
		BSTR	Name
	)

To set a work code with a specified ID.

Parameters

Parameter description: name type param direction description of param AWorkCode LONG [in] Work code ID Name BSTR [in] Value of work code described by WorkCodeID

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

SSR_DeleteWorkCode()

VARIANT_BOOL SSR_DeleteWorkCode

(

LONG

AWorkCode

)

To delete a work code with a specified ID.

Parameters

Parameter description: name type param direction description of param AWorkCode LONG [in] Work code 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

SSR_ClearWorkCode()

VARIANT_BOOL SSR_ClearWorkCode

(

)

To delete all user-defined work codes.

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 TFT

DeleteWorkCode()

VARIANT_BOOL DeleteWorkCode

(

LONG

WorkCodeID

)

To delete a work code with a specified work code ID. For details, see the description of SetWorkCode.

Parameters

Parameter description: name type param direction description of param WorkCodeID LONG [in] Work code 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

ClearWorkCode()

VARIANT_BOOL ClearWorkCode

(

)

To clear all defined work codes on the machine. For details, see the description of SetWorkCode.

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

SSR_GetWorkCodeIDByName()

VARIANT_BOOL SSR_GetWorkCodeIDByName	(	LONG	dwMachineNumber,
		BSTR	WorkCodeName,
		LONG *	WorkCodeId
	)

To query the interface of work code id based on the work code name.

Parameters

Parameter description: name type param direction description of param dwMachineNumber LONG [in] Machine ID WorkCodeName BSTR [in] Work code name WorkCodeId LONG* [out] Work code ID

Returns

Value description:

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

See also

Attention

Together with the interface of SSR_SetWorkCode, to judge whether the issued workname is repeatedly (the same WorkCodeName cannot be issued). When return value of WorkCodeID is greater than zero, the issued workname has existed.

Note

This interface is applicable to the new architecture firmware.