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.
  - 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
- 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

access()

Queries the access mode of the file or directory with the specified path name.

Synopsis

int access(string path, int amode);

Parameters


Parameter	Description
path	Path name. For example, "scripts/copyText.ctl". You can specify an absolute path or a relative path from the PROJ_PATH directory. Note: An empty string "" is interpreted as PROJ_DIR.
amode	Access modes ( for example, F_OK). Possible modes to query are: R_OK Is the file readable? W_OK Is the file writeable? X_OK Is the file executable? F_OK Does the file exist?

Return Value

The function returns 0 if the required access is possible and -1 in the event of an error.

Errors

In the event of missing or incorrect arguments (for example,: Path not transferred as a string).

Description

This function queries the access mode of the file or directory with the specified path name. The required access mode should be specified for the parameter amode. With a concurrent query an OR operation is carried out bit by bit for these values. That means as soon as a possibility is true 0 is returned. The function does not return -1 until all accesses are impossible. With F_OK a query can be performed as to whether the file path exists at all.

Under Windows the function returns -1 if spaces are used in the file name/folder name. If the file name/folder name contains Cyrillic characters and Cyrillic language settings are not configured (e.g. Russian), the function also returns -1.

Restriction: Querying X_OK is only meaningful under Linux, under Windows the function always returns 0 (positive).

Important: The function only checks if the stated path exists in case a folder was passed to the function.

The following example checks whether the file config exists in the directory C:/tmp/english/config: If the file exists, 0 is returned. If it does not exist or is written incorrectly, -1 is written to the Log viewer.

main()
{
  int i;
  i=access("C:/tmp/english/config/config", F_OK);
  DebugN(i);
}

The following example checks whether the copyText.ctl in the scripts directory is writable.

main(mapping event)
{
  int i = access("scripts/copyText.ctl", W_OK);
  DebugN("Access to script possible:", i);
}

Assignment

File function

Availability

CTRL