C# Class Tiraggo.Interfaces.tgParameters

Inheritance: IEnumerable
Show file Open project: BrewDawg/Tiraggo Class Usage Examples

Public Methods

Method Description
Add ( string name, object value ) : tgParameter

This is the preferred overload for adding parameters.

Do not add prefixes such as @ or ? or : as the providers append the proper prefix. This allows you to pass parameters in a provider independent fashion. All parameters added via this method are input parameters.

Add ( string name, object value, tgParameterDirection direction ) : tgParameter

This should ONLY be used for parameters other than input parameters.
Add ( string name, object value, tgParameterDirection direction, DbType type, int size ) : tgParameter

This should ONLY be used for parameters other than input parameters.
Add ( string name, tgParameterDirection direction ) : tgParameter

If you need to add a parameter with an tgParameterDirection other than Input use this method.
Add ( string name, tgParameterDirection direction, DbType type, int size ) : tgParameter

This should ONLY be used for parameters other than input parameters.
Add ( tgParameter parameter ) : tgParameter

GetEnumerator ( ) : IEnumerator
tgParameters ( ) : System
this ( string name ) : tgParameter

Use this method to fetch a given tgParameter by name. There should be no prefix such as @, ? or : in the name.

Private Methods

Method Description
Merge ( tgParameters parms ) : void

Used Internally to merge parameters returned by the provider back into the original collection.

Method Details

Add() public method

This is the preferred overload for adding parameters.
Do not add prefixes such as @ or ? or : as the providers append the proper prefix. This allows you to pass parameters in a provider independent fashion. All parameters added via this method are input parameters.
public Add ( string name, object value ) : tgParameter
name string The name of the parameter without a prefix, for example, "EmployeeID" not "@EmployeeID".
value object The value of the parameter
return tgParameter

Add() public method

This should ONLY be used for parameters other than input parameters.
public Add ( string name, object value, tgParameterDirection direction ) : tgParameter
name string The name of the parameter without a prefix, for example, "EmployeeID" not "@EmployeeID".
value object The value of the parameter
direction tgParameterDirection The parameter direction
return tgParameter

Add() public method

This should ONLY be used for parameters other than input parameters.
public Add ( string name, object value, tgParameterDirection direction, DbType type, int size ) : tgParameter
name string The name of the parameter without a prefix, for example, "EmployeeID" not "@EmployeeID".
value object The value of the parameter
direction tgParameterDirection The parameter direction
type DbType The System.Data.DbType of the parameter
size int The size. For strings the length, for most others 0 can be passed in
return tgParameter

Add() public method

If you need to add a parameter with an tgParameterDirection other than Input use this method.
public Add ( string name, tgParameterDirection direction ) : tgParameter
name string The name of the parameter without a prefix, for example, "EmployeeID" not "@EmployeeID".
direction tgParameterDirection The parameter direction
return tgParameter

Add() public method

This should ONLY be used for parameters other than input parameters.
public Add ( string name, tgParameterDirection direction, DbType type, int size ) : tgParameter
name string The name of the parameter without a prefix, for example, "EmployeeID" not "@EmployeeID".
direction tgParameterDirection The parameter direction
type DbType The System.Data.DbType of the parameter
size int The size. For strings the length, for most others 0 can be passed in
return tgParameter

Add() public method

public Add ( tgParameter parameter ) : tgParameter
parameter tgParameter An already created tgParameter. This is mostly used internally.
return tgParameter

GetEnumerator() public method

public GetEnumerator ( ) : IEnumerator
return IEnumerator

tgParameters() public method

public tgParameters ( ) : System
return System

this() public method

Use this method to fetch a given tgParameter by name. There should be no prefix such as @, ? or : in the name.
public this ( string name ) : tgParameter
name string The name of the parameter without a prefix, for example, "EmployeeID" not "@EmployeeID".
return tgParameter