CtAPI

CtAPI provides access to Plant SCADA's tag data via a DLL interface. It enables third party developers to create applications in C (or other languages) that can read and write to I/O devices, run data queries and call Cicode functions.

To use CtAPI, you need to set up the following components:

• CtAPI server

  A CtAPI server is a Plant SCADA display client with remote access enabled. To achieve this:

  • Set the Citect.ini parameter [CtAPI]Remote to 1 on the computer applications will access.

  • Use the Server Authentication page in the Setup Wizard to confirm that the Server Password is configured (see Server Password Configuration).

• CtAPI client application

  To implement a CtAPI client application, you need to:

  • Build a CtAPI Application.

  • Run a CtAPI Application .

  • Configure a Secure Connection from a Remote CtAPI Application.

    The following also needs to be installed on remote CtAPI clients:

  • .NET 4.8

  • Microsoft Visual C++ 2015-2022 Redistributable (x86)

    Or:

    Microsoft Visual C++ 2015-2022 Redistributable (x64)

Note: This API has not been designed to be called from Plant SCADA Cicode DLL functions or from a Plant SCADA driver. If you attempt this, it may cause a deadlock condition to occur. If you need to call the CtAPI from a protocol driver, create a new Win32 thread to call the API. You cannot call the CtAPI from the Cicode DLL interface.

See Also

I/O Point Count

CtAPI Synchronous Operation

Read Data Using the CtAPI Functions

Error Codes

Debug Tracing

CtAPI Functions Reference