Add-ons
- API
- Communication Center
- Disaster Recovery System
- Standard Object Library
  - Standard Object Library, Basics
  - Requirements and Installation
  - How to create a Standard Object Library
  - How to Create Data Point Types for the Standard Object Library
  - How to Create a New Standard Object Library Symbol
  - Examples for Standard Object Library Dollar Parameters
  - How to Create a Standard Object Library Faceplate
  - How to Export Library Project Data
  - How to Add a Standard Libary Symbol to a Panel
  - User Authorization in the StdLib
  - [stdlib]
  - Stdlib
  - HOOK Functions, Basics
    - HOOK Functions, Basics
    - hook Functions
      - hook_<libraryPrefix>_displayInfoAreaIcon()
        This function specifies which icon is displayed in an information area based on its state. The function then displays the icon for a symbol.
      - hook_<libraryPrefix>_enableElementarySymbol()
        This function specifies if an elementary symbol is active or inactive.
      - hook_<libraryPrefix>_faceplateHeadline()
        This function specifies the text for the header of a faceplate.
      - hook_<libraryPrefix>_faceplateWindowTitle()
        This function queries the text of the faceplate window title of the referenced data point.
      - hook_<libraryPrefix>_hasUserAuthorization()
        This function determines whether a certain user has the authorization to change the value of a data point element.
      - hook_<libraryPrefix>_highlightElementarySymbol()
        This function determines whether an elementary symbol is highlighted.
      - hook_<libraryPrefix>_namingFaceplateTabs()
        This function determines the titles for the tabs in a faceplate.
      - hook_<libraryPrefix>_objectTooltip()
        This function determines the tool tip text of a symbol.
      - hook_<libraryPrefix>_openFaceplate()
        This function opens the faceplate of a symbol.
      - hook_<libraryPrefix>_projectFillPopUpMenu()
        This function configures the context menu of a symbol and elementary symbols of a faceplate.
      - hook_<libraryPrefix>_visibleElementarySymbol()
        This function identifies whether an elementary symbol is visible.
    - Stdlib hook-Functions
- BACnet Application
- SmartSCADA
- WinCC OA Excel Report
- Video

hook_<libraryPrefix>_enableElementarySymbol()

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

Synopsis

bool hook_<libraryPrefix>_enableElementarySymbol(string sDpe);

Parameters

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;
}