Difference between revisions of "Lua:getThreadlist"

From Cheat Engine
Jump to navigation Jump to search
(Created page with 'Category:Lua '''function''' getThreadlist(''StringList'') Fills a StringList object with the threadlist of the currently opened process. ===Function Parameters=== {|width=…')
 
m (Added related function template.)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
 
[[Category:Lua]]
 
[[Category:Lua]]
'''function''' getThreadlist(''StringList'')
+
{{CodeBox|'''function''' getThreadlist(''List'') ''':''' void}}
  
Fills a StringList object with the threadlist of the currently opened process.
+
Fills a List object with the thread list of the currently opened process.
  
 +
The thread IDs are added to the list as hexadecimal strings using the format ''%x''.
  
 
===Function Parameters===
 
===Function Parameters===
{|width="85%" cellpadding="10%" cellpadding="5%" cellspacing="0" border="0"
+
{|width="85%" cellpadding="10%" cellspacing="0" border="0"
 
!align="left"|Parameter
 
!align="left"|Parameter
 
!align="left"|Type
 
!align="left"|Type
 
!style="width: 80%;background-color:white;" align="left"|Description
 
!style="width: 80%;background-color:white;" align="left"|Description
 
|-
 
|-
|StringList
+
|List
|[[Lua:Class:Stringlist|Stringlist]]
+
|List
|The StringList to fill
+
|The list object that will be filled with the thread IDs of the currently opened process.
 
|}
 
|}
  
== Examples ==
+
===Returns===
<pre>
+
void — This function does not return any value.
local l = createStringlist()
+
 
getThreadlist(l)
+
===Examples===
for i = 1, l.Count do
+
<syntaxhighlight lang="lua" line>
print(l[i - 1])
+
local list = createStringlist()
 +
 
 +
getThreadlist(list)
 +
 
 +
for i = 0, list.Count - 1 do
 +
  print("Thread ID: " .. list[i])
 
end
 
end
</pre>
 
  
 +
list.destroy()
 +
</syntaxhighlight>
  
 
{{LuaSeeAlso}}
 
{{LuaSeeAlso}}
  
=== Related Functions ===
+
{{Threads}}
* [[Lua:getCPUCount|getCPUCount]]
 

Latest revision as of 20:52, 26 June 2026

<> Lua API Reference

function getThreadlist(List) : void

Fills a List object with the thread list of the currently opened process.

The thread IDs are added to the list as hexadecimal strings using the format %x.

Function Parameters[edit]

Parameter Type Description
List List The list object that will be filled with the thread IDs of the currently opened process.

Returns[edit]

void — This function does not return any value.

Examples[edit]

1 local list = createStringlist()
2 
3 getThreadlist(list)
4 
5 for i = 0, list.Count - 1 do
6   print("Thread ID: " .. list[i])
7 end
8 
9 list.destroy()

Main Pages

Core Lua documentation entry points

Lua
Script Engine

Thread Related Lua Functions

CPU information, process threads, main-thread execution, and queued callbacks