CONTROL
- Introduction to CTRL
- CONTROL Classes
- Types of Control Functions
- Control graphics
- CONTROL Functions
  - Funtions A
  - Funtions B
  - Funtions C
  - Funtions D
  - Functions E
    - exit()
      Terminates a manager and passes the exit code to the operating system.
    - errorDialog()
      Displays an error dialog.
    - ecdhGetPublicKey()
      The function stores the public key of the key pair for the ECDH key exchange.
    - errorText()
      Returns the text for the error code. This function should not be used anymore but remains included for reasons of compatibility. Instead of this function, use the functions getCatStr() or getErrorText(). These functions allow the definition of own error messages dependent on specific error codes. The error codes are saved in the file _errors.cat in the directory <wincc_oa_path>/msg/<lang>, respectively in the same file in the project directory.
    - ecdhDeriveSharedSecret()
      Generates a shared secret based on the key pair for an ECDH key exchange.
    - enumValues()
      The function returns the values of an enumeration as mapping.
    - execJsFunction()
      The function allows to call a JavaScript function from within the WebView EWO JavaScript code directly from CTRL.
    - eventPort()
      Returns the port number of the Event manager.
    - enableSound()
      Switches the sound of a wave file during runtime (see Configuration file).
    - execScriptRestricted()
      This function, like execScript(), allows for execution of a script during runtime. Use this function to run void main-functions which have no return value. Contrasting to execScript() the functions that can be used inside the executed script are limited to provide better security against insertion of malicious code.
    - ecdhReleaseKeyPair()
      The function releases a private/public key pair for an ECDH key exchange.
    - emSendMail() - obsolete
      This function allows sending mails.
    - execJsFunctionDyn()
      The function allows to call a JavaScript function from within the WebView EWO JavaScript code directly from CTRL.
    - evalScript()
      Allows to execute a script during runtime and to write the return value of the script in retVal.
    - enableMenuItem() - obsolete
      Supports disabling of menus (obsolete from version 3.5 up).
    - execScript()
      Allows to execute a script during runtime. Use this function for void main-functions (without return value).
    - emRetrieveMail()
      The function connects to a POP3 server and checks wether there are mails. If there are, the function retrieves the mails and deletes the mail at the server.
    - enumKeys()
      The function returns the list of keys that are available within the enumeration.
    - exp()
      Exponential function
    - eventHost()
      Returns the host name the event manager is running on.
    - evalScriptRestricted()
      Allows to execute a script during runtime and to write the return value of the script in target. Compared to the unrestricted function evalScript() only a more limited set of functions is allowed to provide better security.
    - ecdhGenerateKeyPair()
      The function generates a random private/public key pair for an ECDH key exchange.
  - 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
- CTRL Debugger
  With the CTRL Debugger you can debug the programming language Control.
- CtrlExtension, basics
- CTRLPPCheck
  Save time and money with increased code quality in your projects

enableSound()

Switches the sound of a wave file during runtime (see Configuration file).

Synopsis

bool enableSound(int type, bool enable [, string fileName]);

Parameters


Parameter	Meaning
type	Type of the event that starts the sound: SOUND_CLICK (1) SOUND_RIGHTCLICK (2) SOUND_DBLCLICK (3)
enable	State (enable 1, disable 0)
fileName	Name of the wave file (searched for in the directory <PROJ_PATH>/data/sounds or <wincc_oa_path>/data/sounds).

Return value

1 with sound, 0 without sound.

Error

Missing arguments, incorrect arguments.

Description

Switches the sound of a wave file during runtime (see Configuration file).

Example

The following script plays the sound of the file "police.wav" provided with the WinCC OA installation.

main()
{
   enableSound( 1, TRUE, "police.wav" );
}

Assignment

Miscellaneous functions