Class NpgsqlParameterCollection
Represents a collection of parameters relevant to a NpgsqlCommand as well as their respective mappings to columns in
a
Implements
Namespace: Npgsql
Assembly: Npgsql.dll
Syntax
public sealed class NpgsqlParameterCollection : DbParameterCollection, IList<NpgsqlParameter>
Properties
| Improve this Doc View SourceCount
Gets the number of NpgsqlParameter objects in the collection.
Declaration
public override int Count { get; }
Property Value
Type | Description |
---|---|
int | The number of NpgsqlParameter objects in the collection. |
IsFixedSize
Declaration
public override bool IsFixedSize { get; }
Property Value
Type | Description |
---|---|
bool |
IsReadOnly
Declaration
public override bool IsReadOnly { get; }
Property Value
Type | Description |
---|---|
bool |
IsSynchronized
Declaration
public override bool IsSynchronized { get; }
Property Value
Type | Description |
---|---|
bool |
this[int]
Gets the NpgsqlParameter at the specified index.
Declaration
public NpgsqlParameter this[int index] { get; set; }
Parameters
Type | Name | Description |
---|---|---|
int | index | The zero-based index of the NpgsqlParameter to retrieve. |
Property Value
Type | Description |
---|---|
NpgsqlParameter | The NpgsqlParameter at the specified index. |
this[string]
Gets the NpgsqlParameter with the specified name.
Declaration
public NpgsqlParameter this[string parameterName] { get; set; }
Parameters
Type | Name | Description |
---|---|---|
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
Declaration
public override object SyncRoot { get; }
Property Value
Type | Description |
---|---|
object |
Methods
| Improve this Doc View SourceAdd(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)
Declaration
public override int Add(object value)
Parameters
Type | Name | Description |
---|---|---|
object | value |
Returns
Type | Description |
---|---|
int |
Add(string, NpgsqlDbType, int, 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 |
---|---|---|
string | parameterName | The name of the parameter. |
NpgsqlDbType | parameterType | One of the |
int | size | The length of the column. |
string | sourceColumn | The name of the source column. |
Returns
Type | Description |
---|---|
NpgsqlParameter | The index of the new NpgsqlParameter object. |
Add(string, NpgsqlDbType, int)
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 |
---|---|---|
string | parameterName | The name of the parameter. |
NpgsqlDbType | parameterType | One of the |
int | size | The length of the column. |
Returns
Type | Description |
---|---|
NpgsqlParameter | The 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 |
---|---|---|
string | parameterName | The name of the parameter. |
NpgsqlDbType | parameterType | One of the |
Returns
Type | Description |
---|---|
NpgsqlParameter | The index of the new NpgsqlParameter object. |
AddRange(Array)
Declaration
public override void AddRange(Array values)
Parameters
Type | Name | Description |
---|---|---|
Array | values |
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. |
object | value | The value of the NpgsqlParameter to add to the collection. |
Returns
Type | Description |
---|---|
NpgsqlParameter | The parameter 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 |
---|---|---|
object | value | The value of the NpgsqlParameter to add to the collection. |
Returns
Type | Description |
---|---|
NpgsqlParameter | The parameter that was added. |
AddWithValue(string, NpgsqlDbType, int, 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 |
---|---|---|
string | parameterName | The name of the NpgsqlParameter. |
NpgsqlDbType | parameterType | One of the NpgsqlDbType values. |
int | size | The length of the column. |
string? | sourceColumn | The name of the source column. |
object | value | The value of the NpgsqlParameter to add to the collection. |
Returns
Type | Description |
---|---|
NpgsqlParameter | The parameter that was added. |
AddWithValue(string, NpgsqlDbType, int, 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 |
---|---|---|
string | parameterName | The name of the NpgsqlParameter. |
NpgsqlDbType | parameterType | One of the NpgsqlDbType values. |
int | size | The length of the column. |
object | value | The value of the NpgsqlParameter to add to the collection. |
Returns
Type | Description |
---|---|
NpgsqlParameter | The parameter 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 |
---|---|---|
string | parameterName | The name of the NpgsqlParameter. |
NpgsqlDbType | parameterType | One of the NpgsqlDbType values. |
object | value | The value of the NpgsqlParameter to add to the collection. |
Returns
Type | Description |
---|---|
NpgsqlParameter | The parameter 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 |
---|---|---|
string | parameterName | The name of the NpgsqlParameter. |
object | value | The value of the NpgsqlParameter to add to the collection. |
Returns
Type | Description |
---|---|
NpgsqlParameter | The parameter 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 |
---|---|
bool | True if the parameter was found, otherwise false. |
Contains(object)
Declaration
public override bool Contains(object value)
Parameters
Type | Name | Description |
---|---|---|
object | value |
Returns
Type | Description |
---|---|
bool |
Contains(string)
Declaration
public override bool Contains(string parameterName)
Parameters
Type | Name | Description |
---|---|---|
string | parameterName |
Returns
Type | Description |
---|---|
bool |
CopyTo(Array, int)
Declaration
public override void CopyTo(Array array, int index)
Parameters
Type | Name | Description |
---|---|---|
Array | array | |
int | index |
CopyTo(NpgsqlParameter[], int)
Convert collection to a System.Array.
Declaration
public void CopyTo(NpgsqlParameter[] array, int arrayIndex)
Parameters
Type | Name | Description |
---|---|---|
NpgsqlParameter[] | array | Destination array. |
int | arrayIndex | Starting index in destination array. |
GetEnumerator()
Declaration
public override IEnumerator GetEnumerator()
Returns
Type | Description |
---|---|
IEnumerator |
GetParameter(int)
Declaration
protected override DbParameter GetParameter(int index)
Parameters
Type | Name | Description |
---|---|---|
int | index |
Returns
Type | Description |
---|---|
DbParameter |
GetParameter(string)
Declaration
protected override DbParameter GetParameter(string parameterName)
Parameters
Type | Name | Description |
---|---|---|
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 |
---|---|
int | Index of the parameter, or -1 if the parameter is not present. |
IndexOf(object)
Declaration
public override int IndexOf(object value)
Parameters
Type | Name | Description |
---|---|---|
object | value |
Returns
Type | Description |
---|---|
int |
IndexOf(string)
Declaration
public override int IndexOf(string parameterName)
Parameters
Type | Name | Description |
---|---|---|
string | parameterName |
Returns
Type | Description |
---|---|
int |
Insert(int, NpgsqlParameter)
Insert the specified parameter into the collection.
Declaration
public void Insert(int index, NpgsqlParameter item)
Parameters
Type | Name | Description |
---|---|---|
int | index | Index of the existing parameter before which to insert the new one. |
NpgsqlParameter | item | Parameter to insert. |
Insert(int, object)
Declaration
public override void Insert(int index, object value)
Parameters
Type | Name | Description |
---|---|---|
int | index | |
object | value |
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 |
---|---|
bool | 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 value)
Parameters
Type | Name | Description |
---|---|---|
object | value | 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 |
---|---|---|
string | parameterName | The name of the NpgsqlParameter to remove from the collection. |
RemoveAt(int)
Removes the specified NpgsqlParameter from the collection using a specific index.
Declaration
public override void RemoveAt(int index)
Parameters
Type | Name | Description |
---|---|---|
int | index | The zero-based index of the parameter. |
RemoveAt(string)
Declaration
public override void RemoveAt(string parameterName)
Parameters
Type | Name | Description |
---|---|---|
string | parameterName |
SetParameter(int, DbParameter)
Declaration
protected override void SetParameter(int index, DbParameter value)
Parameters
Type | Name | Description |
---|---|---|
int | index | |
DbParameter | value |
SetParameter(string, DbParameter)
Declaration
protected override void SetParameter(string parameterName, DbParameter value)
Parameters
Type | Name | Description |
---|---|---|
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 |
---|---|---|
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 |
---|---|
bool | true if the collection contains the parameter and param will contain the parameter; otherwise, false. |