Home
Business Logic / Control
Endless possibilities in data processing for your projects.
Types of Control Functions
An overview of the types of functions distinguished within Control.
Datapoint Functions

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.
  - 32/64 bit Functions
  - Administration of Managers, Modules and Panels - Functions
  - Alert Handling Functions
    These functions are associated with datapoints and respond to alerts and changes to alerts.
  - AlertService Functions
    These functions provide alarm shelving, suppression, and out-of-service capabilities via the AlertServiceClient class.
  - Blob Functions
  - Communication functions
  - Connection Functions
    Connection functions can be used to establish connections to alerts, datapoints and system events.
  - Crypthographic Functions
  - Database Functions
  - Datapoint Functions
    - acGetRefACType()
      Returns a AC type name, if the leaf dpeName is referenced to an AC type, otherwise an empty string.
    - alertGet()
      Queries only the last alert attributes of a datapoint.
    - alertSet()
      Allows datapoint attributes to be set in a similar way to dpSet().
    - alertSetTimed()
      Allows datapoint attributes to be set in a similar way to dpSet(). Additionally the timestamp can be set manually.
    - alertSetTimedWait()
      Allows datapoint attributes to be set in a similar way to dpSet(). Additionally the timestamp can be set manually.
    - alertSetWait()
      Allows datapoint attributes to be set in a similar way to alertSet()/dpSetWait().
    - checkQuery()
      Checks the syntax of a query.
    - dpAliasToName()
      Returns the datapoint element for the given alias.
    - dpAliases()
      Returns all aliases with fitting pattern of filter and (optional) suitable filter dpeFilter of the datapoint elements.
    - dpAttributeType()
      Returns the data type.
    - dpChange()
      The function opens a datapoint in the PARA module in change mode.
    - dpConnect()
      Calls a callback function whenever the passed datapoint values/attributes change.
    - dpConnectUserData()
      Calls a callback function on data change of the defined datapoint values/attributes and passes them to it. In contrast to dpConnect(), this function allows you to also pass any data to the callback function.
    - dpCopy()
      Copies a datapoint including the configuration.
    - dpCopyBufferClear()
      Clears the buffer copies prior to a new dpCopy().
    - dpCopyConfig()
      The function dpCopyConfig() copies a config from a source datapoint element into a target datapoint element.
    - dpCopyConfigMerge()
      dpCopyConfigMerge() copies specific configs from a source datapoint element into a target datapoint element.
    - dpCopyConfigMergeBufferClear()
      Clears the buffer copies prior to a new dpCopyConfigMerge().
    - dpCopyOriginal()
      Copies the original value of the source datapoint to the target data point.
    - dpCreate()
      Creates a datapoint.
    - dpDelete()
      Deletes a datapoint.
    - dpDirectRead()
      The function reads values from datapoints directly from the PLC
    - dpDirectWrite()
      The function writes datapoint values directly to the PLC
    - dpDisconnect()
      The function unregisters function work().
    - dpDisconnectUserData()
      Unregisters a callback function which was called using dpConnectUserData().
    - dpElementType()
      Returns the data type.
    - dpExists()
      The function dpExists() checks the existence of a valid datapoint identifier.
    - dpGet()
      Reads values of datapoint attributes in variables.
    - dpGetAlias()
      New consistent name for the function dpNameToAlias. The function dpGetAlias() returns the alias for the specified datapoint element.
    - dpGetAllAliases()
      Returns all datapoints and their aliases. For the return of aliases you can also define filters in this function (see description of the parameters below). The function replaces getAllDpAliases() in versions > 2.11.1.
    - dpGetAllAttributes()
      Returns all attributes of the config "_config" (for example, of "_original")
    - dpGetAllComments()
      The function may not used any longer; replaced by dpGetAllDescriptions(). Returns in dpe all datapoint elements and in comments all comments with a suitable (optional) filter for comments. Further more optional: datapoint elements with fitting filter for datapoint elements
    - dpGetAllConfigs()
      Returns all possible configs, which are allowed to configure to a datapoint element "dpe" resp. to a data type "dpeType(bit, bitarray, structure, ...).
    - dpGetAllDescriptions()
      Returns via dps all datapoints and via descriptions all descriptions that correspond to the descriptionFilter. You can also specify a dpeFilter. This means that only the datapoints containing the specified datapoint element are returned provided that the description of the datapoint element corresponds to the descriptionFilter.
    - dpGetAllDetails()
      Returns all details of a config (for example, of "_lock").
    - dpGetAsynch()
      Reads values of datapoint attributes at a particular source time and writes them to variables.
    - dpGetComment()
      Returns the comment for the datapoint element(s).
    - dpGetDescription()
      Returns the description for the datapoint element(s).
    - dpGetDpTypeRefs()
      The function returns all references in a DPT.
    - dpGetFormat()
      This function returns the "format" of a datapoint.
    - dpGetId()
      Returns the datapoint ID and the element ID of the defined datapoint.
    - dpGetMaxAge()
      If a peripheral address exists, the function triggers a singleQuery for a driver if the value of the datapoint element dpName is older than the parameter age and returns the value from the driver.
    - dpGetName()
      Returns the datapoint name for the passed datapoint ID and element ID.
    - dpGetPeriod()
      The function queries DP attributes over a specified period of time.
    - dpGetRefsToDpType()
      The function returns all DPTs and DPs that contain the specified DPT as a reference.
    - dpGetStatusBit()
      Retrieves status bits.
    - dpGetUnit()
      This function returns the unit of a datapoint.
    - dpIsLegalName()
      Checks, whether the name of a datapoint contains incorrect characters.
    - dpNameCheck()
      This function should not be used anymore and was replaced by the function nameCheck(). Checks, whether the name of a datapoint contains only the following characters: 0...9, A...Z, _, a...z.
    - dpNames()
      Returns all the datapoint names or datapoint element names that match a pattern. The datapoint structures are written to the array in alphabetical order.
    - dpQuery()
      Retrieves attribute values with the help of SQL statements.
    - dpQueryConnectAll()
      The function dpQueryConnectAll subscribes to attributes of configs from multiple Data Point Elements, which meet a certain query condition. When a subscribed attribute changes, a callback function (“work” function) is executed. The event manager will always send all subscribed elements, even if only one changes. Therefore update messages will always contain all subscribed elements.
    - dpQueryConnectSingle()
      The function dpQueryConnectSingle subscribes to attributes of configs from multiple Datapoint Elements, which meet a certain query condition. When a subscribed attribute changes, a callback function (“work” function) is executed. The Event Manager will send every single change separately, so update messages will normally contain only one element. If however several of the subscribed attributes are changed together within one message (i.e. in one dpSet() function call), then these will be all be forwarded in one message to the subscribing work function. Additionally, the execution of the work function can be delayed with the optional parameter blockingTime to accumulate more changes, increasing performance.
    - dpQueryDisconnect()
      Can be used to unregister work functions registered via dpQueryConnectAll() or dpQueryConnectSingle()
    - dpSet()
      The function assigns datapoint attributes values or creates datapoint configs.
    - dpSetAlias()
      The function dpSetAlias() sets the alias for the specified datapoint element.
    - dpSetComment()
    - dpSetDescription()
      Sets a comment for the datapoint element dp.
    - dpSetFormat()
      Sets the format of a DP element.
    - dpSetTimed()
      Assigns values and a source time to the original attributes that can be changed by the user or to the attribute "_corr.._value".
    - dpSetTimedWait()
      Assigns values and a source time to the original attributes that can be changed by the user or to the attribute "_corr.._value".
    - dpSetUnit()
      Sets the unit of a DP element.
    - dpSetWait()
      Assigns datapoint attributes and waits for an answer from the event manager.
    - dpSubStr()
      The function dpSubStr() returns the part (sub string) of a datapoint name given by pattern. The function returns the neutral form of configs and attributes.
    - dpTypeChange()
      The function changes datapoint types.
    - dpTypeCreate()
      The function creates a new datapoint type.
    - dpTypeDelete()
      The function deletes an existing datapoint type.
    - dpTypeGet()
      Returns the structure of a datapoint type.
    - dpTypeName()
      Returns the data point type for the datapoint name.
    - dpTypeRefName()
      The function "dpTypeRefName" returns the type reference of the selected DPE.
    - dpTypes()
      Returns all the datapoint types from the current project.
    - dpValToString()
      This function converts the value specified in val into a string, with the format string of the datapoint element dp being used. If anytype is a dyn, then this function returns a dyn_string as the result.
    - dpWaitForValue()
      The function waits for a certain time (timeout) for a value change that fulfills the condition and returns the values of the different or same datapoints via the parameter returnValues.
    - getACount()
      Returns the internal number of an alarm (count starts at 0) at a particular time.
    - getAIdentifier()
      Outputs the name of a datapoint.
    - getAllDpAliases()
      Returns all the datapoints and their aliases. Starting from version 2.11.1, the function has been renamed to ControlA_D/dpGetAllAliases.html
    - getPanelPreview()
      Creates a preview (image) of the available panel references for Drag & Drop of DPTs and DPs.
    - getReduDp()
      The function getReduDp() checks if a right-side redundancy partner exists (if the specified datapoint has a redundant partner).
    - groupCreate()
      Creates a new datapoint group and passes the name of the created datapoint of the group as well as the error code via parameters.
    - groupDelete()
      Deletes a datapoint group.
    - isAlertAttribute()
      Indicates whether the passed attribute is an alarm attribute. That means whether is can be queried with alertGetPeriod(), alertConnect(), SELECT ALERT or can be set with alertSet().
    - isReduDp()
      The function isReduDp() checks if the specified datapoint is redundant.
    - nameCheck()
      Checks if the name of a datapoint or name of a project only contains the permitted characters.
    - setACount ()
      Sets an alarm number in an alarm time variable.
    - setAIdentifier()
      Sets the name of a dat point in a time of an alert.
    - startPanelRefConstruct()
      Starts the construction of the panel reference in the current panel in the GEDI.
  - Error Functions
  - File Functions
    File functions allow you to import, export, open, close, and manipulate files within the application. This topic describes how to use file functions and important considerations for cross-platform compatibility.
  - Graphics Functions
  - Help Viewer Functions
    Available Functions for the Help Viewer.
  - HTTP Functions
  - Input Event Recorder Functions
  - Licensing Functions
  - Mapping Functions
  - Mathematical Functions
  - MindSphere Connector Functions
  - Miscellaneous Functions
  - Multilingual Functionality
  - Project administration Functions
  - Query Functions
  - Redu/Dist Functions
  - Selection and Configuration Dialogs - Functions
  - Semaphore Functions
  - String Functions
  - Subscription-based Licensing Functions
    CONTROL functions for querying information from subscription-based licenses.
  - System Tray
  - Time Functions
  - Threads Functions
  - User Administration Functions
  - Vector / Dynamic arrays - Functions
  - Waiting Control Functions
  - Window Functions
    This chapter lists all functions used to control windows and panels, such as ChildPanelOn, LayerOn, LayerOff, PanelOff, RootPanelOn, SwitchLayer, ZoomModule, and related dialog and module operations.
  - XML Control Extension Functions
- Control Graphics
- CONTROL Functions
- 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 datapoints and elements.
- WinCC OA JavaScript Manager for Node.js
  The WinCC OA JavaScript Manager for Node.js is a manager that allows for the integration of the TypeScript/JavaScript runtime environment Node.js into WinCC OA.
- 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.
eLearning
Build Your Expertise Step by Step
Documentation
Basic information about terms and functions within the documentation.
Support & Services
An experienced team of support agents, consultants and trainers are ready to facilitate active partnerships with our customers, so they can profit from our comprehensive service.
Disclaimer
A brief clarification of liability exclusions or legal notices.
SIMATIC WinCC OA World
Explore the World of WinCC OA and Stay updated with the latest product news

Datapoint Functions

Using these functions you can read, change or manipulate datapoint values and attributes.

When querying a DPE of the type "struct" a warning (see below) is sent to the LogViewer. It is recommended that the last element of a DP are no complex data types but instead e.g. bool, int, float, ....

WCCILevent (0), <TIMESTAMP>, IMPL, WARNING, 54, Unexpected state, DP:
                <DP-ID>:_original.._stime, MAN: (SYS: 1 Event -num 0 CONN: 2),
                EvDpManager::getDpValueAttribut: no config

These functions cannot be used in the context of the event manager!
Depending on the actual project the dpConnect* functions may be limited by the default value of the config entry maxConnectMessageSize. If required corresponding changes to this entry must be set.