Difference between revisions of "SQLCANCEL()"

From Lianjapedia
Jump to: navigation, search
 
(3 intermediate revisions by one other user not shown)
Line 6: Line 6:
  
 
==See Also==
 
==See Also==
[[SQLCOLUMNS()]], [[SQLCOMMIT()]], [[SQLCONNECT()]], [[SQLDISCONNECT()]], [[SQLERROR()]], [[SQLEXEC()]], [[SQLGETPROP()]], [[SQLMORERESULTS()]], [[SQLPREPARE()]], [[SQLROLLBACK()]], [[SQLSETPROP()]], [[SQLSTRINGCONNECT()]], [[SQLTABLES()]]
+
[[SQLCOLUMNS()]], [[SQLCOMMIT()]], [[SQLCONNECT()]], [[SQLDISCONNECT()]], [[SQLERROR()]], [[SQLEXEC()]], [[SQLGETPROP()]], [[SQLMORERESULTS()]], [[SQLPREPARE()]], [[SQLROLLBACK()]], [[SQLSETPROP()]], [[SQLSTRINGCONNECT()]], [[SQLTABLES()]], [[SQLTRANSACTION()]]
  
 
==Description==
 
==Description==
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" width=100%
+
{| class="wikitable" width="100%"
!width=30%|Keywords||width=70%|Description
+
!width="30%"|Keywords||width="70%"|Description
 
|-
 
|-
|nStatementHandle||The workarea in which the gateway data source is open
+
|nStatementHandle||Statement handle to the connection
|-
+
|}
+
 
+
====Return values:====
+
+
{| class="wikitable" width=100%
+
!width=30%|Return Value||width=70%|Description
+
|-
+
|1||SQL statement was cancelled successfully
+
|-
+
|&ndash;1||Connection error
+
|-
+
|&ndash;2||Environment error
+
 
|-
 
|-
 
|}
 
|}

Latest revision as of 10:12, 31 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(), SQLTRANSACTION()

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 Statement handle to the connection

The SQLCANCEL() function is included for syntax compatibility only.

Example

sqlcancel(nStathand)