ULParameter class

Represents a parameter to a ULCommand.

Visual Basic syntax

Public NotInheritable Class ULParameter
    Inherits System.Data.Common.DbParameter
    Implements System.ICloneable

C# syntax

public sealed class ULParameter : 
    System.Data.Common.DbParameter, 
    System.ICloneable

Members

All members of ULParameter class, including all inherited members.

Name	Description
ULParameter constructor	Initializes a ULParameter object with null (Nothing in Visual Basic) as its value.
ResetDbType method	This method is not supported in UltraLite.NET.
ToString method	Returns the string representation of this instance.
DbType property	Specifies the System.Data.DbType of the parameter
Direction property	A value indicating whether the parameter is input-only, output-only, bidirectional, or a stored procedure return value parameter.
IsNullable property	Specifies whether the parameter accepts null values.
Offset property	Specifies the offset to the ULParameter.Value.
ParameterName property	Specifies the name of the parameter.
Precision property	Specifies the maximum number of digits used to represent the ULParameter.Value.
Scale property	Specifies the number of decimal places to which ULParameter.Value is resolved.
Size property	Specifies the maximum size of the data within the column.
SourceColumn property	Specifies the name of the source column mapped to the DataSet and used for loading or returning the value.
SourceColumnNullMapping property	Specifies whether the source column is nullable.
SourceVersion property	The System.Data.DataRowVersion to use when loading ULParameter.Value.
ULDbType property	Specifies the iAnywhere.Data.UltraLite.ULDbType of the parameter
Value property	Specifies the value of the parameter.

A ULParameter object can be created directly using one of its many constructors, or using the ULCommand.CreateParameter method. Because of the special treatment of the 0 and 0.0 constants and the way overloaded methods are resolved, it is highly recommended that you explicitly cast constant values to type object when using the ULParameter(string,object) constructor. For example:

' Visual Basic
Dim p As ULParameter = New ULParameter( "", CType( 0, Object ) )

The following code is the C# language equivalent:

// C#
ULParameter p = new ULParameter( "", (object)0 );

Parameters (including those created by ULCommand.CreateParameter) must be added to a ULCommand.Parameters collection to be used. All parameters are treated as positional parameters and are used by a command in the order that they were added.

In UltraLite.NET, parameters can only be used as IN parameters and all mapping information is ignored. Only the ULParameter.Value is important.