MMDB.getProcedures()

Availability

Dreamweaver MX.

Description

This function returns an array of procedure objects that are associated with a named connection.

Arguments

connName

The connName argument is a connection name that is specified in the Connection Manager. It identifies the connection string that Dreamweaver should use to make a database connection to a live data source.

Returns

An array of procedure objects where each procedure object has the following set of three properties:

Property Name Description

Property Name	Description
schema*	Name of the schema that is associated with the object. This property identifies the user that is associated with the stored procedure in the SQL database that the `getProcedures()` function accesses. The database that this function accesses depends on the type of connection. For ODBC connections, the ODBC data source defines the database. The DSN is specified by the `dsn` property in the connection object (`connName`) that you pass to the `getProcedures()` function. For OLE DB connections, the connection string names the database.
catalog	Name of the catalog that is associated with the object (owner qualifier). The value of the `catalog` property is defined by an attribute of the OLE DB driver. This driver attribute defines a default `user.database` property to use when the OLE DB connection string does not specify a database.
procedure	Name of the procedure.

schema*

Name of the schema that is associated with the object.

This property identifies the user that is associated with the stored procedure in the SQL database that the getProcedures() function accesses. The database that this function accesses depends on the type of connection.

For ODBC connections, the ODBC data source defines the database. The DSN is specified by the dsn property in the connection object (connName) that you pass to the getProcedures() function.
For OLE DB connections, the connection string names the database.

catalog

Name of the catalog that is associated with the object (owner qualifier).

The value of the catalog property is defined by an attribute of the OLE DB driver. This driver attribute defines a default user.database property to use when the OLE DB connection string does not specify a database.

procedure

Name of the procedure.

*Dreamweaver connects to and gets all the tables in the database whenever you modify a recordset. If the database has many tables, Dreamweaver might take a long time to retrieve them on certain systems. If your database contains a schema or catalog, you can use the schema or catalog to restrict the number of database items Dreamweaver gets at design time. You must first create a schema or catalog in your database application before you can apply it in Dreamweaver. Consult your database documentation or your system administrator.

Example

The following code gets a list of procedures:

var procObjects      = MMDB.getProcedures(connectionName);
for (i = 0; i < procObjects.length; i++)
{
  var thisProcedure = procObjects[i]
  thisSchema =  Trim(thisProcedure.schema)
  if (thisSchema.length == 0)
  {
   thisSchema = Trim(thisProcedure.catalog)
  }
  if (thisSchema.length > 0)
  {
   thisSchema += "."
  }

  var procName = String(thisSchema + thisProcedure.procedure);
 }

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/dreamweaver/8/apiref/07_mmd37.htm