Получить значение выходного параметра в ADO.NET

96

Моя хранимая процедура имеет выходной параметр:

@ID INT OUT

Как я могу получить это с помощью ado.net?

using (SqlConnection conn = new SqlConnection(...))
{
    SqlCommand cmd = new SqlCommand("sproc", conn);
    cmd.CommandType = CommandType.StoredProcedure;

    // add parameters

    conn.Open();

    // *** read output parameter here, how?
    conn.Close();
}
Абатищев
источник

Ответы:

119

Другой ответ показывает , что это, но по сути вам просто нужно создать SqlParameter, установить , Directionчтобы Output, и добавить его в SqlCommand«s Parametersколлекции. Затем выполните хранимую процедуру и получите значение параметра.

Используя ваш пример кода:

// SqlConnection and SqlCommand are IDisposable, so stack a couple using()'s
using (SqlConnection conn = new SqlConnection(connectionString))
using (SqlCommand cmd = new SqlCommand("sproc", conn))
{
   // Create parameter with Direction as Output (and correct name and type)
   SqlParameter outputIdParam = new SqlParameter("@ID", SqlDbType.Int)
   { 
      Direction = ParameterDirection.Output 
   };

   cmd.CommandType = CommandType.StoredProcedure;
   cmd.Parameters.Add(outputIdParam);

   conn.Open();
   cmd.ExecuteNonQuery();

   // Some various ways to grab the output depending on how you would like to
   // handle a null value returned from the query (shown in comment for each).

   // Note: You can use either the SqlParameter variable declared
   // above or access it through the Parameters collection by name:
   //   outputIdParam.Value == cmd.Parameters["@ID"].Value

   // Throws FormatException
   int idFromString = int.Parse(outputIdParam.Value.ToString());

   // Throws InvalidCastException
   int idFromCast = (int)outputIdParam.Value; 

   // idAsNullableInt remains null
   int? idAsNullableInt = outputIdParam.Value as int?; 

   // idOrDefaultValue is 0 (or any other value specified to the ?? operator)
   int idOrDefaultValue = outputIdParam.Value as int? ?? default(int); 

   conn.Close();
}

Будьте осторожны при получении Parameters[].Value, поскольку тип должен быть приведен objectк тому, как вы его объявляете. И SqlDbTypeиспользуется при создании SqlParameterпотребностей, чтобы соответствовать типу в базе данных. Если вы собираетесь просто выводить его на консоль, вы можете просто использовать Parameters["@Param"].Value.ToString()(явно или неявно через вызов Console.Write()или String.Format()).

РЕДАКТИРОВАТЬ: более 3,5 лет и почти 20 тысяч просмотров, и никто не удосужился упомянуть, что он даже не компилировался по причине, указанной в моем комментарии «будьте осторожны» в исходном сообщении. Ницца. Исправлено на основе хороших комментариев от @Walter Stabosz и @Stephen Kennedy и для соответствия редактированию кода обновления в вопросе от @abatishchev.

BQ.
источник
8
Вам не нужно, так conn.Close()как это внутри usingблока
Маркус
1
Я считаю, что вы неправильно используете int.MaxValue в качестве свойства Size. int.MaxValue - это константа со значением 2 147 483 647. msdn.microsoft.com/en-us/library/… . Ошибка в этом примере безвредна, потому что тип данных - Int и «Для типов данных фиксированной длины значение Size игнорируется.», Но ноль было бы достаточно.
Walter Stabosz
.Value имеет тип object, поэтому его прямое присвоение int без приведения не сработает.
Стивен Кеннеди
1
Для тех, кто использует DataReader, вы должны закрыть его или прочитать данные до конца, прежде чем вы сможете просматривать выходные параметры.
Гарри Инглиш
56

Для тех, кто хочет сделать что-то подобное, используя средство чтения с хранимой процедурой, обратите внимание, что средство чтения должно быть закрыто, чтобы получить выходное значение.

using (SqlConnection conn = new SqlConnection())
{
    SqlCommand cmd = new SqlCommand("sproc", conn);
    cmd.CommandType = CommandType.StoredProcedure;

    // add parameters
    SqlParameter outputParam = cmd.Parameters.Add("@ID", SqlDbType.Int);
    outputParam.Direction = ParameterDirection.Output;

    conn.Open();

    using(IDataReader reader = cmd.ExecuteReader())
    {
        while(reader.Read())
        {
            //read in data
        }
    }
    // reader is closed/disposed after exiting the using statement
    int id = outputParam.Value;
}
Нейт Киндрю
источник
4
Я упустил тот факт, что читалку нужно закрыть перед чтением выходного параметра. Спасибо что подметил это!
Никлас Мёллер Джепсен
28

Не мой код, но хороший пример, я думаю

источник: http://www.eggheadcafe.com/PrintSearchContent.asp?LINKID=624

using System; 
using System.Data; 
using System.Data.SqlClient; 


class OutputParams 
{ 
    [STAThread] 
    static void Main(string[] args) 
    { 

    using( SqlConnection cn = new SqlConnection("server=(local);Database=Northwind;user id=sa;password=;")) 
    { 
        SqlCommand cmd = new SqlCommand("CustOrderOne", cn); 
        cmd.CommandType=CommandType.StoredProcedure ; 

        SqlParameter parm= new SqlParameter("@CustomerID",SqlDbType.NChar) ; 
        parm.Value="ALFKI"; 
        parm.Direction =ParameterDirection.Input ; 
        cmd.Parameters.Add(parm); 

        SqlParameter parm2= new SqlParameter("@ProductName",SqlDbType.VarChar); 
        parm2.Size=50; 
        parm2.Direction=ParameterDirection.Output; 
        cmd.Parameters.Add(parm2); 

        SqlParameter parm3=new SqlParameter("@Quantity",SqlDbType.Int); 
        parm3.Direction=ParameterDirection.Output; 
        cmd.Parameters.Add(parm3);

        cn.Open(); 
        cmd.ExecuteNonQuery(); 
        cn.Close(); 

        Console.WriteLine(cmd.Parameters["@ProductName"].Value); 
        Console.WriteLine(cmd.Parameters["@Quantity"].Value.ToString());
        Console.ReadLine(); 
    } 
} 
WACM161
источник
2
Ага, это правильно. Просто установите свойство ParameterDirection параметра. Вам не нужна строка cn.Close () - об этом позаботится блок using {}.
MusiGenesis
6
string ConnectionString = ConfigurationManager.ConnectionStrings["DBCS"].ConnectionString;
using (SqlConnection con = new SqlConnection(ConnectionString))
{
//Create the SqlCommand object
SqlCommand cmd = new SqlCommand(“spAddEmployee”, con);

//Specify that the SqlCommand is a stored procedure
cmd.CommandType = System.Data.CommandType.StoredProcedure;

//Add the input parameters to the command object
cmd.Parameters.AddWithValue(“@Name”, txtEmployeeName.Text);
cmd.Parameters.AddWithValue(“@Gender”, ddlGender.SelectedValue);
cmd.Parameters.AddWithValue(“@Salary”, txtSalary.Text);

//Add the output parameter to the command object
SqlParameter outPutParameter = new SqlParameter();
outPutParameter.ParameterName = @EmployeeId”;
outPutParameter.SqlDbType = System.Data.SqlDbType.Int;
outPutParameter.Direction = System.Data.ParameterDirection.Output;
cmd.Parameters.Add(outPutParameter);

//Open the connection and execute the query
con.Open();
cmd.ExecuteNonQuery();

//Retrieve the value of the output parameter
string EmployeeId = outPutParameter.Value.ToString();
}

Шрифт http://www.codeproject.com/Articles/748619/ADO-NET-How-to-call-a-stored-procedure-with-output

Винисиус Тодеско
источник
6
public static class SqlParameterExtensions
{
    public static T GetValueOrDefault<T>(this SqlParameter sqlParameter)
    {
        if (sqlParameter.Value == DBNull.Value 
            || sqlParameter.Value == null)
        {
            if (typeof(T).IsValueType)
                return (T)Activator.CreateInstance(typeof(T));

            return (default(T));
        }

        return (T)sqlParameter.Value;
    }
}


// Usage
using (SqlConnection conn = new SqlConnection(connectionString))
using (SqlCommand cmd = new SqlCommand("storedProcedure", conn))
{
   SqlParameter outputIdParam = new SqlParameter("@ID", SqlDbType.Int)
   { 
      Direction = ParameterDirection.Output 
   };

   cmd.CommandType = CommandType.StoredProcedure;
   cmd.Parameters.Add(outputIdParam);

   conn.Open();
   cmd.ExecuteNonQuery();

   int result = outputIdParam.GetValueOrDefault<int>();
}
Грег Р. Тейлор
источник
3

Вы можете получить свой результат с помощью кода ниже:

using (SqlConnection conn = new SqlConnection(...))
{
    SqlCommand cmd = new SqlCommand("sproc", conn);
    cmd.CommandType = CommandType.StoredProcedure;

    // add other parameters parameters

    //Add the output parameter to the command object
    SqlParameter outPutParameter = new SqlParameter();
    outPutParameter.ParameterName = "@Id";
    outPutParameter.SqlDbType = System.Data.SqlDbType.Int;
    outPutParameter.Direction = System.Data.ParameterDirection.Output;
    cmd.Parameters.Add(outPutParameter);

    conn.Open();
    cmd.ExecuteNonQuery();

    //Retrieve the value of the output parameter
    string Id = outPutParameter.Value.ToString();

    // *** read output parameter here, how?
    conn.Close();
}

источник
2

Создайте SqlParamObject, который предоставит вам контроль над методами доступа к параметрам.

:

SqlParameter param = новый SqlParameter ();

УСТАНОВИТЕ Имя для вашего параметра (оно должно быть таким же, как если бы вы объявили переменную для хранения значения в вашей базе данных)

: param.ParameterName = "@yourParamterName";

Очистите держатель значения, чтобы хранить выходные данные

: param.Value = 0;

Установите направление по вашему выбору (в вашем случае это должен быть выход)

: param.Direction = System.Data.ParameterDirection.Output;

Сандип Панди
источник
1

Для меня это выглядит более явным:

int? id = outputIdParam. Значение - DbNull? по умолчанию (число?): outputIdParam.Value;

Генн
источник