Home
Add-ons
Standard Object Library
HOOK Functions, Basics
Stdlib hook-Functions
hook_<libraryPrefix>_getAlertElement()
By using this function, the library creator can define were the sum alert of a DPT/DP is located.

Add-ons
- API
- Communication Center, basics
- 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
    - Stdlib hook-Functions
      - hook_<libraryPrefix>_addEnableRuleDpes()
        Determines the data point elements that are additionally called for rule evaluation for the setting of an elementary symbol to inactive/active.
      - hook_<libraryPrefix>_addHighlightRuleDpes()
        Determines the data point elements that are additionally used for rule evaluation in order to set an elementary symbol to highlighted/not highlighted.
      - hook_<libraryPrefix>_addVisibleRuleDpe()
        Determines the data point elements which are additionally used for the rule evaluation in order to set an elementary symbol to visible/invisible.
      - hook_<libraryPrefix>_alterInfoAreaDisplay()
        This function allows the icon-ID, and therefore the icon displayed in an information area, to determine when the value of the data point element that is connected to an information area changes. Which data point elements are connected to a certain information area is determined via the function hook_<LibName>_getInfoAreaDPEs().
      - hook_<libraryPrefix>_fillPopUpMenu()
        This function is used to change the context menu of a symbol or an elementary symbol.
      - hook_<libraryPrefix>_getAlertElement()
        By using this function, the library creator can define were the sum alert of a DPT/DP is located.
      - hook_<libraryPrefix>_getInfoAreaDPEs()
        This function determines the data point elements that can change the icon for an information area of a symbol. For detailed information, see also hook_<libraryPrefix>_displayInfoAreaIcon() and hook_<libraryPrefix>_alterInfoAreaDisplay().
      - hook_<libraryPrefix>_getInvalidElement()
        This function determines the data point element that indicates whether a data point is invalid.
      - hook_<libraryPrefix>_getOperationModeElement()
        This function determines the data point node that saves the operating states.
      - hook_<libraryPrefix>_hasDpeAnActiveAdress()
        This function is used to check whether an elementary symbol in a faceplate has a peripheral address.
      - hook_<libraryPrefix>_libEnableElementarySymbol()
        This function returns TRUE when a certain data point element is activated.
      - hook_<libraryPrefix>_libHighlightElementarySymbol()
        This function returns TRUE when a certain data point element is highlighted.
      - hook_<libraryPrefix>_libVisibleElementarySymbol()
        This function returns TRUE if a certain data point element is visible.
- BACnet Application
- SmartSCADA
- WinCC OA Excel Report
- Video

hook_<libraryPrefix>_getAlertElement()

By using this function, the library creator can define were the sum alert of a DPT/DP is located.

Synopsis

string hook_ <libraryPrefix>_ getAlertElement( string dp);

Parameters


Parameter	Description
dp	Data point for which the symbol is shown.

Default

string hook_stdlib_getAlertElement(string dp)
{
  if (dpTypeName(dp)=="STDLIB_regler")
  return "ALM";
  else
  return "alarm";
}

Instead of "STDLIB_REGLER", enter the name of the data point type. The data point element that takes into account the sum alert handling in the "ALM" or "alarm" node is returned.

Return Value

Data point element name.