SQLSETPROP()

From Recital Documentation Wiki
Jump to: navigation, search

Purpose

Set property settings for a connection


Syntax

SQLSETPROP(<nStatementHandle>, <cSetting> [, <eExpression>])


See Also

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

Description

The SQLSETPROP() function is used to set the property settings for a specified connection.

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


Keywords Description
nStatementHandle The workarea in which the gateway data source is open
cSetting The property setting to set. Please see table below for available property settings
eExpression The value to be set. If this optional parameter is not specified, the property is set to its default value. Please see table below for available property settings values


Property Settings:

Setting Default Read-only Description
Asynchronous False (.F.) No Determines whether results sets are returned synchronously (.F.) or asynchronously (.T.)
BatchMode True (.T.) No Determines whether results sets are returned all at once (.T.) or one at a time using [SQLMORERESULTS()] (.F.)
ConnectBusy Yes .T. = Shared connection is busy

.F. = Shared connection is not busy

ConnectString Yes Login connection string
ConnectTimeOut 15 No Determines the time to wait before generating a connection time-out error. (0 – 600 seconds)
DataSource No Data source name as specified in ODBC.INI
DispLogin 1 No 1 = The Login dialog box is displayed if any required information is missing

2 = The Login dialog box is always displayed 3 = The Login dialog box is never displayed and an error is generated if any required information is missing

DispWarnings False (.F.) No .T. = Error messages are displayed

.F. = Error messages are not displayed

IdleTimeout 0 (Wait indefinitely) No Determines the time to wait before terminating an idle connection (seconds)
ODBChdbc Yes Internal ODBC connection handle
ODBChstmt Yes Internal ODBC connection handle
PacketSize 4K No Determines the network packet size used
Password Yes Login connection password
QueryTimeOut 0 (Wait indefinitely) No Determines the time to wait before generating a time-out error. (0 – 600 seconds)
Shared Yes .T. = Connection is shared

.F. = Connection is not shared

Transactions 1 No 1 = Automatic transaction handling

2 = Manual transaction handling using [SQLCOMMIT()] and [SQLROLLBACK()]

UserId Yes Login connection user id
WaitTime 100 milliseconds No Determines the time to wait before checking that an SQL statement has completed


Return values:

Return Value Description
1 Property setting completed successfully
–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
  nSetEnd = SQLSETPROP(nStatHand,"Transactions",2)
  if nSetEnd = 1
    dialog box [Manual Transactions Enabled]
  else
    dialog box [Unable to enable Manual Transactions]
  endif
endif


Products

Recital, Recital Server