Standalone SDK API Doc  V1.0.4
Functions
3.12.Data-App.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 GetAllAppFun (LONG dwMachineNumber, BSTR *AppName, BSTR *FunofAppName)
 
VARIANT_BOOL GetAllRole (LONG dwMachineNumber, BSTR *RoleName)
 
VARIANT_BOOL GetAppOfRole (LONG dwMachineNumber, LONG Permission, BSTR *AppName)
 
VARIANT_BOOL GetFunOfRole (LONG dwMachineNumber, LONG Permission, BSTR *FunName)
 
VARIANT_BOOL SetPermOfAppFun (LONG dwMachineNumber, LONG Permission, BSTR AppName, BSTR FunName)
 
VARIANT_BOOL DeletePermOfAppFun (LONG dwMachineNumber, LONG Permission, BSTR AppName, BSTR FunName)
 
VARIANT_BOOL IsUserDefRoleEnable (LONG dwMachineNumber, LONG Permission, VARIANT_BOOL *Enable)
 

Function Documentation

◆ GetAllAppFun()

VARIANT_BOOL GetAllAppFun ( LONG  dwMachineNumber,
BSTR *  AppName,
BSTR *  FunofAppName 
)

To query all App names, all App and corresponding Fun names.

Parameters
Parameter description:
name type param direction description of param
dwMachineNumber LONG [in] Machine ID
AppName BSTR [out] App name list.The data is in .txt format and format name is [App name]. Records are separated with \r\n;
FunofAppName BSTR [out] App and App functions lsit.The data is in .txt format and format name is [Fun name, Function name]. Records are separated with \r\n;
Returns
Value description:
name type description of value
True BOOL Function execution success
False BOOL Function execution failure
See also
Attention
Note
It is applicable to the new architecture machine

◆ GetAllRole()

VARIANT_BOOL GetAllRole ( LONG  dwMachineNumber,
BSTR *  RoleName 
)

To query all role names and the corresponding permission names.

Parameters
Parameter description:
name type param direction description of param
dwMachineNumber LONG [in] Machine ID
RoleName BSTR [out] To query all role names and the corresponding permission names. The data is in .txt format and format name is [Role name, Permission name]. Records are separated with \r\n;£»
Returns
Value description:
name type description of value
True BOOL Function execution success
False BOOL Function execution failure
See also
Attention
Note
It is applicable to the new architecture machine

◆ GetAppOfRole()

VARIANT_BOOL GetAppOfRole ( LONG  dwMachineNumber,
LONG  Permission,
BSTR *  AppName 
)

To query all App names with specified role permission.

Parameters
Parameter description:
name type param direction description of param
dwMachineNumber LONG [in] Machine ID
Permission LONG [in] Permisssion of specified role
AppName BSTR [out] AppName with the specified role permission will be returned. The data is in .txt format and format name is [App name]. Records are separated with \r\n;
Returns
Value description:
name type description of value
True BOOL Function execution success
False BOOL Function execution failure
See also
Attention
Note
It is applicable to the new architecture machine

◆ GetFunOfRole()

VARIANT_BOOL GetFunOfRole ( LONG  dwMachineNumber,
LONG  Permission,
BSTR *  FunName 
)

To query all function names with the specified role permission.

Parameters
Parameter description:
name type param direction description of param
dwMachineNumber LONG [in] Machine ID
Permission LONG [in] Permisssion of specified role
FunName BSTR [out] FunName with the specified role permission will be returned. The data is in .txt format and format name is [Function name]. Records are separated with \r\n;
Returns
Value description:
name type description of value
True BOOL Function execution success
False BOOL Function execution failure
See also
Attention
Note
It is applicable to the new architecture machine

◆ SetPermOfAppFun()

VARIANT_BOOL SetPermOfAppFun ( LONG  dwMachineNumber,
LONG  Permission,
BSTR  AppName,
BSTR  FunName 
)

To set the corresponding permission of function and App meanwhile.

Parameters
Parameter description:
name type param direction description of param
dwMachineNumber LONG [in] Machine ID
Permission LONG [in] Permission value to be set
AppName BSTR [in] App name
FunName BSTR [in] Fun name
Returns
Value description:
name type description of value
True BOOL Function execution success
False BOOL Function execution failure
See also
Attention
Function of FunName must be included in the functions of AppName
Note
It is applicable to the new architecture machine

◆ DeletePermOfAppFun()

VARIANT_BOOL DeletePermOfAppFun ( LONG  dwMachineNumber,
LONG  Permission,
BSTR  AppName,
BSTR  FunName 
)

To delete the corresponding permission of function and App meanwhile.

Parameters
Parameter description:
name type param direction description of param
dwMachineNumber LONG [in] Machine ID
Permission LONG [in] Permission value to be deleted
AppName BSTR [in] App name
FunName BSTR [in] Fun name
Returns
Value description:
name type description of value
True BOOL Function execution success
False BOOL Function execution failure
See also
Attention
Function of FunName must be included in the functions of AppName
Note
It is applicable to the new architecture machine

◆ IsUserDefRoleEnable()

VARIANT_BOOL IsUserDefRoleEnable ( LONG  dwMachineNumber,
LONG  Permission,
VARIANT_BOOL *  Enable 
)

To judge whether the user defined role is enabled.

Parameters
Parameter description:
name type param direction description of param
dwMachineNumber LONG [in] Machine ID
Permission LONG [in] Permission value to be deleted
Enable BOOL* [out] Whether the user defined role is enabled: 1 means enable and 0 means disable
Returns
Value description:
name type description of value
True BOOL Function execution success
False BOOL Function execution failure
See also
Attention
Note
It is applicable to the new architecture machine