Home
CONTROL
CONTROL Functions
Functions M
moduleShow()
The given module is used as a initial point to search for the top level window that is then shown. In case of an embedded module, it will not be shown, but instead its container module window will be.

CONTROL
- Introduction to CTRL
- CONTROL Classes
- Types of Control Functions
- 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
    - makeATime()
      Returns an alert time in an internal time format incl. DP Identification.
    - makeDynAnytype()
      The function returns an dyn_anytype with n (n = the number of defined elements) elements.
    - makeDynATime()
      Returns a dynamic field of alert times.
    - makeDynBit32()
      Returns a dynamic field of 32 bit streams.
    - makeDynBit64()
      Returns a dynamic field of 64 bit streams.
    - makeDynBool()
      Returns a dynamic field of bits.
    - makeDynChar()
      Returns a dynamic field of characters.
    - makeDynFloat()
      Returns a dynamic field of floating-point numbers.
    - makeDynInt()
      Returns a dynamic field of integers.
    - makeDynLong()
      Returns a dynamic field of integers (64 bit).
    - makeDynMapping()
      Returns a dynamic array of mappings.
    - makeDynMixed()
      The function returns a mix with n (n = the number of defined elements) elements.
    - makeDynShape()
      Returns a dynamic array of shapes.
    - makeDynString()
      Returns a dynamic field of strings.
    - makeDynTime()
      Returns a dynamic array of internal times.
    - makeDynUInt()
      Returns a dynamic array of natural numbers.
    - makeDynULong()
      Returns a dynamic field of natural integers (64 bit).
    - makeError()
      The function returns an error (in an errClass variable) and shows an error message or an information message in accordance with the _errors.cat error message catalog in <wincc_oa_path>/msg/<lang>or an error or information message according to your own error catalog. If you use the first alternative in the example further on, you have to use the _errors.cat catalog. The second alternative allows you to use your own catalog file with your own error or information messages. In this way, the function can be used to handle own errors and to display own error and information messages.
    - makeMapping()
      Creates a mapping with key-value pairs.
    - makeNativePath()
      Converts a file path into a operating system specific file format.
    - makeTime()
      Returns a time or alert time in the internal time format.
    - makeUnixPath()
      Converts a path to a Unix "/" path.
    - mappingClear()
      Deletes all entries of a mapping.
    - mappingGetKey()
      Returns the key with a specified index.
    - mappingGetValue()
      Returns the value (of a mapping) with a specified index.
    - mappingHasKey()
      Checks if the "key" exists in a mapping.
    - mappingKeys()
      Returns an array with all keys of a mapping.
    - mappinglen()
      Returns the length of a mapping (associative array).
    - mappingRemove()
      Deletes the entry (of a mapping) with a specified "key".
    - maxFLOAT()
      Returns the value of the MAX_FLOAT constant: 1.7976931348623e+308.
    - maxINT()
      Returns the value of the MAX_INT constant: 2147483647.
    - maxLONG()
      Returns the value of the MAX_LONG constant: 9223372036854775807.
    - maxUINT()
      Returns the value of the MAX_UINT constant: 4294967295.
    - maxULONG()
      Returns the value of the MAX_ULONG constant: 18446744073709551615.
    - mcConnectAsset()
      Connects a MindSphere Asset with its counterpart on the MindSphere Server. If an asset is connected for the first time, the asset is onboarded.
    - mcDeleteAsset()
      Removes a MindSphere Asset from the CtrlMindConnect Ctrl Extension.
    - mcNewAsset()
      Makes a MindSphereAsset available in the CtrlMindConnect Ctrl Extension for further operations.
    - mcUploadValues()
      Uploads the data to the MindSphere Server.
    - mergeDictionary()
      Writes entries to the internal translation table.
    - milliSecond()
      Returns the milliseconds of a time.
    - minFLOAT()
      Returns the value of the MIN_FLOAT constant: -1.7976931348623e+308
    - minINT()
      Returns the value of the MIN_INT constant:-2147483648.
    - minLONG()
      Returns the value of the MIN_LONG constant: -9223372036854775808 .
    - minUINT()
      Returns the value of the MIN_UINT constant: 0.
    - minULONG()
      Returns the value of the MIN_ULONG constant: 0.
    - minute()
      Returns the minutes of a time.
    - mkdir()
      Creates a directory with a specified name.
    - moduleAddAction()
      Adds a new action to a self created menu in the Script Editor or GEDI module.
    - moduleAddDockModule()
      Adds a new dock module to a GEDI or VISION module or to the Script Editor.
    - moduleAddMenu()
      Adds a new menu to Script Editor or GEDI module.
    - moduleAddSubMenu()
      Adds a new submenu to the Script Editor or GEDI module.
    - moduleAddToolBar()
      Adds a new toolbar to the Script Editor or GEDImodule.
    - moduleGetAction()
      Returns the state of a selected attribute for a menu entry.
    - moduleHide()
      The given module is used as a initial point to search for the top level window that is then hidden. In case of an embedded module, it will not be hidden, but instead its container module window will be.
    - moduleIsVisible()
      The function checks if the given module is visible.
    - moduleLower()
      Replaces the function lowerModule() as of the version 3.8.
    - moduleMaximize()
      The given module is used as a initial point to search for the top level window that is then maximized (titlebar and taskbar will be displayed). In case of an embedded module, not the embedded module but its container module will be maximized.
    - moduleMinimize()
      The given module is used as a initial point to search for the top level window that is then minimized. In case of an embedded module, it will not be minimized, but instead its container module window will be.
    - ModuleOff()
      Closes a module.
    - moduleOff()
      Closes a module without connection to the Event Manager.
    - ModuleOn()
      Opens a new module.
    - moduleOn()
      Opens a new module without connection to the event manager.
    - ModuleOnWithPanel()
      This opens a new module and also displays there the specified root panel in the right size.
    - moduleOriginalSize()
      Resizes the panel to its original size.
    - moduleRaise()
      Replaces the function raiseModule() as of the version 3.8.
    - moduleResizeDocks()
      Resizes the listed modules to the listed sizes.
    - moduleRestore()
      The given module is used as an initial point to search for the top level window that is then restored. In case of an embedded module, it will not be restored, but instead its container module window will be.
    - moduleRestoreState()
      Restores the settings of the mainwindows toolbars and dockwidgets from a blob.
    - moduleSaveState()
      Saves the current state of the mainmodules toolbars and dockwidgets. See moduleRestoreState() to reapply the state.
    - moduleSetAction()
      Changes a selected attributes state of a menu or sub-menu entry that was added using moduleAddAction().
    - moduleShow()
      The given module is used as a initial point to search for the top level window that is then shown. In case of an embedded module, it will not be shown, but instead its container module window will be.
    - moduleShowFullScreen()
      The given module is used as a initial point to search for the top level window that is then enlarged to full screen (titlebar and taskbar are hidden). In case of an embedded module, not the embedded module but its container module will be enlarged.
    - month()
      Returns the month of a time.
    - moveFile()
      Moves the specified file or directory to the target directory.
    - moveModule()
      Moves a module to an arbitrary position on the screen.
    - mpGetMasterDpeForDpe()
      Returns the master data point for the given DP.
    - mpHasDpeConfig()
      Checks whether the given data point possesses a specific config or not.
    - msc_createFav()
      This function should be implemented if you close a user interface and want to save the last screen configuration.
    - msc_FavMenu()
      This function opens a popup menu with all favourites of the current user.
    - msc_movePanel()
      You can use the function to move a panel to an arbitrary screen.
    - msc_moveToNextScreen()
      You can use the function to move a panel to the next screen.
    - msc_moveToPrevScreen()
      You can use the function to move a panel to the previous screen.
    - msgCatEditor()
      The function opens the catalog editor.
    - msgToJs()
      This function is used to transfer data from Control to the JavaScript interface of the WebView EWO as response to the toCtrl() function.
    - myDisplayName()
      Returns the display the user is currently using.
    - myManId()
      Returns the manager ID as a number. The number contains coded the system, replica, type and number.
    - myManNum()
      Returns the manager number of the UI manager.
    - myManType()
      Returns the type of the current manager.
    - myModuleName()
      Returns the name of the current module.
    - myPanelName()
      Returns the name of the current panel.
    - myParameter()
      Queries the value of a dollar parameter.
    - myReduHost()
      Returns the host name of the Event Manager this manager is connected to.
    - myReduHostNum()
      Returns 1 or 2 (host number) in a redundant system depending on the connection to the Event Manager (manager 1 or 2) (for example, eventHost = "host1$host2"). In a non-redundant configuration it always returns 1.
    - myUiDpName()
      Returns the name of the user interface data point.
    - myUiNumber()
      Returns the number of the UI manager.
    - myWindowId()
      Returns the identification number of the current window.
  - 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
- CTRL Debugger
  With the CTRL Debugger you can debug the programming language Control.

moduleShow()

The given module is used as a initial point to search for the top level window that is then shown. In case of an embedded module, it will not be shown, but instead its container module window will be.

Synopsis

int moduleShow(string moduleName);

Parameters


Parameter	Description
moduleName	Initial point to search for the top level window that is then shown.

Return Value

The function returns 0 in normal operation or in the event of errors -1.

Description

This function can also be used for dockmodules.

Example

The main (top level) window is shown.

main()
{
  int i;
  i = moduleShow(myModuleName());
}

moduleShow()

Synopsis

Parameters

Return Value

Description

Availability