Item(String) Property

In This Topic

Syntax
Example
Requirements
See Also

Gets or sets the SqlParameter with the specified name.

Syntax

Visual Basic
C#

public new SqlParameter Item( 
   string parameterName
) {get; set;}

'Declaration
 
Public Overloads Shadows Property Item( _
   ByVal parameterName As String _
) As SqlParameter

Parameters

parameterName: The name of the parameter to retrieve.

Property Value

The SqlParameter with the specified name.

Example

The following example searches for a SqlParameter with a given ParameterName within a SqlParameterCollection. If the parameter exists, the example displays the name and index of the parameter. If the parameter does not exist, the example displays an error. This example assumes that a SqlParameterCollection has already been created.

csharp

public void SearchSqlParams() {
  // ...
  // create SqlParameterCollection myParameters
  // ...
  if (!myParameters.Contains("DName"))
    MessageBox.Show("ERROR: no such parameter in the collection");
  else
    MessageBox.Show("Name: " + myParameters["DName"].ToString() +
      "Index: " + myParameters.IndexOf("DName").ToString());
}

Visual Basic

Public Sub SearchSqlParams()
  ' ...
  ' create SqlParameterCollection myParameters
  ' ...
  If Not myParameters.Contains("DName") Then
    MessageBox.Show("ERROR: no such parameter in the collection")
  Else
    MessageBox.Show("Name: "  & myParameters("DName").ToString()  & _
      "Index: "  & myParameters.IndexOf("DName").ToString())
  End If
End Sub

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

SqlParameterCollection Class
SqlParameterCollection Members
Overload List

Send Feedback