SqlParameterCollection.Item[] 属性
定义
获取具有指定属性的 SqlParameter。Gets the SqlParameter with a specified attribute.
重载
| Item[String] |
获取具有指定名称的 SqlParameter。Gets the SqlParameter with the specified name. |
| Item[Int32] |
获取位于指定索引处的 SqlParameter。Gets the SqlParameter at the specified index. |
Item[String]
获取具有指定名称的 SqlParameter。Gets the SqlParameter with the specified name.
public:
property System::Data::SqlClient::SqlParameter ^ default[System::String ^] { System::Data::SqlClient::SqlParameter ^ get(System::String ^ parameterName); void set(System::String ^ parameterName, System::Data::SqlClient::SqlParameter ^ value); };
public System.Data.SqlClient.SqlParameter this[string parameterName] { get; set; }
[System.ComponentModel.Browsable(false)]
public System.Data.SqlClient.SqlParameter this[string parameterName] { get; set; }
member this.Item(string) : System.Data.SqlClient.SqlParameter with get, set
[<System.ComponentModel.Browsable(false)>]
member this.Item(string) : System.Data.SqlClient.SqlParameter with get, set
Default Public Property Item(parameterName As String) As SqlParameter
参数
- parameterName
- String
要检索的参数的名称。The name of the parameter to retrieve.
属性值
具有指定名称的 SqlParameter。The SqlParameter with the specified name.
- 属性
例外
指定的 parameterName 无效。The specified parameterName is not valid.
注解
parameterName用于在基础中查找索引值 SqlParameterCollection 。The parameterName is used to look up the index value in the underlying SqlParameterCollection. 如果无效 parameterName , IndexOutOfRangeException 将引发。If the parameterName is not valid, an IndexOutOfRangeException will be thrown.
适用于
Item[Int32]
获取位于指定索引处的 SqlParameter。Gets the SqlParameter at the specified index.
public:
property System::Data::SqlClient::SqlParameter ^ default[int] { System::Data::SqlClient::SqlParameter ^ get(int index); void set(int index, System::Data::SqlClient::SqlParameter ^ value); };
public System.Data.SqlClient.SqlParameter this[int index] { get; set; }
[System.ComponentModel.Browsable(false)]
public System.Data.SqlClient.SqlParameter this[int index] { get; set; }
member this.Item(int) : System.Data.SqlClient.SqlParameter with get, set
[<System.ComponentModel.Browsable(false)>]
member this.Item(int) : System.Data.SqlClient.SqlParameter with get, set
Default Public Property Item(index As Integer) As SqlParameter
参数
- index
- Int32
要检索的参数的索引(从零开始)。The zero-based index of the parameter to retrieve.
属性值
指定索引处的 SqlParameter。The SqlParameter at the specified index.
- 属性
例外
指定的索引不存在。The specified index does not exist.
示例
下面的示例演示如何创建 SqlParameter 对象以向在输出参数中返回结果的存储过程提供输入参数。The following example demonstrates creating SqlParameter objects to supply an input parameter to a stored procedure that returns results in an output parameter. 此代码循环访问中的项 SqlParameterCollection ,并在控制台窗口中显示一些参数属性。The code iterates through the items in the SqlParameterCollection and displays some parameter properties in the console window. 此示例假定 SQL Server 实例上的 AdventureWorks 示例数据库的有效连接字符串。This example assumes a valid connection string to the AdventureWorks sample database on an instance of SQL Server.
static private string CreateSqlParameters(int documentID)
{
// Assumes GetConnectionString returns a valid connection string to the
// AdventureWorks sample database on an instance of SQL Server 2005.
using (SqlConnection connection =
new SqlConnection(GetConnectionString()))
{
connection.Open();
SqlCommand command = connection.CreateCommand();
try
{
// Setup the command to execute the stored procedure.
command.CommandText = "GetDocumentSummary";
command.CommandType = CommandType.StoredProcedure;
// Create the input parameter for the DocumentID.
SqlParameter paramID =
new SqlParameter("@DocumentID", SqlDbType.Int);
paramID.Value = documentID;
command.Parameters.Add(paramID);
// Create the output parameter to retrieve the summary.
SqlParameter paramSummary =
new SqlParameter("@DocumentSummary", SqlDbType.NVarChar, -1);
paramSummary.Direction = ParameterDirection.Output;
command.Parameters.Add(paramSummary);
// List the parameters and some of properties.
SqlParameterCollection paramCollection = command.Parameters;
string parameterList = "";
for (int i = 0; i < paramCollection.Count; i++)
{
parameterList += String.Format(" {0}, {1}, {2}\n",
paramCollection[i], paramCollection[i].DbType,
paramCollection[i].Direction);
}
Console.WriteLine("Parameter Collection:\n" + parameterList);
// Execute the stored procedure; retrieve
// and display the output parameter value.
command.ExecuteNonQuery();
Console.WriteLine((String)(paramSummary.Value));
return (String)(paramSummary.Value);
}
catch (Exception ex)
{
Console.WriteLine(ex.Message);
return null;
}
}
}