Difference between revisions of "SQLCANCEL()"

From Lianjapedia
Jump to: navigation, search
Line 21: Line 21:
 
!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
 
|-
 
|-
 
|}
 
|}

Revision as of 11:16, 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 Statement handle to the connection

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)