Connection Properties You Can Access with SQLGETPROP()

• Microsoft Visual FoxPro for Windows, version 3.0

SUMMARY

In Visual FoxPro, you can view the current property settings for a connection by using the SQLGETPROP() command with the respective connection handle. This article lists the connection properties that can be accessed with SQLGETPROP() and shows how to use SQLGETPROP().

This information is also available under SQLSETPROP() in the Visual FoxPro Help file.

MORE INFORMATION

In Visual FoxPro, you can use SQLGETPROP() to display the information used to create the active connection, to work with shared connections, to control interface display and time intervals, and to fetch result sets into view cursors. You can also use it to ensure that active connections are deactivated after a specified time interval, to manage transactions, and to display internal ODBC handles.

SQLGETPROP() returns the current or default settings for an active connection. SQLGETPROP() returns a numeric value to describe the setting. To view the current property settings for a connection, use SQLGETPROP() with the respective connection handle using the following syntax:

   SQLGETPROP(nConnectionHandle, cSetting)

   SQLGETPROP(gnConnHandle, 'asynchronous')

The cSetting parameter specifies the setting.

Connection Properties Available

The connection properties that can be accessed with SQLGETPROP() are listed below in functional groups.

To display the information used to create the active connection:

• ConnectString The login connection string.
• DataSource The name of the data source as defined by ODBC.
• Password The connection password.
• UserID The user identification.

For more information about documentation error regarding the ConnectName property and the SQLGETPROP() function, please see the following article in the Microsoft Knowledge Base:

   ARTICLE-ID: Q137408
   TITLE     : DOCERR: Can't Use ConnectName Property w/SQLGETPROP()
               Function

• ConnectBusy True (.T.) if a shared connection is busy; false (.F.)

                     otherwise.
  
  

• DispLogin Controls when the ODBC Login dialog box is displayed.
• DispWarnings Controls whether error messages are displayed or not.

• ConnectTimeout Specifies the time (in seconds) to wait before

                     returning a connection time-out error.
  

• IdleTimeout Specifies the idle timeout interval (in seconds).

• WaitTime Controls the amount of time in milliseconds that

                     elapses before Visual FoxPro checks whether the SQL
                     statement has completed executing.
  
  

• QueryTimeout Controls the time (in seconds) to wait before returning

                     a general time-out error.
  
  

• Transactions Determines how the connection manages transactions on

                     the remote table.
  
  

• synchronous Specifies if result sets are returned synchronously

                     (the default) or asynchronously.
  

• BatchMode Specifies if SQLEXEC( ) returns result sets all at once

                     (the default), or individually with SQLMORERESULTS( ).
  
  

• ODBChdbc (2) The internal ODBC connection handle that can be used by

                     external library files (.FLL files) to call the ODBC
                     API functions.
  

• ODBChstmt (2) The internal ODBC statement handle that can be used by

                     external library files (.FLL files) to call the ODBC
                     API functions.
  
  

(2) If a connection is deactivated, the ODBChdbc and ODBChstmt values are

    no longer valid.