SqlCeParameterCollection.IndexOf Method (Object)

Gets the location of the SqlCeParameter object in the collection.

Namespace: System.Data.SqlServerCe
Assembly: System.Data.SqlServerCe (in system.data.sqlserverce.dll)

Syntax

'Declaration
Public Overrides Function IndexOf ( _
    value As Object _
) As Integer
'Usage
Dim instance As SqlCeParameterCollection
Dim value As Object
Dim returnValue As Integer

returnValue = instance.IndexOf(value)

public override int IndexOf (
    Object value
)

public:
virtual int IndexOf (
    Object^ value
) override

public int IndexOf (
    Object value
)

public override function IndexOf (
    value : Object
) : int

Not applicable.

Parameters

• value
  The SqlCeParameter object to locate.

Return Value

The zero-based location of the SqlCeParameter in the collection.

Example

The following example searches for a SqlCeParameter within a SqlCeParameterCollection. If the parameter exists, the example displays the index of the parameter. If the parameter does not exist, the example displays an error. This example assumes that a SqlCeCommand has already been created.

' ...
' create SqlCeCommand cmd
' ...
Dim myParam As SqlCeParameter = cmd.Parameters.Add("@Description", SqlDbType.NVarChar)
If Not cmd.Parameters.Contains(myParam) Then
    MessageBox.Show("ERROR: no such parameter in the collection")
Else
    MessageBox.Show("match on parameter #" & cmd.Parameters.IndexOf(myParam).ToString())
End If

// ...
// create SqlCeCommand cmd
// ...
SqlCeParameter myParam = cmd.Parameters.Add("@Description", SqlDbType.NVarChar);
if (!cmd.Parameters.Contains(myParam))
    MessageBox.Show("ERROR: no such parameter in the collection");
else
    MessageBox.Show("match on parameter #" +
        cmd.Parameters.IndexOf(myParam).ToString());

Platforms

Windows CE, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows XP Professional x64 Edition, Windows XP SP2

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

Version Information

.NET Framework

Supported in: 3.0

.NET Compact Framework

Supported in: 2.0, 1.0

See Also

Reference

SqlCeParameterCollection Class
SqlCeParameterCollection Members
System.Data.SqlServerCe Namespace