Show / Hide Table of Contents

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
System.Object
System.MarshalByRefObject
System.Data.Common.DbParameterCollection
NpgsqlParameterCollection
Implements
System.Data.IDataParameterCollection
System.Collections.IList
System.Collections.ICollection
System.Collections.Generic.IList<NpgsqlParameter>
System.Collections.Generic.ICollection<NpgsqlParameter>
System.Collections.Generic.IEnumerable<NpgsqlParameter>
System.Collections.IEnumerable
Inherited Members
System.Data.Common.DbParameterCollection.System.Collections.IList.get_Item(System.Int32)
System.Data.Common.DbParameterCollection.System.Collections.IList.set_Item(System.Int32, System.Object)
System.Data.Common.DbParameterCollection.System.Data.IDataParameterCollection.get_Item(System.String)
System.Data.Common.DbParameterCollection.System.Data.IDataParameterCollection.set_Item(System.String, System.Object)
System.Data.Common.DbParameterCollection.System.Collections.IList.Item[System.Int32]
System.Data.Common.DbParameterCollection.System.Data.IDataParameterCollection.Item[System.String]
System.MarshalByRefObject.MemberwiseClone(System.Boolean)
System.MarshalByRefObject.GetLifetimeService()
System.MarshalByRefObject.InitializeLifetimeService()
System.MarshalByRefObject.CreateObjRef(System.Type)
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Npgsql
Assembly: Npgsql.dll
Syntax
public sealed class NpgsqlParameterCollection : DbParameterCollection, IDataParameterCollection, IList, ICollection, IList<NpgsqlParameter>, ICollection<NpgsqlParameter>, IEnumerable<NpgsqlParameter>, IEnumerable

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.

Overrides
System.Data.Common.DbParameterCollection.Count

IsFixedSize

Declaration
public override bool IsFixedSize { get; }
Property Value
Type Description
System.Boolean
Overrides
System.Data.Common.DbParameterCollection.IsFixedSize

IsReadOnly

Declaration
public override bool IsReadOnly { get; }
Property Value
Type Description
System.Boolean
Overrides
System.Data.Common.DbParameterCollection.IsReadOnly

IsSynchronized

Declaration
public override bool IsSynchronized { get; }
Property Value
Type Description
System.Boolean
Overrides
System.Data.Common.DbParameterCollection.IsSynchronized

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

Declaration
public override object SyncRoot { get; }
Property Value
Type Description
System.Object
Overrides
System.Data.Common.DbParameterCollection.SyncRoot

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)

Declaration
public override int Add(object value)
Parameters
Type Name Description
System.Object value
Returns
Type Description
System.Int32
Overrides
System.Data.Common.DbParameterCollection.Add(System.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)

Declaration
public override void AddRange(Array values)
Parameters
Type Name Description
System.Array values
Overrides
System.Data.Common.DbParameterCollection.AddRange(System.Array)

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()
Overrides
System.Data.Common.DbParameterCollection.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)

Declaration
public override bool Contains(object value)
Parameters
Type Name Description
System.Object value
Returns
Type Description
System.Boolean
Overrides
System.Data.Common.DbParameterCollection.Contains(System.Object)

Contains(String)

Declaration
public override bool Contains(string parameterName)
Parameters
Type Name Description
System.String parameterName
Returns
Type Description
System.Boolean
Overrides
System.Data.Common.DbParameterCollection.Contains(System.String)

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.

CopyTo(Array, Int32)

Declaration
public override void CopyTo(Array array, int index)
Parameters
Type Name Description
System.Array array
System.Int32 index
Overrides
System.Data.Common.DbParameterCollection.CopyTo(System.Array, System.Int32)

GetEnumerator()

Declaration
public override IEnumerator GetEnumerator()
Returns
Type Description
System.Collections.IEnumerator
Overrides
System.Data.Common.DbParameterCollection.GetEnumerator()

GetParameter(Int32)

Declaration
protected override DbParameter GetParameter(int index)
Parameters
Type Name Description
System.Int32 index
Returns
Type Description
System.Data.Common.DbParameter
Overrides
System.Data.Common.DbParameterCollection.GetParameter(System.Int32)

GetParameter(String)

Declaration
protected override DbParameter GetParameter(string parameterName)
Parameters
Type Name Description
System.String parameterName
Returns
Type Description
System.Data.Common.DbParameter
Overrides
System.Data.Common.DbParameterCollection.GetParameter(System.String)

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)

Declaration
public override int IndexOf(object value)
Parameters
Type Name Description
System.Object value
Returns
Type Description
System.Int32
Overrides
System.Data.Common.DbParameterCollection.IndexOf(System.Object)

IndexOf(String)

Declaration
public override int IndexOf(string parameterName)
Parameters
Type Name Description
System.String parameterName
Returns
Type Description
System.Int32
Overrides
System.Data.Common.DbParameterCollection.IndexOf(System.String)

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)

Declaration
public override void Insert(int index, object value)
Parameters
Type Name Description
System.Int32 index
System.Object value
Overrides
System.Data.Common.DbParameterCollection.Insert(System.Int32, System.Object)

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 value)
Parameters
Type Name Description
System.Object value

The NpgsqlParameter to remove from the collection.

Overrides
System.Data.Common.DbParameterCollection.Remove(System.Object)

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.

Overrides
System.Data.Common.DbParameterCollection.RemoveAt(System.Int32)

RemoveAt(String)

Declaration
public override void RemoveAt(string parameterName)
Parameters
Type Name Description
System.String parameterName
Overrides
System.Data.Common.DbParameterCollection.RemoveAt(System.String)

SetParameter(Int32, DbParameter)

Declaration
protected override void SetParameter(int index, DbParameter value)
Parameters
Type Name Description
System.Int32 index
System.Data.Common.DbParameter value
Overrides
System.Data.Common.DbParameterCollection.SetParameter(System.Int32, System.Data.Common.DbParameter)

SetParameter(String, DbParameter)

Declaration
protected override void SetParameter(string parameterName, DbParameter value)
Parameters
Type Name Description
System.String parameterName
System.Data.Common.DbParameter value
Overrides
System.Data.Common.DbParameterCollection.SetParameter(System.String, System.Data.Common.DbParameter)

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.

Explicit Interface Implementations

ICollection<NpgsqlParameter>.Add(NpgsqlParameter)

Declaration
void ICollection<NpgsqlParameter>.Add(NpgsqlParameter item)
Parameters
Type Name Description
NpgsqlParameter item

ICollection<NpgsqlParameter>.IsReadOnly

Declaration
bool ICollection<NpgsqlParameter>.IsReadOnly { get; }
Returns
Type Description
System.Boolean

IEnumerable<NpgsqlParameter>.GetEnumerator()

Declaration
IEnumerator<NpgsqlParameter> IEnumerable<NpgsqlParameter>.GetEnumerator()
Returns
Type Description
System.Collections.Generic.IEnumerator<NpgsqlParameter>

Implements

System.Data.IDataParameterCollection
System.Collections.IList
System.Collections.ICollection
System.Collections.Generic.IList<T>
System.Collections.Generic.ICollection<T>
System.Collections.Generic.IEnumerable<T>
System.Collections.IEnumerable
In This Article
Back to top Generated by DocFX