Difference between revisions of "SQLCANCEL()"

From Lianjapedia
Jump to: navigation, search
m (1 revision: SQL)
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
==Purpose==
 
==Purpose==
 
Request that an executing SQL statement be cancelled
 
Request that an executing SQL statement be cancelled
 
  
 
==Syntax==
 
==Syntax==
 
SQLCANCEL(<nStatementHandle>)
 
SQLCANCEL(<nStatementHandle>)
 
  
 
==See Also==
 
==See Also==
[[CREATE CONNECTION]], [[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 15:
 
* SQLMORERESULTS()
 
* SQLMORERESULTS()
 
* SQLTABLES()
 
* SQLTABLES()
 
  
 
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="30%"|Keywords||width="70%"|Description
!Keywords||Description
+
 
|-
 
|-
|nStatementHandle||The workarea in which the gateway data source is open
+
|nStatementHandle||Statement handle to the connection
 
|-
 
|-
 
|}
 
|}
  
 
+
The SQLCANCEL() function is included for syntax compatibility only.
====Return values:====
+
 
+
 
+
{| class="wikitable"
+
!Return Value||Description
+
|-
+
|1||SQL statement was cancelled successfully
+
|-
+
|&ndash;1||Connection error
+
|-
+
|&ndash;2||Environment error
+
|-
+
|}
+
 
+
 
+
The SQLCANCEL() function is included for compatibility only. Recital gateway functions do not operate in asynchronous mode.
+
 
+
  
 
==Example==
 
==Example==
 
<code lang="recital">
 
<code lang="recital">
nStatHand=SQLSTRINGCONNECT("rec@rec1:user1/pass1-/usr/recital/uas/data/southwind.tcpip",.T.)
+
sqlcancel(nStathand)
if nStatHand < 1
+
  dialog box [Could not connect]
+
else
+
  SQLSETPROP(nStatHand, "Asynchronous", .T.)
+
  SQLEXEC(nStatHand, "SELECT * from example")
+
  SQLCANCEL(nStathand)
+
endif
+
 
</code>
 
</code>
  
==Products==
 
Recital, Recital Server
 
 
[[Category:Documentation]]
 
[[Category:Documentation]]
 
[[Category:Functions]]
 
[[Category:Functions]]
 
[[Category:SQL]]
 
[[Category:SQL]]
[[Category:Remote Data Connectivity Functions]]
+
[[Category:ODBC Functions]]
 +
[[Category:SQL Functions]]

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)