SqlCommand.CommandTimeout Propriedade

Definição

Namespace:

Microsoft.Data.SqlClient

Assembly:

Microsoft.Data.SqlClient.dll

Pacote:

Microsoft.Data.SqlClient v5.2.0

Obtém ou define o tempo de espera (em segundos) antes de encerrar a tentativa de executar um comando e antes de gerar um erro. O padrão é 30 segundos.

public:
 virtual property int CommandTimeout { int get(); void set(int value); };

public override int CommandTimeout { get; set; }

member this.CommandTimeout : int with get, set

Public Overrides Property CommandTimeout As Integer

Valor da propriedade

Int32

O tempo de espera, em segundos, para a execução do comando. O padrão é 30 segundos.

Exceções

ArgumentException

O valor definido é menor que 0.

Comentários

Um valor 0 indica que nenhum limite (uma tentativa de executar um comando aguardará indefinidamente).

Observação

A CommandTimeout propriedade será ignorada durante chamadas de método assíncrono de estilo antigo, como BeginExecuteReader. Ele será respeitado pelos métodos assíncronos mais recentes, como ExecuteReaderAsync.

Observação

Essa propriedade é o tempo limite cumulativo (para todos os pacotes de rede que são lidos durante a invocação de um método) para todas as leituras de rede durante a execução ou processamento de comando dos resultados. Um tempo limite ainda pode ocorrer depois que a primeira linha é retornada e não inclui o tempo de processamento do usuário, apenas o tempo de leitura da rede.

Por exemplo, com um tempo limite de 30 segundos, se Read exigir dois pacotes de rede, ele terá 30 segundos para ler os dois pacotes de rede. Se você chamar Read novamente, ele terá mais 30 segundos para ler os dados necessários.

// <Snippet1>
using System;
using Microsoft.Data.SqlClient;

public class A
{
    public static void Main()
    {
        string connectionString = "<Your-connection-string-here>";
        // Wait for 5 second delay in the command
        string queryString = "waitfor delay '00:00:05'";
        using (SqlConnection connection = new SqlConnection(connectionString))
        {
            connection.Open();
            SqlCommand command = new SqlCommand(queryString, connection);
            // Setting command timeout to 1 second
            command.CommandTimeout = 1;
            try
            {
                command.ExecuteNonQuery();
            }
            catch (SqlException e)
            {
                Console.WriteLine("Got expected SqlException due to command timeout ");
                Console.WriteLine(e);
            }
        }
    }
}
// </Snippet1>