CancellationToken.Register Método

Definição

Namespace:

System.Threading

Assembly:

System.Threading.Tasks.dll

Assembly:

System.Runtime.dll

Assembly:

mscorlib.dll

Assembly:

netstandard.dll

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

Sobrecargas

Register(Action)	Registra um delegado que será chamado quando este CancellationToken for cancelado.
Register(Action, Boolean)	Registra um delegado que será chamado quando este CancellationToken for cancelado.
Register(Action<Object,CancellationToken>, Object)	Registra um delegado que será chamado quando esse CancellationToken for cancelado.
Register(Action<Object>, Object)	Registra um delegado que será chamado quando este CancellationToken for cancelado.
Register(Action<Object>, Object, Boolean)	Registra um delegado que será chamado quando este CancellationToken for cancelado.

Register(Action)

Registra um delegado que será chamado quando este 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 for cancelado.

Retornos

CancellationTokenRegistration

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

Exceções

ObjectDisposedException

O CancellationTokenSource associado foi descartado.

ArgumentNullException

callback é nulo.

Comentários

Se esse token já estiver no estado cancelado, o delegado será executado de forma imediata e 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

• Cancelamento
• Cancelamento da tarefa
• Como: registrar retornos de chamada para solicitações de cancelamento

Register(Action, Boolean)

Registra um delegado que será chamado quando este 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 for cancelado.

useSynchronizationContext

Boolean

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

Retornos

CancellationTokenRegistration

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

Exceções

ObjectDisposedException

O CancellationTokenSource associado foi descartado.

ArgumentNullException

callback é nulo.

Comentários

Se esse token já estiver no estado cancelado, o delegado será executado de forma imediata e 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 for 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

• Cancelamento
• Cancelamento da tarefa
• Como: registrar retornos de chamada para solicitações de cancelamento

Register(Action<Object,CancellationToken>, Object)

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

public:
 System::Threading::CancellationTokenRegistration Register(Action<System::Object ^, System::Threading::CancellationToken> ^ callback, System::Object ^ state);

public System.Threading.CancellationTokenRegistration Register (Action<object?,System.Threading.CancellationToken> callback, object? state);

member this.Register : Action<obj, System.Threading.CancellationToken> * obj -> System.Threading.CancellationTokenRegistration

Public Function Register (callback As Action(Of Object, CancellationToken), state As Object) As CancellationTokenRegistration

Parâmetros

callback

Action<Object,CancellationToken>

O delegado a ser executado quando CancelToken for cancelado.

state

Object

O estado a ser passado para a callback quando o delegado é invocado. Isso pode ser null.

Retornos

CancellationTokenRegistration

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

Exceções

ArgumentNullException

callback é null.

Comentários

Se esse token já estiver no estado cancelado, o delegado será executado de forma imediata e síncrona. Qualquer exceção gerada pelo delegado será propagada dessa chamada de método. O atual ExecutionContext, se existir, é capturado junto com o delegado e é usado ao executá-lo. A corrente SynchronizationContext não é capturada.

Register(Action<Object>, Object)

Registra um delegado que será chamado quando este 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);

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 for cancelado.

state

Object

O estado a ser passado para a callback quando o delegado é invocado. Isso pode ser nulo.

Retornos

CancellationTokenRegistration

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

Exceções

ObjectDisposedException

O CancellationTokenSource associado foi descartado.

ArgumentNullException

callback é nulo.

Comentários

Se esse token já estiver no estado cancelado, o delegado será executado de forma imediata e 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

• Cancelamento
• Cancelamento da tarefa
• Como: registrar retornos de chamada para solicitações de cancelamento

Register(Action<Object>, Object, Boolean)

Registra um delegado que será chamado quando este 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);

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 for cancelado.

state

Object

O estado a ser passado para a callback quando o delegado é invocado. Isso pode ser nulo.

useSynchronizationContext

Boolean

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

Retornos

CancellationTokenRegistration

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

Exceções

ObjectDisposedException

O CancellationTokenSource associado foi descartado.

ArgumentNullException

callback é nulo.

Comentários

Se esse token já estiver no estado cancelado, o delegado será executado de forma imediata e 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 for 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

• Cancelamento
• Cancelamento da tarefa
• Como: registrar retornos de chamada para solicitações de cancelamento