Class SoParameter
Represents a parameter to a Command object. Implements IDbDataParameter, IDataParameter
Inherited Members
Namespace: SuperOffice.Data
Assembly: SoDataBase.dll
Syntax
public class SoParameter : IDbDataParameter, IDataParameter, ICloneable
Constructors
SoParameter()
Default constructor
Declaration
public SoParameter()
SoParameter(string, DbType)
Represents a parameter to a Command object. Implements IDbDataParameter, IDataParameter
Declaration
public SoParameter(string parameterName, DbType dbType)
Parameters
Type | Name | Description |
---|---|---|
string | parameterName | The name of the parameter to map. |
DbType | dbType |
SoParameter(string, DbType, int)
Initializes a new instance of the SoParameter class.
Declaration
public SoParameter(string parameterName, DbType dbType, int size)
Parameters
Type | Name | Description |
---|---|---|
string | parameterName | The name of the parameter to map. |
DbType | dbType | Type of the db. |
int | size | The size. |
SoParameter(string, DbType, int, ParameterDirection, bool, byte, byte, string, DataRowVersion, object)
Initializes a new instance of the SoParameter class.
Declaration
public SoParameter(string parameterName, DbType dbType, int size, ParameterDirection direction, bool isNullable, byte precision, byte scale, string sourceColumn, DataRowVersion sourceVersion, object value)
Parameters
Type | Name | Description |
---|---|---|
string | parameterName | The name of the parameter to map. |
DbType | dbType | Type of the db. |
int | size | The size. |
ParameterDirection | direction | The direction. |
bool | isNullable | if set to |
byte | precision | The precision. |
byte | scale | The scale. |
string | sourceColumn | The name of the source column |
DataRowVersion | sourceVersion | The source version. |
object | value | The value. |
SoParameter(string, DbType, int, string)
Initializes a new instance of the SoParameter class.
Declaration
public SoParameter(string parameterName, DbType dbType, int size, string sourceColumn)
Parameters
Type | Name | Description |
---|---|---|
string | parameterName | The name of the parameter to map. |
DbType | dbType | Type of the db. |
int | size | The size. |
string | sourceColumn | The name of the source column |
SoParameter(string, DbType, string)
Initializes a new instance of the SoParameter class.
Declaration
public SoParameter(string parameterName, DbType dbType, string sourceColumn)
Parameters
Type | Name | Description |
---|---|---|
string | parameterName | The name of the parameter to map. |
DbType | dbType | Type of the db. |
string | sourceColumn | The name of the source column |
SoParameter(string, object)
Initializes a new instance of the SoParameter class.
Declaration
public SoParameter(string parameterName, object value)
Parameters
Type | Name | Description |
---|---|---|
string | parameterName | The name of the parameter to map. |
object | value | The value. |
Properties
DbType
Gets or sets the DbType of the parameter.
Declaration
public DbType DbType { get; set; }
Property Value
Type | Description |
---|---|
DbType |
Direction
Gets or sets a value indicating whether the parameter is input-only, output-only, bidirectional, or a stored procedure return value parameter.
Declaration
public ParameterDirection Direction { get; set; }
Property Value
Type | Description |
---|---|
ParameterDirection |
IsNullable
Gets or sets a value indicating whether the parameter accepts null values.
Declaration
public bool IsNullable { get; }
Property Value
Type | Description |
---|---|
bool |
ParameterName
Gets or sets the name of the SqlParameter.
Declaration
public string ParameterName { get; set; }
Property Value
Type | Description |
---|---|
string |
Precision
Gets or sets the maximum number of digits used to represent the Value property.
Declaration
public byte Precision { get; set; }
Property Value
Type | Description |
---|---|
byte |
Scale
Gets or sets the number of decimal places to which Value is resolved.
Declaration
public byte Scale { get; set; }
Property Value
Type | Description |
---|---|
byte |
Size
Gets or sets the maximum size, in bytes, of the data within the column.
Declaration
public int Size { get; set; }
Property Value
Type | Description |
---|---|
int |
SourceColumn
Gets or sets the name of the source column that is mapped to the DataSet and used for loading or returning the Value.
Declaration
public string SourceColumn { get; set; }
Property Value
Type | Description |
---|---|
string |
SourceVersion
Gets or sets the DataRowVersion to use when loading Value.
Declaration
public DataRowVersion SourceVersion { get; set; }
Property Value
Type | Description |
---|---|
DataRowVersion |
Value
Gets or sets the value of the parameter.
Declaration
public object Value { get; set; }
Property Value
Type | Description |
---|---|
object |
Methods
Clone()
Clone this object
Declaration
public object Clone()
Returns
Type | Description |
---|---|
object |