Editing terminateThread - FilterMeisterWiki

When saving, enter the following:

 __        __  _    _   _    _ ##   ##             
 \ \      / / | |  | | | |  | |###  ##       /\    
  \ \ /\ / /  | |__| | | |  | |#### ##      /  \   
   \ V  V /   |  __  | | |  | |## ####     / /\ \  
    \_/\_/    | |  | | | |__| |##  ###    / ____ \ 
              |_|  |_|  \____/ ##   ##   /_/    \_\
                               ##   ##

Visit Preferences to set your user name

= terminateThread =

== Syntax ==
{{bool terminateThread(int hThread)}}

== Arguments ==
:'''hThread'''
:: Specifies the handle of the thread which we wish to terminate, or 0 to terminate all current worker threads.

== Return ==
Returns ((true)) if all specified threads have terminated, or ((false)) if an error occurred.

== Description ==
Use this function to terminate one or all worker threads that were created by calling ((triggerThread)). To terminate one particular thread, set the '''hThread''' parameter to the value of the thread handle that was returned by the call to ((triggerThread)). To terminate all current worker threads, set the '''hThread''' parameter to 0.

'''Note''': This API can be dangerous to use, since forcibly terminating a thread can result in failure to release resources owned by the thread, and DLLs attached to the thread are not notified that the thread is terminating. Use this API only when absolutely necessary. For more details, see the documentation of the Windows [https://docs.microsoft.com/en-us/windows/win32/api/processthreadsapi/nf-processthreadsapi-terminatethread TerminateThread API].

== Comments ==
The current implementation of '''terminateThread''' recognizes only a parameter of 0 to terminate all threads; you '''cannot''' specify a thread handle to terminate a specific thread.

== Example ==
See the example in ((triggerThread)).

== See Also ==
((System Functions)), ((System Functions|Multithreading Functions#Multithreading-Functions)), ((countProcessors)), ((triggerThread)), ((waitForThread)), ((isThreadActive)), ((getThreadRetVal))

Summary of change:
Add document to category: