Difference between revisions of "Lua:getWindowCaption"

From Cheat Engine
Jump to navigation Jump to search
(Major overhaul of the post.)
m (Syntax Highlighting.)
 
Line 21: Line 21:
  
 
===Examples===
 
===Examples===
<pre>
+
<syntaxhighlight lang="lua" line>
 
local form = createForm()
 
local form = createForm()
 
form.Caption = "Example Window"
 
form.Caption = "Example Window"
Line 28: Line 28:
  
 
print(caption)
 
print(caption)
</pre>
+
</syntaxhighlight>
  
<pre>
+
<syntaxhighlight lang="lua" line>
 
local mainForm = getMainForm()
 
local mainForm = getMainForm()
  
Line 37: Line 37:
 
   print("Main form caption: " .. tostring(caption))
 
   print("Main form caption: " .. tostring(caption))
 
end
 
end
</pre>
+
</syntaxhighlight>
  
<pre>
+
<syntaxhighlight lang="lua" line>
 
local memoryView = getMemoryViewForm()
 
local memoryView = getMemoryViewForm()
  
Line 45: Line 45:
 
   print(getWindowCaption(memoryView.Handle))
 
   print(getWindowCaption(memoryView.Handle))
 
end
 
end
</pre>
+
</syntaxhighlight>
  
 
===Notes===
 
===Notes===

Latest revision as of 19:53, 25 June 2026

<> Lua API Reference

function getWindowCaption(windowhandle) : string

Returns the caption text of a window.

The window is identified by its window handle.

Function Parameters[edit]

Parameter Type Description
windowhandle Integer The handle of the window whose caption should be returned.

Returns[edit]

String — The caption text of the specified window.

Examples[edit]

1 local form = createForm()
2 form.Caption = "Example Window"
3 
4 local caption = getWindowCaption(form.Handle)
5 
6 print(caption)
1 local mainForm = getMainForm()
2 
3 if mainForm ~= nil then
4   local caption = getWindowCaption(mainForm.Handle)
5   print("Main form caption: " .. tostring(caption))
6 end
1 local memoryView = getMemoryViewForm()
2 
3 if memoryView ~= nil then
4   print(getWindowCaption(memoryView.Handle))
5 end

Notes[edit]

  • The function requires a valid window handle.
  • For Cheat Engine controls and forms, the Handle property can usually be used.
  • For normal Cheat Engine form objects, reading the Caption property directly is usually simpler.

Main Pages

Core Lua documentation entry points

Lua
Script Engine

Form Related Classes