View source for SQLDISCONNECT()

==Purpose==
Disconnect from a data source


==Syntax==
SQLDISCONNECT(<nStatementHandle>)


==See Also==
[[CREATE CONNECTION]], [[SQLCANCEL()]], [[SQLCOLUMNS()]], [[SQLCOMMIT()]], [[SQLCONNECT()]], [[SQLEXEC()]], [[SQLGETPROP()]], [[SQLMORERESULTS()]], [[SQLPREPARE()]], [[SQLROLLBACK()]], [[SQLSETPROP()]], [[SQLSTRINGCONNECT()]], [[SQLTABLES()]]


==Description==
The SQLDISCONNECT() function is used to disconnect from a data source.

The SQLDISCONNECT() function operates on the data source specified by <nStatementHandle>.


{| class="wikitable"
!Keywords||Description
|-
|nStatementHandle||The workarea in which the gateway data source is open.  Specifying 0 causes all active connections to be disconnected.
|-
|}


====Return values:====


{| class="wikitable"
!Return Value||Description
|-
|1||Disconnection completed successfully
|-
|&ndash;1||Connection error
|-
|&ndash;2||Environment error
|-
|}


==Example==
<code lang="recital">
nStatHand=SQLSTRINGCONNECT("mysql@linux1:user1/pass1-database1.tcpip",.T.)
if nStatHand < 1
  dialog box [Could not connect]
else
  dialog box [Connected]
  SQLDISCONNECT(nStatHand)
endif
</code>


==Products==
Recital, Recital Server
[[Category:Documentation]]
[[Category:Functions]]
[[Category:SQL]]