%SSC_CANCEL

Cancel outstanding requests

WTSupported in traditional Synergy on Windows
WNSupported in Synergy .NET on Windows
USupported on UNIX
VSupported on OpenVMS
value = %SSC_CANCEL(dbchannel)

Return value

value

This function returns SSQL_NORMAL (success). (i)

Arguments

dbchannel

An internal database channel previously initialized using %SSC_INIT and connected by %SSC_CONNECT. (n)

Discussion

%SSC_CANCEL cancels outstanding database requests when a user cancels a database operation. The results of the function depend on the database, and some databases, such as Oracle Rdb, don’t support this type of call. For these databases, nothing is canceled; the function simply returns SSQL_NORMAL. Databases that do support a cancel, however, may do the following: cancel any outstanding database requests, cancel execution of current SQL statements (or the entire set of currently processing batch commands), and flush and pending results.

Use this function only in program‑exit routines that are called when the user cancels a database operation—for example, in a routine that’s called after ctrl+c is trapped or in a close method for a Windows application.