ADO » Objects » Parameter
The ADO Parameter object provides detailed information about a single parameter used in a stored procedure or stored query.
Parameters are used to create Parameterized Commands. These are commands that, after they have been initially defined and stored, use parameters to change some detail in the text of the command before it is executed.
Each time a Parameter object is created, it is added to a Parameters Collection associated with a specific Command object. The Command object uses the Parameters Collection to pass these parameters in and out of the stored procedures and queries.
There are four major types of parameters: input, output, input/output and return.
Properties
- Attributes
-
Syntax: long = parameterobject.Attributes
Returns a long value defining the characteristics of a Parameter object.
- Direction
-
Syntax: ParameterDirectionEnum = parameterobject.Direction
parameterobject.Direction = ParameterDirectionEnumSets or returns a ParameterDirectionEnum value that defines the type of the Parameterobject (input, output, input/output and return).
- Name
-
Syntax: string = parameterobject.Name
Name = stringSets or returns a string that is the name of the Parameter object.
- NumericScale
-
Syntax: byte = parameterobject.NumericScale
Sets or returns a byte value that is the number of digits allowed to theright of the decimal point for a numeric Field object.
- Precision
-
Syntax: byte = parameterobject.Precision
Sets or returns a byte value that is the maximum number of digits allowed in a numeric Field object.
- Size
-
Syntax: long = parameterobject.Size
parameterobject.Size = longSets or returns a long value that is the maximum size in bytes or characters of a Parameter object.
- Type
-
Syntax: DataTypeEnum = parameterobject.Type
Sets or returns a DataTypeEnum value that specifies the data type.
- Value
-
Syntax: variant = fieldobject.Value
parameterobject.Value = variantSets or returns a variant value that is the value of the Parameter object.
Methods
- AppendChunk
-
Syntax: parameterobject.AppendChunk (Data)
Used to append a large amount (i.e., a large chunk) of text or binary data to a Parameter object.
See Also:
