DefaultEvents.OnProgress Método
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Este método é chamado sempre que uma tarefa experimenta um progresso mensurável.
public:
virtual void OnProgress(Microsoft::SqlServer::Dts::Runtime::TaskHost ^ taskHost, System::String ^ progressDescription, int percentComplete, int progressCountLow, int progressCountHigh, System::String ^ subComponent, bool % fireAgain);
public virtual void OnProgress (Microsoft.SqlServer.Dts.Runtime.TaskHost taskHost, string progressDescription, int percentComplete, int progressCountLow, int progressCountHigh, string subComponent, ref bool fireAgain);
abstract member OnProgress : Microsoft.SqlServer.Dts.Runtime.TaskHost * string * int * int * int * string * bool -> unit
override this.OnProgress : Microsoft.SqlServer.Dts.Runtime.TaskHost * string * int * int * int * string * bool -> unit
Public Overridable Sub OnProgress (taskHost As TaskHost, progressDescription As String, percentComplete As Integer, progressCountLow As Integer, progressCountHigh As Integer, subComponent As String, ByRef fireAgain As Boolean)
Parâmetros
- taskHost
- TaskHost
Um valor nulo.
- progressDescription
- String
Uma cadeia de caracteres que descreve o progresso do evento que é gerado.
- percentComplete
- Int32
Um inteiro usado para indicar quanto da tarefa foi concluída.
- progressCountLow
- Int32
Um inteiro que contém os 32 bits menores das unidades concluídas.
- progressCountHigh
- Int32
Um inteiro que contém os 32 bits maiores das unidades concluídas.
- subComponent
- String
Uma cadeia de caracteres que contém mais detalhes sobre a origem do evento.
- fireAgain
- Boolean
Um booliano que indica se isso deve continuar disparando ou parando de disparar. Um valor verdadeiro indica que ele deve continuar sendo acionado.
Implementações
Comentários
Cada tarefa tem seus próprios requisitos, mas como regra geral, uma tarefa relata o progresso em incrementos de 1%. OnProgress é chamado pela tarefa em intervalos predeterminados para atualizar clientes ouvintes sobre o andamento de uma determinada tarefa.