Class CqlParameterCollection
Represents a collection of CqlParameters.
Inheritance
Implements
Inherited Members
Namespace: Dse.Data
Assembly: Dse.dll
Syntax
public class CqlParameterCollection : DbParameterCollection, IDataParameterCollection, IList, ICollection, IEnumerable
Properties
Count
Specifies the number of items in the collection.
Declaration
public override int Count { get; }
Property Value
Type | Description |
---|---|
System.Int32 | The number of items in the collection. |
Overrides
IsFixedSize
Specifies whether the collection is a fixed size.
Declaration
public override bool IsFixedSize { get; }
Property Value
Type | Description |
---|---|
System.Boolean | true if the collection is a fixed size; otherwise false. |
Overrides
IsReadOnly
Specifies whether the collection is read-only.
Declaration
public override bool IsReadOnly { get; }
Property Value
Type | Description |
---|---|
System.Boolean | true if the collection is read-only; otherwise false. |
Overrides
IsSynchronized
Specifies whether the collection is synchronized.
Declaration
public override bool IsSynchronized { get; }
Property Value
Type | Description |
---|---|
System.Boolean | true if the collection is synchronized; otherwise false. |
Overrides
SyncRoot
Specifies the System.Object to be used to synchronize access to the collection.
Declaration
public override object SyncRoot { get; }
Property Value
Type | Description |
---|---|
System.Object | A System.Object to be used to synchronize access to the System.Data.Common.DbParameterCollection. |
Overrides
Methods
Add(CqlParameter)
Adds the specified parameter.
Declaration
public int Add(CqlParameter parameter)
Parameters
Type | Name | Description |
---|---|---|
CqlParameter | parameter | The parameter. |
Returns
Type | Description |
---|---|
System.Int32 |
Add(Object)
Adds the specified System.Data.Common.DbParameter object to the System.Data.Common.DbParameterCollection.
Declaration
public override int Add(object value)
Parameters
Type | Name | Description |
---|---|---|
System.Object | value | The System.Data.Common.DbParameter.Value of the System.Data.Common.DbParameter to add to the collection. |
Returns
Type | Description |
---|---|
System.Int32 | The index of the System.Data.Common.DbParameter object in the collection. |
Overrides
Add(String, Object)
Adds a new parameter with the specified name and value. The name will be parsed to extract table and keyspace information (if any). The parameter type will be guessed from the object value.
Declaration
public CqlParameter Add(string name, object value)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | The name. |
System.Object | value | The value. |
Returns
Type | Description |
---|---|
CqlParameter | The created CqlParameter. |
AddRange(Array)
Adds an array of items with the specified values to the System.Data.Common.DbParameterCollection.
Declaration
public override void AddRange(Array values)
Parameters
Type | Name | Description |
---|---|---|
System.Array | values | An array of values of type System.Data.Common.DbParameter to add to the collection. |
Overrides
Clear()
Removes all System.Data.Common.DbParameter values from the System.Data.Common.DbParameterCollection.
Declaration
public override void Clear()
Overrides
Contains(Object)
Indicates whether a System.Data.Common.DbParameter with the specified System.Data.Common.DbParameter.Value is contained in the collection.
Declaration
public override bool Contains(object value)
Parameters
Type | Name | Description |
---|---|---|
System.Object | value | The System.Data.Common.DbParameter.Value of the System.Data.Common.DbParameter to look for in the collection. |
Returns
Type | Description |
---|---|
System.Boolean | true if the System.Data.Common.DbParameter is in the collection; otherwise false. |
Overrides
Contains(String)
Indicates whether a System.Data.Common.DbParameter with the specified name exists in the collection.
Declaration
public override bool Contains(string value)
Parameters
Type | Name | Description |
---|---|---|
System.String | value | The name of the System.Data.Common.DbParameter to look for in the collection. |
Returns
Type | Description |
---|---|
System.Boolean | true if the System.Data.Common.DbParameter is in the collection; otherwise false. |
Overrides
CopyTo(Array, Int32)
Copies an array of items to the collection starting at the specified index.
Declaration
public override void CopyTo(Array array, int index)
Parameters
Type | Name | Description |
---|---|---|
System.Array | array | The array of items to copy to the collection. |
System.Int32 | index | The index in the collection to copy the items. |
Overrides
GetEnumerator()
Exposes the System.Collections.IEnumerable.GetEnumerator() method, which supports a simple iteration over a collection by a .NET Framework data provider.
Declaration
public override IEnumerator GetEnumerator()
Returns
Type | Description |
---|---|
System.Collections.IEnumerator | An System.Collections.IEnumerator that can be used to iterate through the collection. |
Overrides
GetParameter(Int32)
Returns the System.Data.Common.DbParameter object at the specified index in the collection.
Declaration
protected override DbParameter GetParameter(int index)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | The index of the System.Data.Common.DbParameterin the collection. |
Returns
Type | Description |
---|---|
System.Data.Common.DbParameter | The System.Data.Common.DbParameter object at the specified index in the collection. |
Overrides
GetParameter(String)
Returns System.Data.Common.DbParameter the object with the specified name.
Declaration
protected override DbParameter GetParameter(string parameterName)
Parameters
Type | Name | Description |
---|---|---|
System.String | parameterName | The name of the System.Data.Common.DbParameter in the collection. |
Returns
Type | Description |
---|---|
System.Data.Common.DbParameter | The System.Data.Common.DbParameter the object with the specified name. |
Overrides
IndexOf(Object)
Returns the index of the specified System.Data.Common.DbParameter object.
Declaration
public override int IndexOf(object value)
Parameters
Type | Name | Description |
---|---|---|
System.Object | value | The System.Data.Common.DbParameter object in the collection. |
Returns
Type | Description |
---|---|
System.Int32 | The index of the specified System.Data.Common.DbParameter object. |
Overrides
IndexOf(String)
Returns the index of the System.Data.Common.DbParameter object with the specified name.
Declaration
public override int IndexOf(string parameterName)
Parameters
Type | Name | Description |
---|---|---|
System.String | parameterName |
Returns
Type | Description |
---|---|
System.Int32 | The name of the System.Data.Common.DbParameter object in the collection. The index of the System.Data.Common.DbParameter object with the specified name. |
Overrides
Insert(Int32, Object)
Inserts the specified index of the System.Data.Common.DbParameter object with the specified name into the collection at the specified index.
Declaration
public override void Insert(int index, object value)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | The index at which to insert the System.Data.Common.DbParameter object. |
System.Object | value | The System.Data.Common.DbParameter object to insert into the collection. |
Overrides
Remove(Object)
Removes the specified System.Data.Common.DbParameter object from the collection.
Declaration
public override void Remove(object value)
Parameters
Type | Name | Description |
---|---|---|
System.Object | value | The System.Data.Common.DbParameter object to remove. |
Overrides
RemoveAt(Int32)
Removes the System.Data.Common.DbParameter object at the specified from the collection.
Declaration
public override void RemoveAt(int index)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | The index where the System.Data.Common.DbParameter object is located. |
Overrides
RemoveAt(String)
Removes the System.Data.Common.DbParameter object with the specified name from the collection.
Declaration
public override void RemoveAt(string parameterName)
Parameters
Type | Name | Description |
---|---|---|
System.String | parameterName | The name of the System.Data.Common.DbParameter object to remove. |
Overrides
SetParameter(Int32, DbParameter)
Sets the System.Data.Common.DbParameter object at the specified index to a new value.
Declaration
protected override void SetParameter(int index, DbParameter value)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | The index where the System.Data.Common.DbParameter objectis located. |
System.Data.Common.DbParameter | value | The new System.Data.Common.DbParameter value. |
Overrides
SetParameter(String, DbParameter)
Sets the System.Data.Common.DbParameter object with the specified name to a new value.
Declaration
protected override void SetParameter(string parameterName, DbParameter value)
Parameters
Type | Name | Description |
---|---|---|
System.String | parameterName | The name of the System.Data.Common.DbParameter object in the collection. |
System.Data.Common.DbParameter | value | The new System.Data.Common.DbParameter value. |