Difference between revisions of "SQLCANCEL()"

From Recital Documentation Wiki
Jump to: navigation, search
(Products)
Line 18: Line 18:
 
* 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>.
Line 66: Line 67:
 
[[Category:Functions]]
 
[[Category:Functions]]
 
[[Category:SQL]]
 
[[Category:SQL]]
 +
[[Category:Remote Data Connectivity Functions]]

Revision as of 11:13, 16 December 2009

Purpose

Request that an executing SQL statement be cancelled


Syntax

SQLCANCEL(<nStatementHandle>)


See Also

CREATE CONNECTION, SQLCOLUMNS(), SQLCOMMIT(), SQLCONNECT(), SQLDISCONNECT(), 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 compatibility only. Recital gateway functions do not operate in asynchronous mode.


Example

nStatHand=SQLSTRINGCONNECT("rec@rec1:user1/pass1/usr/recital/uas/data/southwind.tcpip",.T.)
if nStatHand < 1
  dialog box [Could not connect]
else
  SQLSETPROP(nStatHand, "Asynchronous", .T.)
  SQLEXEC(nStatHand, "SELECT * from example")
  SQLCANCEL(nStathand)
endif


Products

Recital, Recital Server