CancellationToken.Register Método

Definição

Registra um delegado que será chamado quando isso CancellationToken for cancelado.

Sobrecargas

Nome Description
Register(Action)

Registra um delegado que será chamado quando isso CancellationToken for cancelado.

Register(Action, Boolean)

Registra um delegado que será chamado quando isso CancellationToken for cancelado.

Register(Action<Object>, Object)

Registra um delegado que será chamado quando isso CancellationToken for cancelado.

Register(Action<Object>, Object, Boolean)

Registra um delegado que será chamado quando isso CancellationToken for cancelado.

Register(Action)

Registra um delegado que será chamado quando isso CancellationToken for cancelado.

public:
 System::Threading::CancellationTokenRegistration Register(Action ^ callback);
public System.Threading.CancellationTokenRegistration Register(Action callback);
member this.Register : Action -> System.Threading.CancellationTokenRegistration
Public Function Register (callback As Action) As CancellationTokenRegistration

Parâmetros

callback
Action

O delegado a ser executado quando o CancellationToken é cancelado.

Retornos

A CancellationTokenRegistration instância que pode ser usada para cancelar o registro do retorno de chamada.

Exceções

O associado CancellationTokenSource foi descartado.

callback é nulo.

Comentários

Se esse token já estiver no estado cancelado, o delegado será executado imediatamente e de forma síncrona. Qualquer exceção gerada pelo delegado será propagada dessa chamada de método.

A corrente ExecutionContext é capturada junto com o delegado e será usada ao executá-la.

A corrente SynchronizationContext não é capturada.

Confira também

Aplica-se a

Register(Action, Boolean)

Registra um delegado que será chamado quando isso CancellationToken for cancelado.

public:
 System::Threading::CancellationTokenRegistration Register(Action ^ callback, bool useSynchronizationContext);
public System.Threading.CancellationTokenRegistration Register(Action callback, bool useSynchronizationContext);
member this.Register : Action * bool -> System.Threading.CancellationTokenRegistration
Public Function Register (callback As Action, useSynchronizationContext As Boolean) As CancellationTokenRegistration

Parâmetros

callback
Action

O delegado a ser executado quando o CancellationToken é cancelado.

useSynchronizationContext
Boolean

Um valor que indica se é necessário capturar o atual SynchronizationContext e usá-lo ao invocar o callback.

Retornos

A CancellationTokenRegistration instância que pode ser usada para cancelar o registro do retorno de chamada.

Exceções

O associado CancellationTokenSource foi descartado.

callback é nulo.

Comentários

Se esse token já estiver no estado cancelado, o delegado será executado imediatamente e de forma síncrona. Qualquer exceção gerada pelo delegado será propagada dessa chamada de método.

A corrente ExecutionContext é capturada junto com o delegado e será usada ao executá-la.

Se useSynchronizationContext houver true, o atual SynchronizationContext, se existir, também será capturado junto com o delegado e será usado ao executá-lo. Caso contrário, SynchronizationContext não será capturado.

Confira também

Aplica-se a

Register(Action<Object>, Object)

Registra um delegado que será chamado quando isso CancellationToken for cancelado.

public:
 System::Threading::CancellationTokenRegistration Register(Action<System::Object ^> ^ callback, System::Object ^ state);
public System.Threading.CancellationTokenRegistration Register(Action<object> callback, object state);
member this.Register : Action<obj> * obj -> System.Threading.CancellationTokenRegistration
Public Function Register (callback As Action(Of Object), state As Object) As CancellationTokenRegistration

Parâmetros

callback
Action<Object>

O delegado a ser executado quando o CancellationToken é cancelado.

state
Object

O estado a ser passado para o callback momento em que o delegado é invocado. Isso pode ser nulo.

Retornos

A CancellationTokenRegistration instância que pode ser usada para cancelar o registro do retorno de chamada.

Exceções

O associado CancellationTokenSource foi descartado.

callback é nulo.

Comentários

Se esse token já estiver no estado cancelado, o delegado será executado imediatamente e de forma síncrona. Qualquer exceção gerada pelo delegado será propagada dessa chamada de método.

A corrente ExecutionContext é capturada junto com o delegado e será usada ao executá-la.

A corrente SynchronizationContext não é capturada.

Confira também

Aplica-se a

Register(Action<Object>, Object, Boolean)

Registra um delegado que será chamado quando isso CancellationToken for cancelado.

public:
 System::Threading::CancellationTokenRegistration Register(Action<System::Object ^> ^ callback, System::Object ^ state, bool useSynchronizationContext);
public System.Threading.CancellationTokenRegistration Register(Action<object> callback, object state, bool useSynchronizationContext);
member this.Register : Action<obj> * obj * bool -> System.Threading.CancellationTokenRegistration
Public Function Register (callback As Action(Of Object), state As Object, useSynchronizationContext As Boolean) As CancellationTokenRegistration

Parâmetros

callback
Action<Object>

O delegado a ser executado quando o CancellationToken é cancelado.

state
Object

O estado a ser passado para o callback momento em que o delegado é invocado. Isso pode ser nulo.

useSynchronizationContext
Boolean

Um valor booliano que indica se é necessário capturar o atual SynchronizationContext e usá-lo ao invocar o callback.

Retornos

A CancellationTokenRegistration instância que pode ser usada para cancelar o registro do retorno de chamada.

Exceções

O associado CancellationTokenSource foi descartado.

callback é nulo.

Comentários

Se esse token já estiver no estado cancelado, o delegado será executado imediatamente e de forma síncrona. Qualquer exceção gerada pelo delegado será propagada dessa chamada de método.

A corrente ExecutionContext é capturada junto com o delegado e será usada ao executá-la.

Se useSynchronizationContext houver true, o atual SynchronizationContext, se existir, também será capturado junto com o delegado e será usado ao executá-lo. Caso contrário, SynchronizationContext não será capturado.

Confira também

Aplica-se a