Class NpgsqlParameterCollection
Represents a collection of parameters relevant to a NpgsqlCommand as well as their respective mappings to columns in a DataSet. This class cannot be inherited.
Inheritance
Implements
Namespace: Npgsql
Assembly: Npgsql.dll
Syntax
public sealed class NpgsqlParameterCollection : DbParameterCollection, IList<NpgsqlParameter>
Properties
Count
Gets the number of NpgsqlParameter objects in the collection.
Declaration
public override int Count { get; }
Property Value
Type | Description |
---|---|
System.Int32 | The number of NpgsqlParameter objects in the collection. |
IsFixedSize
Report whether the collection is fixed size. Always false.
Declaration
public override bool IsFixedSize { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsReadOnly
Report whether the collection is read only. Always false.
Declaration
public override bool IsReadOnly { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsSynchronized
Report whether the collection is synchronized.
Declaration
public override bool IsSynchronized { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
Item[Int32]
Gets the NpgsqlParameter at the specified index.
Declaration
public NpgsqlParameter this[int index] { get; set; }
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | The zero-based index of the NpgsqlParameter to retrieve. |
Property Value
Type | Description |
---|---|
NpgsqlParameter | The NpgsqlParameter at the specified index. |
Item[String]
Gets the NpgsqlParameter with the specified name.
Declaration
public NpgsqlParameter this[string parameterName] { get; set; }
Parameters
Type | Name | Description |
---|---|---|
System.String | parameterName | The name of the NpgsqlParameter to retrieve. |
Property Value
Type | Description |
---|---|
NpgsqlParameter | The NpgsqlParameter with the specified name, or a null reference if the parameter is not found. |
SyncRoot
Sync root.
Declaration
public override object SyncRoot { get; }
Property Value
Type | Description |
---|---|
System.Object |
Methods
Add(NpgsqlParameter)
Adds the specified NpgsqlParameter object to the NpgsqlParameterCollection.
Declaration
public NpgsqlParameter Add(NpgsqlParameter value)
Parameters
Type | Name | Description |
---|---|---|
NpgsqlParameter | value | The NpgsqlParameter to add to the collection. |
Returns
Type | Description |
---|---|
NpgsqlParameter | The index of the new NpgsqlParameter object. |
Add(Object)
Adds the specified NpgsqlParameter object to the NpgsqlParameterCollection.
Declaration
public override int Add(object value)
Parameters
Type | Name | Description |
---|---|---|
System.Object | value | The NpgsqlParameter to add to the collection. |
Returns
Type | Description |
---|---|
System.Int32 | The zero-based index of the new NpgsqlParameter object. |
Add(String, NpgsqlDbType)
Adds a NpgsqlParameter to the NpgsqlParameterCollection given the parameter name and the data type.
Declaration
public NpgsqlParameter Add(string parameterName, NpgsqlDbType parameterType)
Parameters
Type | Name | Description |
---|---|---|
System.String | parameterName | The name of the parameter. |
NpgsqlDbType | parameterType | One of the DbType values. |
Returns
Type | Description |
---|---|
NpgsqlParameter | The index of the new NpgsqlParameter object. |
Add(String, NpgsqlDbType, Int32)
Adds a NpgsqlParameter to the NpgsqlParameterCollection with the parameter name, the data type, and the column length.
Declaration
public NpgsqlParameter Add(string parameterName, NpgsqlDbType parameterType, int size)
Parameters
Type | Name | Description |
---|---|---|
System.String | parameterName | The name of the parameter. |
NpgsqlDbType | parameterType | One of the DbType values. |
System.Int32 | size | The length of the column. |
Returns
Type | Description |
---|---|
NpgsqlParameter | The index of the new NpgsqlParameter object. |
Add(String, NpgsqlDbType, Int32, String)
Adds a NpgsqlParameter to the NpgsqlParameterCollection with the parameter name, the data type, the column length, and the source column name.
Declaration
public NpgsqlParameter Add(string parameterName, NpgsqlDbType parameterType, int size, string sourceColumn)
Parameters
Type | Name | Description |
---|---|---|
System.String | parameterName | The name of the parameter. |
NpgsqlDbType | parameterType | One of the DbType values. |
System.Int32 | size | The length of the column. |
System.String | sourceColumn | The name of the source column. |
Returns
Type | Description |
---|---|
NpgsqlParameter | The index of the new NpgsqlParameter object. |
AddRange(Array)
Add an Array of parameters to the collection.
Declaration
public override void AddRange(Array values)
Parameters
Type | Name | Description |
---|---|---|
Array | values | Parameters to add. |
AddWithValue(NpgsqlDbType, Object)
Adds a NpgsqlParameter to the NpgsqlParameterCollection given the specified data type and value.
Declaration
public NpgsqlParameter AddWithValue(NpgsqlDbType parameterType, object value)
Parameters
Type | Name | Description |
---|---|---|
NpgsqlDbType | parameterType | One of the NpgsqlDbType values. |
System.Object | value | The Value of the NpgsqlParameter to add to the collection. |
Returns
Type | Description |
---|---|
NpgsqlParameter | The paramater that was added. |
AddWithValue(Object)
Adds a NpgsqlParameter to the NpgsqlParameterCollection given the specified value.
Declaration
public NpgsqlParameter AddWithValue(object value)
Parameters
Type | Name | Description |
---|---|---|
System.Object | value | The Value of the NpgsqlParameter to add to the collection. |
Returns
Type | Description |
---|---|
NpgsqlParameter | The paramater that was added. |
AddWithValue(String, NpgsqlDbType, Int32, Object)
Adds a NpgsqlParameter to the NpgsqlParameterCollection given the specified parameter name and value.
Declaration
public NpgsqlParameter AddWithValue(string parameterName, NpgsqlDbType parameterType, int size, object value)
Parameters
Type | Name | Description |
---|---|---|
System.String | parameterName | The name of the NpgsqlParameter. |
NpgsqlDbType | parameterType | One of the NpgsqlDbType values. |
System.Int32 | size | The length of the column. |
System.Object | value | The Value of the NpgsqlParameter to add to the collection. |
Returns
Type | Description |
---|---|
NpgsqlParameter | The paramater that was added. |
AddWithValue(String, NpgsqlDbType, Int32, String, Object)
Adds a NpgsqlParameter to the NpgsqlParameterCollection given the specified parameter name and value.
Declaration
public NpgsqlParameter AddWithValue(string parameterName, NpgsqlDbType parameterType, int size, string sourceColumn, object value)
Parameters
Type | Name | Description |
---|---|---|
System.String | parameterName | The name of the NpgsqlParameter. |
NpgsqlDbType | parameterType | One of the NpgsqlDbType values. |
System.Int32 | size | The length of the column. |
System.String | sourceColumn | The name of the source column. |
System.Object | value | The Value of the NpgsqlParameter to add to the collection. |
Returns
Type | Description |
---|---|
NpgsqlParameter | The paramater that was added. |
AddWithValue(String, NpgsqlDbType, Object)
Adds a NpgsqlParameter to the NpgsqlParameterCollection given the specified parameter name, data type and value.
Declaration
public NpgsqlParameter AddWithValue(string parameterName, NpgsqlDbType parameterType, object value)
Parameters
Type | Name | Description |
---|---|---|
System.String | parameterName | The name of the NpgsqlParameter. |
NpgsqlDbType | parameterType | One of the NpgsqlDbType values. |
System.Object | value | The Value of the NpgsqlParameter to add to the collection. |
Returns
Type | Description |
---|---|
NpgsqlParameter | The paramater that was added. |
AddWithValue(String, Object)
Adds a NpgsqlParameter to the NpgsqlParameterCollection given the specified parameter name and value.
Declaration
public NpgsqlParameter AddWithValue(string parameterName, object value)
Parameters
Type | Name | Description |
---|---|---|
System.String | parameterName | The name of the NpgsqlParameter. |
System.Object | value | The Value of the NpgsqlParameter to add to the collection. |
Returns
Type | Description |
---|---|
NpgsqlParameter | The paramater that was added. |
Clear()
Removes all items from the collection.
Declaration
public override void Clear()
Contains(NpgsqlParameter)
Report whether the specified parameter is present in the collection.
Declaration
public bool Contains(NpgsqlParameter item)
Parameters
Type | Name | Description |
---|---|---|
NpgsqlParameter | item | Parameter to find. |
Returns
Type | Description |
---|---|
System.Boolean | True if the parameter was found, otherwise false. |
Contains(Object)
Gets a value indicating whether a NpgsqlParameter exists in the collection.
Declaration
public override bool Contains(object value)
Parameters
Type | Name | Description |
---|---|---|
System.Object | value | The value of the NpgsqlParameter object to find. |
Returns
Type | Description |
---|---|
System.Boolean | true if the collection contains the NpgsqlParameter object; otherwise, false. |
Contains(String)
Gets a value indicating whether a NpgsqlParameter with the specified parameter name exists in the collection.
Declaration
public override bool Contains(string parameterName)
Parameters
Type | Name | Description |
---|---|---|
System.String | parameterName | The name of the NpgsqlParameter object to find. |
Returns
Type | Description |
---|---|
System.Boolean | true if the collection contains the parameter; otherwise, false. |
CopyTo(Array, Int32)
Copies NpgsqlParameter objects from the NpgsqlParameterCollection to the specified array.
Declaration
public override void CopyTo(Array array, int index)
Parameters
Type | Name | Description |
---|---|---|
Array | array | An |
System.Int32 | index | The starting index of the array. |
CopyTo(NpgsqlParameter[], Int32)
Convert collection to a System.Array.
Declaration
public void CopyTo(NpgsqlParameter[] array, int arrayIndex)
Parameters
Type | Name | Description |
---|---|---|
NpgsqlParameter[] | array | Destination array. |
System.Int32 | arrayIndex | Starting index in destination array. |
GetEnumerator()
Returns an enumerator that can iterate through the collection.
Declaration
public override IEnumerator GetEnumerator()
Returns
Type | Description |
---|---|
IEnumerator | An |
GetParameter(Int32)
Get parameter.
Declaration
protected override DbParameter GetParameter(int index)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index |
Returns
Type | Description |
---|---|
DbParameter |
GetParameter(String)
Get parameter.
Declaration
protected override DbParameter GetParameter(string parameterName)
Parameters
Type | Name | Description |
---|---|---|
System.String | parameterName |
Returns
Type | Description |
---|---|
DbParameter |
IndexOf(NpgsqlParameter)
Report the offset within the collection of the given parameter.
Declaration
public int IndexOf(NpgsqlParameter item)
Parameters
Type | Name | Description |
---|---|---|
NpgsqlParameter | item | Parameter to find. |
Returns
Type | Description |
---|---|
System.Int32 | Index of the parameter, or -1 if the parameter is not present. |
IndexOf(Object)
Gets the location of a NpgsqlParameter in the collection.
Declaration
public override int IndexOf(object value)
Parameters
Type | Name | Description |
---|---|---|
System.Object | value | The value of the NpgsqlParameter object to find. |
Returns
Type | Description |
---|---|
System.Int32 | The zero-based index of the NpgsqlParameter object in the collection. |
IndexOf(String)
Gets the location of the NpgsqlParameter in the collection with a specific parameter name.
Declaration
public override int IndexOf(string parameterName)
Parameters
Type | Name | Description |
---|---|---|
System.String | parameterName | The name of the NpgsqlParameter object to find. |
Returns
Type | Description |
---|---|
System.Int32 | The zero-based location of the NpgsqlParameter in the collection. |
Insert(Int32, NpgsqlParameter)
Insert the specified parameter into the collection.
Declaration
public void Insert(int index, NpgsqlParameter item)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | Index of the existing parameter before which to insert the new one. |
NpgsqlParameter | item | Parameter to insert. |
Insert(Int32, Object)
Inserts a NpgsqlParameter into the collection at the specified index.
Declaration
public override void Insert(int index, object oValue)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | The zero-based index where the parameter is to be inserted within the collection. |
System.Object | oValue | The NpgsqlParameter to add to the collection. |
Remove(NpgsqlParameter)
Remove the specified parameter from the collection.
Declaration
public bool Remove(NpgsqlParameter item)
Parameters
Type | Name | Description |
---|---|---|
NpgsqlParameter | item | Parameter to remove. |
Returns
Type | Description |
---|---|
System.Boolean | True if the parameter was found and removed, otherwise false. |
Remove(Object)
Removes the specified NpgsqlParameter from the collection.
Declaration
public override void Remove(object oValue)
Parameters
Type | Name | Description |
---|---|---|
System.Object | oValue | The NpgsqlParameter to remove from the collection. |
Remove(String)
Removes the specified NpgsqlParameter from the collection.
Declaration
public void Remove(string parameterName)
Parameters
Type | Name | Description |
---|---|---|
System.String | parameterName | The name of the NpgsqlParameter to remove from the collection. |
RemoveAt(Int32)
Removes the specified NpgsqlParameter from the collection using a specific index.
Declaration
public override void RemoveAt(int index)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | The zero-based index of the parameter. |
RemoveAt(String)
Removes the specified NpgsqlParameter from the collection using the parameter name.
Declaration
public override void RemoveAt(string parameterName)
Parameters
Type | Name | Description |
---|---|---|
System.String | parameterName | The name of the NpgsqlParameter object to retrieve. |
SetParameter(Int32, DbParameter)
Set parameter.
Declaration
protected override void SetParameter(int index, DbParameter value)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | |
DbParameter | value |
SetParameter(String, DbParameter)
Set parameter.
Declaration
protected override void SetParameter(string parameterName, DbParameter value)
Parameters
Type | Name | Description |
---|---|---|
System.String | parameterName | |
DbParameter | value |
ToArray()
Convert collection to a System.Array.
Declaration
public NpgsqlParameter[] ToArray()
Returns
Type | Description |
---|---|
NpgsqlParameter[] | NpgsqlParameter[] |
TryGetValue(String, out NpgsqlParameter)
Gets a value indicating whether a NpgsqlParameter with the specified parameter name exists in the collection.
Declaration
public bool TryGetValue(string parameterName, out NpgsqlParameter parameter)
Parameters
Type | Name | Description |
---|---|---|
System.String | parameterName | The name of the NpgsqlParameter object to find. |
NpgsqlParameter | parameter | A reference to the requested parameter is returned in this out param if it is found in the list. This value is null if the parameter is not found. |
Returns
Type | Description |
---|---|
System.Boolean | true if the collection contains the parameter and param will contain the parameter; otherwise, false. |