Esta documentación está archivada y no tiene mantenimiento.

ThreadPool.RegisterWaitForSingleObject (Método) (WaitHandle, WaitOrTimerCallback, Object, TimeSpan, Boolean)

Actualización: noviembre 2007

Registra un delegado que va a esperar a una clase WaitHandle, especificando un valor de TimeSpan para el tiempo de espera.

Espacio de nombres:  System.Threading
Ensamblado:  mscorlib (en mscorlib.dll)

public static RegisteredWaitHandle RegisterWaitForSingleObject(
	WaitHandle waitObject,
	WaitOrTimerCallback callBack,
	Object state,
	TimeSpan timeout,
	bool executeOnlyOnce
)
public static RegisteredWaitHandle RegisterWaitForSingleObject(
	WaitHandle waitObject,
	WaitOrTimerCallback callBack,
	Object state,
	TimeSpan timeout,
	boolean executeOnlyOnce
)
public static function RegisterWaitForSingleObject(
	waitObject : WaitHandle, 
	callBack : WaitOrTimerCallback, 
	state : Object, 
	timeout : TimeSpan, 
	executeOnlyOnce : boolean
) : RegisteredWaitHandle

Parámetros

waitObject
Tipo: System.Threading.WaitHandle
WaitHandle que se va a registrar. Utilice un WaitHandle diferente de Mutex.
callBack
Tipo: System.Threading.WaitOrTimerCallback
Delegado de WaitOrTimerCallback al que se va a llamar cuando el parámetro waitObject esté señalado.
state
Tipo: System.Object
Objeto que se ha pasado al delegado.
timeout
Tipo: System.TimeSpan
Tiempo de espera representado por TimeSpan. Si timeout es 0 (cero), la función comprueba el estado del objeto y regresa inmediatamente. Si timeout es -1, el intervalo de tiempo de espera de la función nunca transcurre.
executeOnlyOnce
Tipo: System.Boolean
Es true para indicar que el subproceso ya no va a esperar en el parámetro waitObject después de haber llamado al delegado; es false para indicar que el temporizador se restablece cada vez que se completa la operación de espera, hasta que se anule el registro de espera.

Valor devuelto

Tipo: System.Threading.RegisteredWaitHandle
RegisteredWaitHandle que encapsula el identificador nativo.

ExcepciónCondición
ArgumentOutOfRangeException

El parámetro timeout es menor que -1.

NotSupportedException

El valor del parámetro timeout es mayor que el valor de la propiedad Int32.MaxValue.

Cuando termine de usar la clase RegisteredWaitHandle devuelta por este método, llame a su método RegisteredWaitHandle.Unregister para liberar las referencias al identificador de espera. Se recomienda llamar siempre al método RegisteredWaitHandle.Unregister, incluso si se especifica true para executeOnlyOnce. La recolección de elementos no utilizados resulta más eficaz si se llama al método RegisteredWaitHandle.Unregister en lugar de depender del finalizador del identificador de espera registrado.

El método RegisterWaitForSingleObject coloca el delegado especificado en cola del grupo de subprocesos. Un proceso de trabajo ejecutará el delegado si se produce una de las siguientes situaciones:

  • El objeto especificado se encuentra en estado señalado.

  • El intervalo de tiempo de espera ha transcurrido.

El método RegisterWaitForSingleObject comprueba el estado actual del WaitHandledel objeto especificado. Si el estado del objeto no está señalado, el método registra una operación de espera. El encargado de llevar a cabo la operación de espera es un subproceso del grupo de subprocesos. Un subproceso de trabajo ejecuta el delegado cuando el estado del objeto pasa a ser señalado o cuando transcurre el intervalo de tiempo de espera. Si el valor del parámetro timeOutInterval no es 0 (cero) y el del parámetro executeOnlyOnce es false, el temporizador se restablece cada vez que se señala el evento o se agota el intervalo de tiempo de espera.

shfwcf8k.alert_caution(es-es,VS.90).gifNota importante:

El uso de Mutex para waitObject no proporciona la exclusión mutua de devoluciones de llamada porque la API de Win32 subyacente utiliza el marcador WT_EXECUTEDEFAULT predeterminado, por lo que cada devolución de llamada se envía en un subproceso del grupo de subprocesos independiente. En lugar de un objeto Mutex, utilice un objeto Semaphore cuyo recuento máximo sea 1.

Para cancelar la operación de espera, hay que llamar al método RegisteredWaitHandle.Unregister.

El subproceso de espera utiliza la función WaitForMultipleObjects de Win32 para supervisar las operaciones de espera registradas. Por lo tanto, si tiene que utilizar el mismo identificador del sistema operativo nativo en varias llamadas a RegisterWaitForSingleObject, deberá duplicar el identificador utilizando la función DuplicateHandle de Win32. Tenga en cuanta que no debe marcar un objeto de evento que se haya pasado a RegisterWaitForSingleObject, porque el subproceso de espera podría no detectar que el evento está señalado antes de restablecerse.

La función modifica el estado de algunos tipos de objetos de sincronización antes de devolverse. La modificación se lleva a cabo únicamente en el objeto cuyo estado señalado satisfizo la condición de espera. Por ejemplo, el recuento de un semáforo disminuye en una unidad.

Información de versión

A partir de .NET Framework versión 2.0, el valor de la propiedad Thread.CurrentPrincipal se propaga a los subprocesos de trabajo almacenados en la cola mediante el método RegisterWaitForSingleObject. En las versiones anteriores, la información principal no se difunde.

Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

.NET Framework y .NET Compact Framework no admiten todas las versiones de cada plataforma. Para obtener una lista de las versiones compatibles, vea Requisitos de sistema de .NET Framework.

.NET Framework

Compatible con: 3.5, 3.0, 2.0, 1.1, 1.0
Mostrar: