The CTAPI functions allow access to Citect SCADA I/O variable tags via a DLL interface. This allows third-party developers to create applications in C or other languages to read and write to the I/O Devices.
Function |
Argument(s) |
Type |
Description |
---|---|---|---|
hCTAPI, pctOverlapped |
Boolean |
Cancels a pending overlapped I/O operation. |
|
hCTAPI, sCmd, hWin, nMode, sResult, dwLength, pctOverlapped |
DWORD |
Executes a Cicode function. |
|
ctClientCreate | () | n/a | Initializes the resources for a new CtAPI client instance |
ctClientDestroy | hCTAPI | Boolean | The handle to the CTAPI as returned from ctOpen(). |
hCTAPI |
Boolean |
Closes a connection to the Citect SCADA API. |
|
ctCloseEx | hCTAPI,bDestroy | Handle | The handle to the CTAPI as returned from ctOpen(). |
pResult, dValue, pScale, dwMode |
Boolean |
Converts the engineering scale variable into raw I/O Device scale. |
|
hnd |
Boolean |
Closes a search initiated by ctFindFirst(). |
|
hCTAPI, szTableName, szFilter, pObjHnd, dwFlags |
Handle |
Searches for the first object in the specified database which satisfies the filter string. |
|
hCTAPI, szTableName, szFilter, szCluster, pObjHnd, dwFlags |
Handle |
Searches for the first object in the specified database which satisfies the filter string specified by cluster. |
|
hnd, pObjHnd |
Boolean |
Retrieves the next object in a search initiated by ctFindFirst(). |
|
ctFindNumRecords | hnd | Boolean | Gets the number of records for a given browsing session. |
hnd, pObjHnd |
Boolean |
Retrieves the previous object in a search initiated by ctFindFirst(). |
|
hnd, dwMode, dwOffset, pObjHnd |
Handle |
Scrolls to the necessary object in a search initiated by ctFindFirst(). |
|
hCTAPI, lpctOverlapped, pBytes, bWait |
Boolean |
Returns the results of an overlapped operation. |
|
hnd, szName, pData, dwBufferLength, dwResultLength, dwType |
Boolean |
Retrieves an object property. |
|
lpctOverlapped |
Boolean |
Checks for the completion of an outstanding I/O operation. |
|
hList, sTag |
Handle |
Adds a tag to the list. |
|
hList, sTag, bRaw, nPollPeriodMS, dDeadband |
Handle |
Adds a tag to the list with a specified poll period. |
|
hTag, pBuffer, dwLength, dwMode |
Boolean |
Gets the value of a tag on the list. |
|
hTag |
Boolean |
Frees a tag created with ctListAdd(). |
|
hCTAPI, dwMode |
Handle |
Returns the elements in the list which have changed state since they were last read using the ctListRead() function. |
|
hList |
Boolean |
Frees a list created with ctListNew(). |
|
hTag, dwitem, pBuffer, dwLength, dwMode | Boolean | Gets the tag element item data. | |
hCTAPI, dwMode |
Handle |
Creates a new list. |
|
hList, pctOverlapped |
Boolean |
Reads every tag on the list. |
|
hTag, sValue, pctOverlapped |
Boolean |
Writes to a single tag on the list. |
|
sComputer, sUser, sPassword, nMode |
Handle |
Opens a connection to the Citect SCADA API. |
|
sComputer, sUser, sPassword, nMode, hCTAPI |
Handle |
Establishes the connection to the CtAPI server using the given client instance. |
|
pResult, dValue, pScale, dwMode |
Boolean |
Converts the raw I/O Device scale variable into engineering scale. |
|
hCTAPI, szTagName, |
Boolean |
Gets the given property of the given tag. |
|
hCTAPI, sTag, sValue, dwLength |
Boolean |
Reads the current value from the given I/O Device variable tag. |
|
ctTagReadEx | hCTAPI, sTag, sValue, dwLength, pctTagvalueItems | Boolean | Performs the same as ctTagRead, but with an additional new argument |
hCTAPI, sTag, sValue |
Boolean |
Writes the given value to the I/O Device variable tag. |
|
hCTAPI, sTag, sValue, pctOverlapped |
Boolean |
Performs the same as ctTagWrite, but with an additional new argument. |
Published June 2018