CONTROL
- Introduction to CTRL
- Control Classes
- Types of Control Functions
- Control graphics
- CONTROL Functions
  - Funtions A
  - Funtions B
  - Funtions C
    - callFunction()
      Calls a specific function. The parameters of the called function are passed as parameters in callFunction().
    - captureScreen() - obsolete
      Returns an IDispatch (IPicture) image of the screen. (obsolete from version 3.5).
    - "cameraCaptureImage"
      Capture an image and save it to file.
    - "cameraIsReadyForCapture"
      Checks if the camera is ready to capture an image.
    - "cameraStart"
      Starts the camera.
    - "cameraStartDetectBarcode"
      Starts the detection of a barcode in the camera feed
    - "cameraStop"
      Stops the camera.
    - "cameraStopDetectBarcode"
      Stops the barcode detection.
    - "cameraToUse"
      Use the default system camera
    - ceil()
      Rounds up to an integer.
    - certificateAcceptPermanently()
      The function marks the given digest as "permanently accepted" and stores this information on the hard disk.
    - certificateIsPermanentlyAccepted()
      The function certificateIsPermanentlyAccepted() returns TRUE if the given certificate was already permanently accepted, e.g. by the user.
    - changeLang()
      Function for switching the language at runtime in a user interface.
    - checkLicenseOption()
      The function checkLicenseOption() allows you to check the number of available licenses for the specified WinCC OA license option.
    - checkCrypt()
      Compares a plain text with an encrypted hash value and checks if the text matches the decrypted value of the hash.
    - checkPassword()
      Checks the assignment of a password to the user id.
    - checkPattern()
      Compares a bit32/bit64 variable with a pattern.
    - checkQuery()
      Checks the syntax of a query.
    - checkScript()
      Checks the syntax of a script.
    - checkStringFormat()
      The function checks, wether the string 'value' is according the format in 'format' (for example, "%5.4f").
    - childPanel()
      Opens a child panel without connection to the Event Manager.
    - ChildPanelOn()
      Opens a child panel.
    - ChildPanelOnCentral()
      Opens a child panel centered in the calling parent panel.
    - ChildPanelOnCentralModal()
      Opens a modal child panel centered in the calling parent panel.
    - ChildPanelOnCentralModalReturn()
      Opens a modal child panel, with return value, centered in the calling parent panel.
    - ChildPanelOnCentralReturn()
      Opens a child panel with return value centered in the calling parent panel.
    - ChildPanelOnModal()
      Opens a modal child panel at the position x, y.
    - ChildPanelOnModalReturn()
      Opens a modal child panel with return values at the position x,y.
    - ChildPanelOnModule()
      Opens a child panel in an arbitrary module.
    - ChildPanelOnModuleCheckPos()
      Opens a child panel and also checks the validity of the position and size.
    - ChildPanelOnModuleModal()
      Opens a modal child panel in the module "ModuleName".
    - ChildPanelOnModuleModalReturn()
      Opens a modal child panel in the module "ModuleName" with a return value.
    - ChildPanelOnModuleReturn()
      Opens a child panel in the module "ModuleName" with return values.
    - ChildPanelOnParent()
      Opens a child panel in the specified panel.
    - ChildPanelOnParentModal()
      Opens a modal child panel in the specified panel.
    - ChildPanelOnParentModalReturn()
      Opens a modal child panel in the specified panel with return values.
    - ChildPanelOnParentReturn()
      Opens a child panel in the specified panel with return values.
    - ChildPanelOnRelativ()
      Opens a child panel relative to the calling object.
    - ChildPanelOnRelativModal()
      Opens a modal child panel relative to the calling object.
    - ChildPanelOnRelativModalReturn()
      Opens a modal child panel relative to the calling object, with a return value.
    - ChildPanelOnRelativReturn()
      Opens a child panel with a return value, relative to the calling object.
    - ChildPanelOnReturn()
      Opens a child panel with return values.
    - ChildPanelReturnValue()
      Opens a child panel of a particular type with a return value.
    - clearLastError()
      Allows to clear the last error which has been raised in WinCC OA.
    - clearLogViewer()
      Allows to clear the log viewer by script.
    - closeDialog()
      Closes its own dialog for simple configuration.
    - closeProgressBar()
      The function closes the module for the progress bar.
    - colorDblsWritable()
      The function returns True when UI manager may change the colorDB.
    - colorEditor()
      Opens the color editor and writes the names of the color to colstr.
    - colorGet()
      A color scheme is a collection of colorDB files located in a subdirectory of proj_path/colorDB, for example, WinCC_OA_proj_path/colorDB/DayScheme/colors. Hence, the name of the schema is "DaySchema" - the name of the directory. The function colorGet() returns a blink or an RGB definition of a color from a desired colorDB file.
    - colorGetActiveScheme()
      A color scheme is a collection of colorDB files located in a subdirectory of proj_path/colorDB, for example, proj_path/colorDB/DayScheme/colors. Hence, the name of the schema is "DaySchema" - the name of the directory. The function colorGetActiveScheme returns the active color scheme.
    - colorGetAlias()
      A color scheme is a collection of colorDB files located in a subdirectory of proj_path/colorDB, for example, WinCC_OA_proj_path/colorDB/DayScheme/colors. Hence, the name of the schema is "DaySchema" - the name of the directory. The function colorGetAlias() returns the color name of an alias from a desired colorDB file.
    - colorRemove()
      A color scheme is a collection of colorDB files located in a subdirectory of proj_path/colorDB, for example, proj_path/colorDB/DayScheme/colors. Hence, the name of the schema is "DayScheme" - the name of the directory. The function "colorRemove" deletes a color or alias definition from a colorDB file.
    - colorSet()
      A color scheme is a collection of colorDB files located in a subdirectory of proj_path/colorDB, for example, WinCC_OA_proj_path/colorDB/DayScheme/colors. Hence, the name of the schema is "DaySchema" - the name of the directory. The function colorSet() specifies a color in the specified colorDB file.
    - colorSetActiveScheme ()
      A color scheme is a collection of colorDB files located in a subdirectory of proj_path/colorDB, for example, proj_path/colorDB/DayScheme/colors. Hence, the name of the schema is "DayScheme" - the name of the directory. The function colorSetActiveScheme sets the active color scheme.
    - colorSetAlias()
      A color scheme is a collection of colorDB files located in a subdirectory of proj_path/colorDB, for example, WinCC_OA_proj_path/colorDB/DayScheme/colors. Hence, the name of the schema is "DaySchema" - the name of the directory. The function colorSetAlias() specifies an alias for a color in a colorDB file.
    - colorToRgb()
      The function retrieves the RGB values from the given color.
    - commonConfirm()
      Causes an acknowledge all of all the panels in the module "modulName".
    - confirmMode()
      Switches the module to individual acknowledge mode.
    - connectedShapes()
      Sets graphics objects where the function dpConnect() is active to a particular color for a certain time. All graphics objects that are connected to DPs are therefore displayed.
    - constructor
      Instances a new object of type MindSphereAsset.
    - convManIdToInt()
      Returns an integer that corresponds to the ManagerIdentifier.
    - convManIntToName()
      Converts an integer, which corresponds to the manager identifier, to manager name.
    - copyAllFiles()
      Copies all the files of the specified directory to a new directory.
    - copyAllFilesRecursive()
      Copies files and subdirectories of a directory to a new directory.
    - copyFile()
      Copies the specified source file to the specified target file or to the specified directory.
    - cos()
      Calculates the cosine.
    - cosh()
      Returns the hyperbolic cosine of an angle.
    - createAnimation()
      With the function you can create more complex animations. To create an animation group, call this function.
    - createNotification()
      The function creates a notification.
    - createPanel()
      Creates an (empty) panel file in a defined size (width and height) named "filename".
    - createQRCodeFile()
      Creates a QR code file.
    - createSymbol()
      Adds a panel references in a panel or layout at a later time during run time. The function is identical to addSymbol() but prevents the triggering of the added objects initialize scripts.
    - createUuid()
      This function allows to create Universally Unique Identifiers (UUID).
    - crypt()
      Encrypts the transferred text.
    - cryptoHash()
      Allows to create a checksum for a string or blob element.
    - cssLengthToPixel()
      Calculates the lenght of a given font in pixel.
  - 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
  - Functions S
  - Functions T
  - Functions U
  - Functions V
  - Functions W
  - Functions X
  - Functions Y
  - Functions Z
- CtrlExtension, basics
- 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.

colorDblsWritable()

The function returns True when UI manager may change the colorDB.

Synopsis

bool colorDbIsWritable();

Return Value

TRUE when UI manager may change the colorDB and FALSE when NOT.

Description

The function returns True when UI manager may change the colorDB.

Example

main(mapping event)


{


  bool isWr;


  isWr = colorDbIsWritable();


  DebugN("Is writable:", isWr);


}

Assignment

Miscellaneous functions

colorDblsWritable()

Synopsis

Return Value

Description

Assignment

Availability