Show / Hide Table of Contents

Class DeephavenParameterCollection

A collection of parameters relevant to a DeephavenCommand.

Inheritance
System.Object
DeephavenParameterCollection
Implements
IList<DeephavenParameter>
Namespace: Deephaven.Connector
Assembly: Deephaven.Connector.dll
Syntax
public class DeephavenParameterCollection : DbParameterCollection, IList<DeephavenParameter>

Properties

Count

Gets the number of DeephavenParameter objects in the collection.

Declaration
public override int Count { get; }
Property Value
Type Description
System.Int32

The number of DeephavenParameter objects in the collection.

IsFixedSize

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

IsReadOnly

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

IsSynchronized

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

Item[Int32]

Gets the DeephavenParameter at the specified index.

Declaration
public DeephavenParameter this[int index] { get; set; }
Parameters
Type Name Description
System.Int32 index

The zero-based index of the DeephavenParameter to retrieve.

Property Value
Type Description
DeephavenParameter

The DeephavenParameter at the specified index.

Item[String]

Gets the DeephavenParameter with the specified name.

Declaration
public DeephavenParameter this[string parameterName] { get; set; }
Parameters
Type Name Description
System.String parameterName

The name of the DeephavenParameter to retrieve.

Property Value
Type Description
DeephavenParameter

The DeephavenParameter 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

Methods

Add(DeephavenParameter)

Adds the specified DeephavenParameter object to the DeephavenParameterCollection.

Declaration
public DeephavenParameter Add(DeephavenParameter value)
Parameters
Type Name Description
DeephavenParameter value

The DeephavenParameter to add to the collection.

Returns
Type Description
DeephavenParameter

The index of the new DeephavenParameter object.

Add(Object)

Declaration
public override int Add(object value)
Parameters
Type Name Description
System.Object value
Returns
Type Description
System.Int32

AddRange(Array)

Declaration
public override void AddRange(Array values)
Parameters
Type Name Description
Array values

AddWithValue(String, Object)

Adds a DeephavenParameter to the DeephavenParameterCollection given the specified parameter name and value.

Declaration
public DeephavenParameter AddWithValue(string parameterName, object value)
Parameters
Type Name Description
System.String parameterName

The name of the DeephavenParameter.

System.Object value

The Value of the DeephavenParameter to add to the collection.

Returns
Type Description
DeephavenParameter

The paramater that was added.

Clear()

Removes all items from the collection.

Declaration
public override void Clear()

Contains(DeephavenParameter)

Report whether the specified parameter is present in the collection.

Declaration
public bool Contains(DeephavenParameter item)
Parameters
Type Name Description
DeephavenParameter 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

Contains(String)

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

CopyTo(Array, Int32)

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

CopyTo(DeephavenParameter[], Int32)

Convert collection to a System.Array.

Declaration
public void CopyTo(DeephavenParameter[] array, int arrayIndex)
Parameters
Type Name Description
DeephavenParameter[] array

Destination array.

System.Int32 arrayIndex

Starting index in destination array.

GetEnumerator()

Declaration
public override IEnumerator GetEnumerator()
Returns
Type Description
IEnumerator

GetParameter(Int32)

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

GetParameter(String)

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

IndexOf(DeephavenParameter)

Report the offset within the collection of the given parameter.

Declaration
public int IndexOf(DeephavenParameter item)
Parameters
Type Name Description
DeephavenParameter 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

IndexOf(String)

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

Insert(Int32, DeephavenParameter)

Insert the specified parameter into the collection.

Declaration
public void Insert(int index, DeephavenParameter item)
Parameters
Type Name Description
System.Int32 index

Index of the existing parameter before which to insert the new one.

DeephavenParameter 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

Remove(DeephavenParameter)

Remove the specified parameter from the collection.

Declaration
public bool Remove(DeephavenParameter item)
Parameters
Type Name Description
DeephavenParameter item

Parameter to remove.

Returns
Type Description
System.Boolean

True if the parameter was found and removed, otherwise false.

Remove(Object)

Removes the specified DeephavenParameter from the collection.

Declaration
public override void Remove(object value)
Parameters
Type Name Description
System.Object value

The DeephavenParameter to remove from the collection.

Remove(String)

Removes the specified DeephavenParameter from the collection.

Declaration
public void Remove(string parameterName)
Parameters
Type Name Description
System.String parameterName

The name of the DeephavenParameter to remove from the collection.

RemoveAt(Int32)

Removes the specified DeephavenParameter 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)

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

SetParameter(Int32, DbParameter)

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

SetParameter(String, DbParameter)

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 DeephavenParameter[] ToArray()
Returns
Type Description
DeephavenParameter[]

DeephavenParameter[]

TryGetValue(String, out DeephavenParameter)

Gets a value indicating whether a DeephavenParameter with the specified parameter name exists in the collection.

Declaration
public bool TryGetValue(string parameterName, out DeephavenParameter parameter)
Parameters
Type Name Description
System.String parameterName

The name of the DeephavenParameter object to find.

DeephavenParameter 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.

Implements

IList<>
Back to top Generated by DocFX