Difference between revisions of "SQLCANCEL()"
From Lianjapedia
Yvonne.milne (Talk | contribs) |
Yvonne.milne (Talk | contribs) |
||
| Line 18: | Line 18: | ||
The SQLCANCEL() function operates on the data source specified by <nStatementHandle>. | The SQLCANCEL() function operates on the data source specified by <nStatementHandle>. | ||
| − | {| class="wikitable" | + | {| class="wikitable" width=100% |
| − | !Keywords||Description | + | !width=30%|Keywords||width=70%|Description |
|- | |- | ||
|nStatementHandle||The workarea in which the gateway data source is open | |nStatementHandle||The workarea in which the gateway data source is open | ||
| Line 26: | Line 26: | ||
====Return values:==== | ====Return values:==== | ||
| − | + | ||
| − | {| class="wikitable" | + | {| class="wikitable" width=100% |
| − | !Return Value||Description | + | !width=30%|Return Value||width=70%|Description |
|- | |- | ||
|1||SQL statement was cancelled successfully | |1||SQL statement was cancelled successfully | ||
| Line 42: | Line 42: | ||
==Example== | ==Example== | ||
<code lang="recital"> | <code lang="recital"> | ||
| − | + | sqlcancel(nStathand) | |
</code> | </code> | ||
Revision as of 10:12, 7 January 2013
Purpose
Request that an executing SQL statement be cancelled
Syntax
SQLCANCEL(<nStatementHandle>)
See Also
SQLCOLUMNS(), SQLCOMMIT(), SQLCONNECT(), SQLDISCONNECT(), SQLERROR(), SQLEXEC(), SQLGETPROP(), SQLMORERESULTS(), SQLPREPARE(), SQLROLLBACK(), SQLSETPROP(), SQLSTRINGCONNECT(), SQLTABLES()
Description
The SQLCANCEL() function is used to request that an executing SQL statement be cancelled. It can be used to cancel any of the following functions when they are running in asynchronous mode:
- SQLCOLUMNS()
- SQLEXEC()
- SQLMORERESULTS()
- SQLTABLES()
The SQLCANCEL() function operates on the data source specified by <nStatementHandle>.
| Keywords | Description |
|---|---|
| nStatementHandle | The workarea in which the gateway data source is open |
Return values:
| Return Value | Description |
|---|---|
| 1 | SQL statement was cancelled successfully |
| –1 | Connection error |
| –2 | Environment error |
The SQLCANCEL() function is included for syntax compatibility only.
Example
sqlcancel(nStathand)
