DefaultEvents.OnProgress Método
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
Este método recibe una llamada siempre que una tarea experimenta un progreso que se puede medir.
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
Un valor cero.
- progressDescription
- String
Una cadena que describe el progreso del evento que se activa.
- percentComplete
- Int32
Un entero utilizado para indicar lo que se ha finalizado de la tarea.
- progressCountLow
- Int32
Un entero que contiene los 32 bits inferiores de las unidades finalizadas.
- progressCountHigh
- Int32
Un entero que contiene los 32 bits superiores de las unidades finalizadas.
- subComponent
- String
Una cadena que contiene más información sobre el origen del evento.
- fireAgain
- Boolean
Un valor booleano que indica si debe continuar activando o detener la activación. Un valor de true indica que debe continuar activando.
Implementaciones
Comentarios
Cada tarea tiene sus propios requisitos, pero como regla general, una tarea notifica el progreso en incrementos del 1 %. OnProgress la llama la tarea a intervalos predeterminados para actualizar los clientes de escucha en el progreso de una tarea determinada.