Difference between revisions of "SQLGETPROP()"

From Lianjapedia
Jump to: navigation, search
Line 17: Line 17:
 
!width=30%|Keywords||width=70%|Description
 
!width=30%|Keywords||width=70%|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.
+
|nStatementHandle||Statement handle to the connection.  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()]].

Revision as of 11:21, 7 January 2013

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>.

This function is not yet implemented.

Keywords Description
nStatementHandle Statement handle to the connection. 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 = sqlconnect("awhr")
if nStatHand < 1
  messagebox("Cannot make connection", 16, "SQL Connect Error")
else
  eGetProp = sqlgetprop(nStatHand,"ConnectString")
  if type("eGetProp") = "N" and eGetProp < 0
    messagebox("Error Occurred")
  else
    messagebox(etos(eGetProp))
  endif
endif