CONTROL
- Introduction to CTRL
- Control Classes
- Types of Control Functions
- Control graphics
- CONTROL Functions
  - Funtions A
    - abortFileTransfer()
      The function abortFileTransfer() aborts all file transfers of the stated manager.
    - abs()
      Returns the absolute value of a value.
    - access()
      Queries the access mode of the file or directory with the specified path name.
    - acGetRefACType()
      Returns a AC type name, if the leaf dpeName is referenced to an AC type, otherwise an empty string.
    - acos()
      Returns the arc cosine in the radian measure.
    - activateMode()
      Switches the module to normal operating mode.
    - addGlobal()
      Creates a variable and makes it into a control-wide variable.
    - addGroup()
      Adds a group of shapes or a layout to a panel.
    - addGroupPVSS()
      Adds a user group of an external authentication system to the WinCC OA user administration.
    - addShape()
      Adds a new shape into a panel.
    - addSymbol()
      Adds a panel reference in a panel or layout at a later time during run time. To suppress the Initialize scripts of the reference the function createSymbol() can be used instead.
    - addUserPVSS()
      Adds a user of an external authentication system to the WinCC OA user administration.
    - addUserToGroupPVSS()
      Adds a WinCC OA user to a user group in the WinCC OA user administration.
    - aes256Decrypt()
      The function allows to decrypt an encrypted information with the AES-256 algorithm.
    - aes256Encrypt()
      The function allows to encrypt the passed information with the AES-256 algorithm.
    - afterLogin()
      After successful login displays the required panel.
    - alertConnect()
      Registers the function work() for call with resulting alerts.
    - alertDisconnect()
      Unregisters the function work() from call when changes are made to the values.
    - alertGet()
      Queries only the last alert attributes of a data point.
    - alertGetPeriod()
      Reads the values of the specified alert attributes of the data point elements for which alerts were triggered.
    - alertSet()
      Allows data point attributes to be set in a similar way to dpSet().
    - alertSetTimed()
      Allows data point attributes to be set in a similar way to dpSet(). Additionally the timestamp can be set manually.
    - alertSetTimedWait()
      Allows data point attributes to be set in a similar way to dpSet(). Additionally the timestamp can be set manually.
    - alertSetWait()
      Allows data point attributes to be set in a similar way to alertSet()/dpSetWait().
    - animate()
      With the function animate() you can create animations.
    - animateWait()
      With the function animateWait() you can create animations and wait for them to finish.
    - asin()
      Returns the arc sine in the radian measure.
    - assignPtr()
      The function allows to assign a shared_ptr to a different shared_ptr..
    - atan()
      Returns the arc tangent in the radian measure.
    - atan2()
      Returns the arc tangent of the Cartesian coordinates y and x.
    - "availableCameras"
      This function shows the cameras available on the system.
  - 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
  - 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.

alertGet()

Queries only the last alert attributes of a data point.

Synopsis

int alertGet(time t, int count, string dp, anytype &value [, time t2, int count2, string dp2, anytype &value2, ...]);

int alertGet(time t, int count, dyn_string dps, dyn_anytype &values);

Parameters


Parameter	Meaning
t1	Time of occurrence
count 1	Serial number
dp1	Data point name
value1	The returned alert value.
dps	Dynamic string of data point names. Note: If alertGet() is used with dyn parameters, all entries of this dyn element must specify exactly the same alert and they may only differ by the attribute. SYSTEM:DATAPOINT.ELEMENT:CONFIG.DATATYPE must be equal.
values	Returned alert values.

Return Value

If the function was successfully executed, it returns 0 and in the event of a failure -1. The return value 0 only indicates that the message was correctly sent to Event Manager.

Errors

Independently of the return value, errors can be retrieved with getLastError() (nonexistent data points, missing arguments or no read permission).

Description

Queries only the last alert attributes of a data point. Historical alerts will not be queried.

Those historical alerts which have been configured that they are not deleted can still be queried by alertGet().

Example

main()
{
  bool ok;
  atime a;
  ok = TRUE;
  dpGet("ExampleDP_AlertHdl1.:_alert_hdl.._ok_range",ok);
  alertGet(a, getACount(a), "ExampleDP_AlertHdl1.:_alert_hdl.._value", ok);
  DebugN("alertGet: atime = " + (string) a + ", value = " + ok);
}

Assignment

Data point function

Availability

CTRL