Home
Business Logic / Control
Endless possibilities in data processing for your projects.
CONTROL Functions
Functions P
pt_moduleNumber()
The function is used in conjunction with panel topology when a multi-monitor mode has been chosen. The function creates a mainModule & 2 from "mainModule_2".

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
    - paCfgDeleteValue()
      The function deletes the first occurrence (top down) of the specified key (config entry) or key/value pair from the specified section in the config file.
    - paCfgInsertValue()
      The function adds a key (Config entry) /value (value of the config entry) pair to a specified section of the config file. You can also add the entry/value pair before or after the first or last search key (the search key is a specified config entry), before the first value (see the parameter table below).
    - paCfgReadValue()
      The function reads the value of a specified entry in a config file section. If there are several identical values, only the last one will be read.
    - paCfgReadValueDflt()
      The function returns either the value of the found entry or the default value.
    - paCfgReadValueList()
      The function reads all values of a config entry that exist more than once in a config file. The function can be used, for example, for reading the values of the proj_path entry, the LoadCtrlLibs entry or others.
    - paCurrentConfigFiles()
      The function shows what config files were read by the current manager.
    - paIsRunAsAdmin()
      The function checks if the process of the project administration is running with administrative privileges.
    - panelFileName()
      Returns the relative panel file name, for example, "vision/login.pnl"
    - PanelOff()
    - panelOff()
      Closes a defined childpanel without connection to the Event Manager.
    - PanelOffModule()
      Closes a panel in a specific module.
    - PanelOffPanel()
      Closes a particular panel
    - PanelOffReturn()
      Needed for closing a child panel with a return value.
    - panelPosition()
      Returns the position of a panel.
    - panelSelector()
      Opens the file selection dialog and writes the selected file name to a variable.
    - panelSize()
      Returns the width and height of a panel.
    - panelZoomIn()
      Zooms in the rootpanel in a module around the center with the specified zoom factor.
    - panelZoomOut()
      Zooms out the rootpanel in a module around the center with a specified zoom factor.
    - panningMode()
      Activates or deactivates the function for displacing the root panel in a module.
    - PasswordDialog()
      Opens a dialog for changing the password of the current user.
    - patternMatch()
      Checks whether a string has a particular pattern.
    - "pause"
      Pauses the playback.
    - period()
      Returns the seconds of a time t that have elapsed since 1.1.1970, 00:00 (UTC).
    - "play"
      Starts the playback of the given source.
    - pmonGetCount()
      The function pmonGetCount() returns the number of managers defined.
    - pmonGetName()
      The function pmonGetName() returns the name of the WinCC OA manager that corresponds to the specified index.
    - pmonGetNum()
      The function pmonGetNum() returns the number of a WinCC OA manager.
    - pmonGetOptions()
      The function pmonGetOptions() returns the manager options of a WinCC OA manager.
    - pmonGetPID()
      The function pmonGetPID() returns the process ID of a WinCC OA manager.
    - pmonGetResetMinutes()
      The function pmonGetResetMinutes() returns the reset minutes set for a WinCC OA manager.
    - pmonGetRestartCount()
      The function pmonGetRestartCount() returns the number of restarts set for a WinCC OA manager.
    - pmonGetSecondsToKill()
      The function pmonGetSecondsToKill() returns the set "seconds to kill" for a WinCC OA manager.
    - pmonGetStartMode()
      The function pmonGetStartMode() returns the start mode of a WinCC OA manager.
    - pmonGetStartTime()
      The function pmonGetStartTime() returns the start time of a WinCC OA manager.
    - pmonGetState()
      The function pmonGetState() returns the manager state of a WinCC OA manager.
    - pmonStartModeToStr()
      The function pmonStartModeToStr() converts a manager start mode of a WinCC OA manager into string format.
    - popupMenu()
      Activating a context-sensitive menu by means of right-clicking.
    - popupMenuXY()
      Opens a pop-up menu in a specific position.
    - popupMessage()
      Sends a pop-up message to the desired user interface. With this function you can send messages to other "foreign" user interfaces.
    - pow()
      Returns xy.
    - prepareValues()
      The method prepares the values that were assigned to the method for the upload.
    - printPanel()
      Prints a panel.
    - printRootPanel()
      Prints a particular root panel.
    - printTable()
      This function prints a table.
    - projectTranslationUnload()
      This function tells the manager to unload all currently loaded translation files.
    - projectTranslationUpdate()
      Scans all panels and scripts from one project level and updates the translation file.
    - pt_buildModuleName()
      The function is used in conjunction with panel topology when a multi-monitor mode has been chosen. The function creates a module with the specified name and number.
    - pt_moduleNumber()
      The function is used in conjunction with panel topology when a multi-monitor mode has been chosen. The function creates a mainModule & 2 from "mainModule_2".
    - pt_panelOn()
      The function is used in conjunction with panel topology and opens a panel in a module.
    - ptms_LoadOneBasePanel()
      If two base panels are started on two monitors and the base panel will be closed on one of the monitors, the function ptms_LoadOneBasePanel can be used to reopen the base panel on this monitor.
    - pvAddColumn()
      Adds a column with the specified label to the project view.
    - pvAddSeparator()
      Adds a separator between two options of the context menu in the project view. It is not possible to set a separator behind the last menu option or before the first menu option. Also it is possible to set only one separator between two options. If this function is used in the script between the same options multiple times, anyhow, only one separator will be shown in the context menu.
    - pvAddSubMenu()
      Adds a submenu.
    - pvConnect()
      Calls the specified function with the specified label.
    - pvRefreshNode()
      The function pvRefreshNode() is used to update the project view of the GEDI through reporting to the project view all new or deleted files since the last function call.
    - pvRemoveAllUserColumns()
      Deletes all columns that were added via pvAddColumn().
    - pvSetColumnProperties()
      Use the CTRL function "pvSetColumnProperties" to set certain column properties for a column in the project view of the GEDI. This function is for use in the projectView.ctl file only (wincc_oa_path/[Version]/scripts/gedi/projectView.ctl).
    - pvSetItemProperties()
      Sets the font and color for a file in a specific column.
    - pvSetItemText()
      Sets an item text for a file in a specific column.
  - 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.
- 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.

pt_moduleNumber()

The function is used in conjunction with panel topology when a multi-monitor mode has been chosen. The function creates a mainModule & 2 from "mainModule_2".

Synopsis

pt_moduleNumber(string &sModuleName, int &iModuleNumber);

Parameters


Parameter	Description
sModuleName	Return value: module name
iModuleNumber	Return value:number of the module.

Return value

If the operation has been executed succesfully, the function returns 1 otherwise, 0.

Error

Missing or wrong parameter definitions.

Description

The function is used in conjunction with panel topology when a multi-monitor mode has been chosen. The function creates a mainModule & 2 from "mainModule_2".

EXAMPLE

Creates mainModule & 2 from "mainModule_2".

main()
{
  string sModuleName = "mainModule_2";
  int iModuleNumber;
  pt_moduleNumber(sModuleName, iModuleNumber)
  DebugN(sModuleName, iModuleNumber);
}