Difference between revisions of "SQLCANCEL()"

From Lianjapedia
Jump to: navigation, search
Line 38: Line 38:
 
|}
 
|}
  
The SQLCANCEL() function is not yet implemented.
+
The SQLCANCEL() function is included for syntax compatibility only.
  
 
==Example==
 
==Example==

Revision as of 11:39, 7 December 2012

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)