on_thread_termination Event

Fires when a thread is being terminated.

Syntax

class CBProcessThreadTerminationEventParams(object):
  @property
  def process_id() -> int: ...
  @property
  def thread_id() -> int: ...
  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBProcess:
@property
def on_thread_termination() -> Callable[[CBProcessThreadTerminationEventParams], None]: ...
@on_thread_termination.setter
def on_thread_termination(event_hook: Callable[[CBProcessThreadTerminationEventParams], None]) -> None: ...

Remarks

This event fires when a thread is being terminated.

Applications cannot prevent a thread from being terminated using this event; use the on_thread_handle_operation event instead.

The ProcessId parameter reflects the Id of process whose thread is being terminating.

The ThreadId parameter reflects the Id of the terminating thread.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource isn't available, security checks failed, etc.), set it to a non-zero value to report an appropriate error. Please refer to the Error Reporting and Handling topic for more information.

Note that the system APIs offer no way to report errors which occur during the processing of this request. Exceptional ResultCode values are therefore largely ignored.

This event is fired synchronously; please refer to the Event Types topic for more information.