Obtenha o valor do parâmetro de saída em ADO.NET


96

Meu procedimento armazenado tem um parâmetro de saída:

@ID INT OUT

Como posso recuperar isso usando 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();
}

Respostas:


119

Os outros shows de resposta isto, mas, essencialmente, você só precisa criar um SqlParameter, definir o Directionque Output, e adicioná-lo ao SqlCommand's Parameterscoleção. Em seguida, execute o procedimento armazenado e obtenha o valor do parâmetro.

Usando seu exemplo de código:

// 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();
}

Tenha cuidado ao obter o Parameters[].Value, uma vez que o tipo precisa ser convertido objectpara o que você está declarando. E o SqlDbTypeusado quando você cria as SqlParameternecessidades para corresponder ao tipo no banco de dados. Se você vai apenas Parameters["@Param"].Value.ToString()enviá- lo para o console, pode apenas usar (explicitamente ou implicitamente por meio de um Console.Write()ouString.Format() chamada ).

EDITAR: Mais de 3,5 anos e quase 20 mil visualizações e ninguém se preocupou em mencionar que ele nem mesmo compilou pelo motivo especificado no meu comentário "tenha cuidado" no post original. Agradável. Corrigido com base em bons comentários de @Walter Stabosz e @Stephen Kennedy e para corresponder à edição do código de atualização na pergunta de @abatishchev.


8
Você não precisa conn.Close()porque está dentro de um usingbloco
Marcus

1
Acho que o uso de int.MaxValue como a propriedade Size está incorreto. int.MaxValue é uma constante com o valor 2.147.483.647. msdn.microsoft.com/en-us/library/… . O erro é inofensivo neste exemplo porque o tipo de dados é Int e "Para tipos de dados de comprimento fixo, o valor de Size é ignorado.", Mas um zero teria bastado.
Walter Stabosz

.Value é do tipo objeto, portanto, atribuí-lo diretamente a um int sem lançar não vai funcionar.
Stephen Kennedy

1
Para aqueles que estão usando um DataReader, você deve fechá-lo ou ler até o final dos dados antes de visualizar os parâmetros de saída.
Garry English

56

Para quem deseja fazer algo semelhante usando um leitor com o procedimento armazenado, observe que o leitor deve ser fechado para recuperar o valor de saída.

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
Perdi o fato de que o leitor deve ser fechado antes de ler o parâmetro de saída. Obrigado por apontar isso!
Nicklas Møller Jepsen de

28

Não é meu código, mas um bom exemplo, eu acho

fonte: 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(); 
    } 
} 

2
Sim, isso está correto. Basta definir a propriedade ParameterDirection do parâmetro. Você não precisa da linha cn.Close () - o bloco using {} cuida disso.
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();
}

Fonte 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

Você pode obter seu resultado pelo código abaixo:

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

Crie o SqlParamObject que lhe daria controle para acessar métodos nos parâmetros

:

SqlParameter param = new SqlParameter ();

DEFINA o nome do seu parâmetro (deve ser o mesmo que você declararia uma variável para conter o valor em seu banco de dados)

: param.ParameterName = "@yourParamterName";

Limpe o titular do valor para manter seus dados de saída

: param.Value = 0;

Defina a direção de sua escolha (no seu caso, deve ser saída)

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


1

Isso parece mais explícito para mim:

int? id = outputIdParam.Value is DbNull? padrão (int?): outputIdParam.Value;

Ao utilizar nosso site, você reconhece que leu e compreendeu nossa Política de Cookies e nossa Política de Privacidade.
Licensed under cc by-sa 3.0 with attribution required.