Difference between revisions of "SQLGETPROP()"

From Recital Documentation Wiki
Jump to: navigation, search
 
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
=SQLGETPROP()=
 
 
 
==Class==
 
SQL Applications
 
 
 
 
==Purpose==
 
==Purpose==
 
Query property settings for a connection or the environment
 
Query property settings for a connection or the environment
Line 15: Line 8:
  
 
==See Also==
 
==See Also==
[[CREATE CONNECTION]], [[SQLCANCEL()]], [[[SQLCOLUMNS()]]], [[SQLCOMMIT()]], [[SQLCONNECT()]], [[SQLDISCONNECT()]], [[SQLEXEC()]], [[SQLMORERESULTS()]], [[SQLPREPARE()]], [[SQLROLLBACK()]], [[SQLSETPROP()]], [[SQLSTRINGCONNECT()]], [[SQLTABLES()]]
+
[[CREATE CONNECTION]], [[SQLCANCEL()]], [[SQLCOLUMNS()]], [[SQLCOMMIT()]], [[SQLCONNECT()]], [[SQLDISCONNECT()]], [[SQLERROR()]], [[SQLEXEC()]], [[SQLMORERESULTS()]], [[SQLPREPARE()]], [[SQLROLLBACK()]], [[SQLSETPROP()]], [[SQLSTRINGCONNECT()]], [[SQLTABLES()]]
  
  
Line 29: Line 22:
 
|nStatementHandle||The workarea in which the gateway data source is open.  Specifying 0 causes the SQLGETPROP() function to return the property setting for the environment.
 
|nStatementHandle||The workarea in which the gateway data source is open.  Specifying 0 causes the SQLGETPROP() function to return the property setting for the environment.
 
|-
 
|-
|cSetting||The property setting to query.  For available property settings, please see [SQLSETPROP()].
+
|cSetting||The property setting to query.  For available property settings, please see [[SQLSETPROP()]].
 
|-
 
|-
 
|}
 
|}
Line 66: Line 59:
  
 
==Products==
 
==Products==
Recital Database Server, Recital Mirage Server, Recital Terminal Developer
+
Recital, Recital Server
 
[[Category:Documentation]]
 
[[Category:Documentation]]
 
[[Category:Functions]]
 
[[Category:Functions]]
 
[[Category:SQL]]
 
[[Category:SQL]]
 +
[[Category:Remote Data Connectivity Functions]]

Latest revision as of 16:14, 4 July 2011

Purpose

Query property settings for a connection or the environment


Syntax

SQLGETPROP(<nStatementHandle>, <cSetting>)


See Also

CREATE CONNECTION, SQLCANCEL(), SQLCOLUMNS(), SQLCOMMIT(), SQLCONNECT(), SQLDISCONNECT(), SQLERROR(), SQLEXEC(), SQLMORERESULTS(), SQLPREPARE(), SQLROLLBACK(), SQLSETPROP(), SQLSTRINGCONNECT(), SQLTABLES()


Description

The SQLGETPROP() function is used to query the property settings for a specified connection or for the current environment.

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


Keywords Description
nStatementHandle The workarea in which the gateway data source is open. Specifying 0 causes the SQLGETPROP() function to return the property setting for the environment.
cSetting The property setting to query. For available property settings, please see SQLSETPROP().


Return values:

Return Value Description
<expression> The queried property setting
–1 Connection error
–2 Environment error


Example

nStatHand = SQLSTRINGCONNECT("mysql@linux1:user1/pass1-database1.tcpip",.T.)
if nStatHand < 1
  dialog box [Could not connect]
else
  eGetProp = SQLGETPROP(nStatHand,"ConnectString")
  if type("eGetProp") = "N" and eGetProp < 0
    dialog box [Error Occurred]
  else
    dialog box etos(eGetProp)
  endif
endif


Products

Recital, Recital Server