Cicode Programming Reference > Cicode Function Categories > SQL Functions > SQLCancel

SQLCancel

This function cancels both the current operation on the given connection and all other pending operations on the given connection. The cancellation means that the current operation on the SCADA side is immediately finished. The cancelled operation returns error code 299 and its state on the database side should be considered as undefined, that is, it is not known that it either succeeded, partially succeeded, or was unsuccessful.

This function is a blocking function. It blocks the calling Cicode task until the operation is complete. It can be called in the foreground or background.

Syntax

SQLCancel(hConnection)

hConnection:

The handle to the connection.

Return Value

0 (zero) if successful, otherwise an error code is returned. (For details of the 307 error code, call the SQLErrMsg() function).

Related Functions

SQLCreate, SQLOpen, SQLClose, SQLDispose, SQLConnect, SQLDisconnect, SQLInfo

See Also

SQL Functions

Published June 2018