Home
Business Logic / Control
Endless possibilities in data processing for your projects.
CONTROL Functions
Functions E
enumKeys()
The function returns the list of keys that are available within the enumeration.

Version Information
Release Notes, Update information, Certifications and Frequently Asked Questions.
Concepts
Your first step into modern and powerful process visualization.
Deployment
Topics, you need to know, before using WinCC OA.
Security
Go beyond the norm in cybersecurity.
Engineering
Powerful tools for easy or complex engineering tasks.
Data Management
Classify, structure and archive your data.
Business Logic / Control
Endless possibilities in data processing for your projects.
- Introduction to CTRL
  An introduction to the product's own programming language Control(CTRL).
- Control Classes
  The overview of classes available in Control.
- Types of Control Functions
  An overview of the types of functions distinguished within Control.
- Control graphics
- CONTROL Functions
  - Funtions A
  - Funtions B
  - Funtions C
  - Funtions D
  - Functions E
    - exit()
      Terminates a manager and passes the exit code to the operating system.
    - errorDialog()
      Displays an error dialog.
    - ecdhGetPublicKey()
      The function stores the public key of the key pair for the ECDH key exchange.
    - errorText()
      Returns the text for the error code. This function should not be used anymore but remains included for reasons of compatibility. Instead of this function, use the functions getCatStr() or getErrorText(). These functions allow the definition of own error messages dependent on specific error codes. The error codes are saved in the file _errors.cat in the directory <wincc_oa_path>/msg/<lang>, respectively in the same file in the project directory.
    - ecdhDeriveSharedSecret()
      Generates a shared secret based on the key pair for an ECDH key exchange.
    - enumValues()
      The function returns the values of an enumeration as mapping.
    - execJsFunction()
      The function allows to call a JavaScript function from within the WebView EWO JavaScript code directly from CTRL.
    - eventPort()
      Returns the port number of the Event manager.
    - enableSound()
      Switches the sound of a wave file during runtime (see Configuration file).
    - execScriptRestricted()
      This function, like execScript(), allows for execution of a script during runtime. Use this function to run void main-functions which have no return value. Contrasting to execScript() the functions that can be used inside the executed script are limited to provide better security against insertion of malicious code.
    - ecdhReleaseKeyPair()
      The function releases a private/public key pair for an ECDH key exchange.
    - emSendMail() - obsolete
      This function allows sending mails.
    - execJsFunctionDyn()
      The function allows to call a JavaScript function from within the WebView EWO JavaScript code directly from CTRL.
    - evalScript()
      Allows to execute a script during runtime and to write the return value of the script in retVal.
    - enableMenuItem() - obsolete
      Supports disabling of menus (obsolete from version 3.5 up).
    - execScript()
      Allows to execute a script during runtime. Use this function for void main-functions (without return value).
    - emRetrieveMail()
      The function connects to a POP3 server and checks wether there are mails. If there are, the function retrieves the mails and deletes the mail at the server.
    - enumKeys()
      The function returns the list of keys that are available within the enumeration.
    - exp()
      Exponential function
    - eventHost()
      Returns the host name the event manager is running on.
    - evalScriptRestricted()
      Allows to execute a script during runtime and to write the return value of the script in target. Compared to the unrestricted function evalScript() only a more limited set of functions is allowed to provide better security.
    - ecdhGenerateKeyPair()
      The function generates a random private/public key pair for an ECDH key exchange.
  - Functions F
  - Functions G
  - Functions H
  - Functions I
  - Functions J
  - Functions K
  - Functions L
  - Functions M
  - Functions N
  - Functions O
  - Functions P
  - Functions Q
  - Functions R
  - Functions S
  - Functions T
  - Functions U
  - Functions V
  - Functions W
  - Functions X
  - Functions Y
  - Functions Z
- CtrlExtension
  The CtrlExtension allows the addition of custom C++ code.
- CTRL Debugger
  You can use the CTRL debugger to debug the Control programming language. The debugger can be used via its own panel, which also enables the monitoring and setting of variable values during the execution of a script.
- SQL in CONTROL
  The database functions enable you to quickly carry out value queries on data points and elements.
- API Manager
  The WinCC OA API (Application Programming Interface) offers a number of functions adding special Managers to this process control system.
Data Visualization
User interfaces, Trends and Reports for every purpose and device.
Southbound Interfaces
The process connection to the actual machines/sensors.
Northbound Interfaces
Your portal to the cloud or supervising systems.
Web Connectivity / Network Interfaces
Data exchange, APIs and web technologies
User Management
All about authorization, authentication and login-customization.
Availability
How to get your system uptime to the maximum.
Reporting
Create state of the art project reports without limits.
Addons
Useful tools and enhancements for special demands.
Reference Tables
Detailed and extensive content for special project adaptation.
Videos & Tutorials
Explore the capabilities of WinCC OA with our carefully selected collection of video tutorials and guides.
WinCC OA Documentation
Basic information about terms and functions within the documentation.
Disclaimer
A brief clarification of liability exclusions or legal notices.

enumKeys()

The function returns the list of keys that are available within the enumeration.

Synopsis

dyn_string enumKeys(string enumName)

Parameter


Parameter	Description
enumName	Name of the enumeration

Return value

Dyn_string with the keys of the enumeration.

Error

Description

The function returns the keys of the enumeration as a list in the order in which they have been added.

Example

enum enumLocal{ A, B, C };
main(mapping event)
{
  DebugN(enumKeys("enumLocal"));
}

Output of the script inside of the LogViewer:

WCCOAui1:[dyn_string 3 items
WCCOAui1:     1: "A"
WCCOAui1:     2: "B"
WCCOAui1:     3: "C"
WCCOAui1:]

Assignment

Misc. Functions

Availability

UI, CTRL