MACROMEDIA DREAMWEAVER MX 2004-DREAMWEAVER API, Reference

Page: 106 / 486

106 Chapter 8: The Database Connectivity API
The
htmlSource
argument is the HTML source for a connection.
Returns
A connection object that provides values for a particular combination of the properties that are
listed in the following table. The properties for which this function returns a value depend on the
document type.
If a connection is not found in htmlSource, a
null
value returns.
Note: Developers can add custom properties (for example, metadata) to the HTML source, which
applyConnection()
returns along with the standard properties.
Property Description
name Name of the connection
type If
useHTTP
is
false
, indicates which DLL to use for connecting to
database at runtime
string
Runtime connection string. For ADO, it is a string of connection
parameters; for JDBC, it is a connection URL
dsn
Data source name used for ODBC or Cold Fusion runtime connections
driver
Name of a JDBC driver used at runtime
username
Name of the user for the runtime connection
password
Password used for the runtime connection
designtimeString
Design-time connection string (see
string
)
designtimeDsn
Design-time data source name (see
dsn
)
designtimeDriver
Name of a JDBC driver used at design time
designtimeUsername
Name of the user used for the design-time connection
designtimePassword
Password used for the design-time connection
designtimeType Design-time connection type
usesDesigntimeInfo When
false
, Dreamweaver uses runtime properties at design time;
otherwise, Dreamweaver uses design-time properties
useHTTP String containing either
true
or
false: true
specifies to use HTTP
connection at design time;
false
specifies to use DLL
includePattern
Regular expression used to find the file include statement on the page
during Live Data and Preview In Browser
variables
Object with a property for each page variable that is set to its
corresponding value. This object is used during Live Data and Preview
In Browser
catalog
String containing a database identifier that restricts the amount of
metadata that appears
schema String containing a database identifier that restricts the amount of
metadata that appears
filename Name of the dialog box used to create the connection
000_DW_API_Print.book Page 106 Wednesday, August 20, 2003 9:14 AM