hook_<libraryPrefix>_enableElementarySymbol()

This function specifies if an elementary symbol is active or inactive.

Synopsis

bool hook_<libraryPrefix>_enableElementarySymbol(string sDpe);

Parameters


Parameter	Description
sDpe	Name of the data point to which the elementary symbol references.

Return Value

TRUE = Elementary symbol is active.

FALSE = Elementary symbol inactive.

Description

This function specifies whether an elementary symbol is set to active or inactive.

Note that if a rule was already created for this elementary symbol, the rule is combined with this function via the AND operation.

By default, this function checks whether the necessary user authorization is available so that an elementary symbol can be displayed as active in the faceplate.

You can find the function in the stdlib_hook_project.ctl under wincc_oa_path/Stdlib_3.18/scripts/libs/

bool hook_enableElementarySymbol (string sDpe, string sUser="")
{
  //use default permission check
  if(sUser=="")
  sUser = getUserName();
  return hasUserAuthorization(sDpe, sUser);
  //if you don't want to use permission check
  //return true;
}