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
  - 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
    - rad2deg()
      Converts an angle from a radian measure into degrees.
    - rand()
      Calculates a sequence of integer pseudo random numbers.
    - readSMS()
      The readSMS() function reads a SMS message with the phone number of the sender and the time when the message has been sent. Possible errors will be read as well. If you want to use the control function, the runtime script sms.ctl has to run in the console.
    - recode()
      The function converts a string and returns the string in the desired encoding.
    - reduActive()
      In a redundant system, returns the active computer.
    - reduSetActive()
      Activates the emergency switch on the left or on the right.
    - reduSetInactive()
      Deactivates the emergency switch on the left or on the right in a redundant system.
    - reduSetPreferred()
      Sets the Preferred to left or right in a redundant system.
    - reduSetSplitOff()
      Sets the split mode to off in a redundant project.
    - reduSetSplitOn()
      Sets the split mode in a redundant system.
    - reduSwitchDist()
      Switches over in the split mode.
    - reduSwitchDriver()
      Switches the drivers in the split mode.
    - regexpIndex()
      The function "regexpIndex()" provides pattern matching via regular expressions. The function searches for a match of the specified character starting from the given position.
    - regexpLastIndex()
      The function "regexpLastIndex()" provides pattern matching via regular expressions. The function searches for a match of the specified character(s) starting at the end of the string.
    - regexpSplit()
      The function "regexpSplit()" provides pattern matching via regular expressions.
    - registerDbgFlag()
      Registers a debug flag and returns a debug flag number.
    - releaseComObject()
      Releases the COM object.
    - reloadSecurityEventConfig()
      Function reloads the Security Event JSON configuration file for the local managers and PMON.
    - remove()
      The function remove() deletes a file.
    - removeAllBreakpoints()
      Removes all breakpoints from the current document.
    - removeDoneCB()
      The function prevents the calculation of unwanted data in data point functions and statistical functions.
    - removeGlobal()
      Deletes the manager-wide global CTRL variable name.
    - removeGroup()
      The function removes a group connection from the panel.
    - removeGroupPVSS()
      Removes a WinCC OA group.
    - removeShape()
      The function removes a shape from the panel.
    - removeSymbol()
      The function is used to delete panel references.
    - removeUserFromGroupPVSS()
      Removes a WinCC OA group from a user.
    - removeUserPVSS()
      The function permanently disables a user.
    - rename()
      The function renames a file.
    - renameGroupPVSS()
      Renames a WinCC OA user group.
    - renameUserPVSS()
      Renames a WinCC OA user.
    - requestFileList()
      The function requestFileList() requests a file list from the manager with the specified manager Id.
    - requestFileTransfer()
      The function requestFileTransfer() requests a list of files to be transferred from the active to passive partner in a redundant project.
    - restoreBookmarks()
      All bookmarks in the ewo are stored for the given context with ControlS_Z/saveBookmarks.html and can be restored again by passing the same context string to restoreBookmarks().
    - restorePanel()
      Opens an already loaded child panel that had been minimized.
    - restoreSettings()
      Loads and applies all settings defined via the script editor.
    - rewind()
      Places the pointer at the beginning of the file FileDesc.
    - rmdir()
      The function deletes a specified directory.
    - rootPanel()
      Returns the name of a particular root panel.
    - RootPanelOn()
      Opens a new panel in the current module.
    - RootPanelOnModule()
      Opens a panel in a particular module.
    - RSAGenerateKeyPair()
      The function RSAGenerateKeyPair() generates a public and a private key for the functions RSASealEnvelope() and RSAOpenEnvelope().
    - RSAOpenEnvelope()
      The function RSAOpenEnvelope() decrypts data.
    - RSASealEnvelope()
      The function RSASealEnvelope() encrypts data.
    - runRealSQL()
      The function runRealSQL executes an SQL command that does not return a value such as INSERT or DELETE.
    - runRealSQLQuery()
      The function runRealSQLQuery executes an SQL query of the RDB database.
  - 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.
- NextGen Archiver Backend-API
  This chapter describes the NextGen Archiver Backend API
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.

reduSetSplitOn()

Sets the split mode in a redundant system.

Synopsis

int reduSetSplitOn(string sSystem,bool bAsk=true, [string sShape]);

Parameter


Parameter	Description
sSystem	System name (System1, System2).
bAsk	TRUE = The windows are open FALSE = For internal use. No windows
sShape	Specifies the shape name of the button that is used to set the „toggleState“ mode. The mode „toggleState“ specifies whether the button looks liked pressed or not.

Return value

The function returns 0 if it was successfully executed and -1 in case of errors.

Error

Missing or wrong parameters. The function returns -1 in case of errors.

Description

Sets the split mode in a redundant system.

EXAMPLE

Sets the split mode in a redundant system.

main()
{
  string sSystem = "System1:";
  bool bAsk = true;
  string sShape = "PUSH_BUTTON1";
  int i = reduSetSplitOn(sSystem, bAsk, sShape);
  bool bState;
  getValue(sShape, "toggleState", bState);
  setValue(sShape, "toggleState", !bState);
}

Assignment

Redu/Dist functions

Availability

CTRL, UI