SqlCommand.CommandTimeout Propriedade

  • Referência

Definição

Namespace:
System.Data.SqlClient
Assembly:
System.Data.SqlClient.dll
Assembly:
System.Data.dll

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.

public:
 virtual property int CommandTimeout { int get(); void set(int value); };
public:
 property int CommandTimeout { int get(); void set(int value); };
public override int CommandTimeout { get; set; }
[System.Data.DataSysDescription("DbCommand_CommandTimeout")]
public int CommandTimeout { get; set; }
member this.CommandTimeout : int with get, set
[<System.Data.DataSysDescription("DbCommand_CommandTimeout")>]
member this.CommandTimeout : int with get, set
Public Overrides Property CommandTimeout As Integer
Public 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.

Implementações

CommandTimeout
Atributos
DataSysDescriptionAttribute

Comentários

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

Observação

A CommandTimeout propriedade será ignorada por chamadas de método assíncronas do APM (Modelo de Programação Assíncrona) mais antigas, como BeginExecuteReader. Ele será honrado por métodos TAP (Programação Assíncrona da Tarefa) mais recentes, como ExecuteReaderAsync.

CommandTimeout não tem efeito quando o comando é executado em uma conexão de contexto (uma SqlConnection aberta com "context connection=true" na cadeia de conexão).

Observação

Essa propriedade é o tempo limite cumulativo (para todos os pacotes de rede lidos durante a invocação de um método) para todas as leituras de rede durante a execução de comando ou processamento 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ê ligar Read novamente, ele terá mais 30 segundos para ler os dados necessários.

using System;  
using System.Data.SqlClient;  
///   
public class A {  
   ///   
   public static void Main() {  
      string connectionString = "";  
      // 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);  
         }  
      }  
   }  
}

Aplica-se a

Confira também