Difference between revisions of "SQLGETPROP()"

From Lianjapedia
Jump to: navigation, search
m (Text replace - "Recital" to "Lianja")
Line 1: Line 1:
 
==Purpose==
 
==Purpose==
 
Query property settings for a connection or the environment
 
Query property settings for a connection or the environment
 
  
 
==Syntax==
 
==Syntax==
 
SQLGETPROP(<nStatementHandle>, <cSetting>)
 
SQLGETPROP(<nStatementHandle>, <cSetting>)
 
  
 
==See Also==
 
==See Also==
 
[[SQLCANCEL()]], [[SQLCOLUMNS()]], [[SQLCOMMIT()]], [[SQLCONNECT()]], [[SQLDISCONNECT()]], [[SQLERROR()]], [[SQLEXEC()]], [[SQLMORERESULTS()]], [[SQLPREPARE()]], [[SQLROLLBACK()]], [[SQLSETPROP()]], [[SQLSTRINGCONNECT()]], [[SQLTABLES()]]
 
[[SQLCANCEL()]], [[SQLCOLUMNS()]], [[SQLCOMMIT()]], [[SQLCONNECT()]], [[SQLDISCONNECT()]], [[SQLERROR()]], [[SQLEXEC()]], [[SQLMORERESULTS()]], [[SQLPREPARE()]], [[SQLROLLBACK()]], [[SQLSETPROP()]], [[SQLSTRINGCONNECT()]], [[SQLTABLES()]]
 
  
 
==Description==
 
==Description==
Line 15: Line 12:
  
 
The SQLGETPROP() function operates on the data source specified by <nStatementHandle>.
 
The SQLGETPROP() function operates on the data source specified by <nStatementHandle>.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 25: Line 21:
 
|-
 
|-
 
|}
 
|}
 
  
 
====Return values:====
 
====Return values:====
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 40: Line 34:
 
|-
 
|-
 
|}
 
|}
 
  
 
==Example==
 
==Example==
Line 56: Line 49:
 
endif
 
endif
 
</code>
 
</code>
 
  
 
==Products==
 
==Products==

Revision as of 11:15, 11 December 2012

Purpose

Query property settings for a connection or the environment

Syntax

SQLGETPROP(<nStatementHandle>, <cSetting>)

See Also

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

Lianja, Lianja Server