The Generated Include File - Adobe 38040334 - Dreamweaver CS3 User Manual

DREAMWEAVER CS3 75
API Reference
Description
Dreamweaver calls this function to initialize the dialog box data for defining a connection when the user edits an
existing connection. This process lets Dreamweaver populate the dialog box with the appropriate connection infor-
mation.
Argument
parameters
The argument is the same object that the function returns.
parameters findConnection()
Returns
Nothing.
applyConnection()
Availability
Dreamweaver UltraDev 4.
Description
Dreamweaver calls this function when the user clicks OK in the connection dialog box. The
applyConnection()
function generates the HTML source for a connection. Dreamweaver writes the HTML to the Configu-
ration/Connections/connection-name.ext include file, where connection-name is the name of your connection
(see "Create the layout for the connection dialog box. " on page 71), and .ext is the default extension that is associated
with the server model.
Arguments
None.
Returns
The HTML source for a connection. Dreamweaver also closes the connection dialog box. If a field validation error
occurs, displays an error message and returns an empty string to indicate that the dialog box
applyConnection()
should remain open.

The generated include file

The include file that generates declares all the properties of a connection.The filename for the
applyConnection()
include file is the connection name and has the file extension that is defined for the server model associated with the
current site.
Note: Connections are shared, so set the
to . This ensures that the connection file is
allowMultiple value false
included in the document only once and that the server script remains in the page if any other server behaviors use it.
The following sections illustrate some sample include files that generates for various default
applyConnection()
server models.
Note: To create a new connection include file format, you need to define a new EDML mapping file, which should be
similar to connection_includefile.edml, as shown in "The definition file for your connection type" on page 77.