A parameter for a stored procedure.

Syntax

These objects are created automatically by the stored procedure.

Properties

The following table lists the properties of the Parameter class. (No events or methods are associated with this class.) For details on each property, click on the property below.

Property

Default

Description

baseClassName

PARAMETER

Identifies the object as an instance of the Parameter class

className

(PARAMETER)

Identifies the object as an instance of a custom class. When no custom class exists, defaults to baseClassName

type

Input

The parameter type
(0=Input, 1=Output, 2=InputOutput, 3=Result)

value

 

The value of the parameter

Description

Parameter objects represent parameters to stored procedures. Each element of the params array of a StoredProc object is a Parameter object. The Parameter objects are automatically created when the procedureName property is set, either by getting the parameter names for that stored procedure from the SQL server or by using parameter names specified directly in the procedureName property.

A parameter may be one of four types, as indicated by its type property:

  1. Input: an input value for the stored procedure. The value must be set before the stored procedure is called.

A Parameter object may be assigned as the dataLink of a component in a form. Changes to the component are reflected in the value property of the Parameter object, and updates to the value property of the Parameter object are displayed in the component.