Difference between revisions of "Lua:getNameFromAddress"

From Cheat Engine
Jump to navigation Jump to search
m
m (Added related function template.)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
[[Category:Lua]]
 
[[Category:Lua]]
−
'''function''' getNameFromAddress(''Address'', [''ModuleNames''], [''Symbols''], [''Sections'']) ''':''' String
+
{{CodeBox|'''function''' getNameFromAddress(''address'', ''ModuleNames'', ''Symbols'', ''Sections'') ''':''' string}}
  
−
Returns the given address as a string representation.
+
Returns the given address as a string.
−
Depending on the address and the options, this may return a registered symbol name, <code>modulename+offset</code>, or just a hexadecimal string.
+
 
 +
Depending on the address and the enabled lookup options, the returned string can be a registered symbol name, a module name with offset, a section name with offset, or a hexadecimal address string.
  
 
===Function Parameters===
 
===Function Parameters===
Line 11: Line 12:
 
!style="width: 80%;background-color:white;" align="left"|Description
 
!style="width: 80%;background-color:white;" align="left"|Description
 
|-
 
|-
−
|Address
+
|address
 
|Integer or [[CEAddressString]]
 
|Integer or [[CEAddressString]]
−
|The address to convert to a string.
+
|The address to convert to a readable name string.
 
|-
 
|-
 
|ModuleNames
 
|ModuleNames
 
|Boolean (optional)
 
|Boolean (optional)
−
|If true (default), allows returning <code>modulename+offset</code> if possible.
+
|If true, module names may be used when formatting the returned address string. Defaults to true.
 
|-
 
|-
 
|Symbols
 
|Symbols
 
|Boolean (optional)
 
|Boolean (optional)
−
|If true (default), allows returning registered symbol names if available.
+
|If true, registered symbols may be used when formatting the returned address string. Defaults to true.
 
|-
 
|-
 
|Sections
 
|Sections
 
|Boolean (optional)
 
|Boolean (optional)
−
|If true, allows returning section names. Default is false.
+
|If true, section names may be used when formatting the returned address string. Defaults to false.
 
|}
 
|}
  
 
===Returns===
 
===Returns===
−
String — The string representation of the address.
+
string — The given address represented as a readable string.
  
 
===Examples===
 
===Examples===
−
<pre>
+
<syntaxhighlight lang="lua" line>
−
-- Get the name for an address, preferring symbols and module names
+
local address = getAddress("KERNEL32.AddAtomA")
−
local name = getNameFromAddress(0x401000)
+
local name = getNameFromAddress(address)
 +
 
 
print(name)
 
print(name)
−
-- cheatengine-x86_64-SSE4-AVX2.exe+1000
+
</syntaxhighlight>
  
−
-- Only return hexadecimal if no symbol or module name is available
+
<syntaxhighlight lang="lua" line>
−
local hexOnly = getNameFromAddress(0x401000, false, false)
+
local address = getAddress("KERNEL32.AddAtomA")
−
print(hexOnly)
+
 
−
-- 00401000
+
-- Allow module names and symbols, but do not include section names
−
</pre>
+
local name = getNameFromAddress(address, true, true, false)
 +
 
 +
print(name)
 +
</syntaxhighlight>
 +
 
 +
<syntaxhighlight lang="lua" line>
 +
local address = getAddress("KERNEL32.AddAtomA")
 +
 
 +
-- Return a more raw representation by disabling module names, symbols, and sections
 +
local name = getNameFromAddress(address, false, false, false)
 +
 
 +
print(name)
 +
</syntaxhighlight>
  
 
{{LuaSeeAlso}}
 
{{LuaSeeAlso}}
  
−
=== Related Functions ===
+
{{Address}}
−
* [[Lua:getAddress|getAddress]]
 
−
* [[Lua:getCommonModuleList|getCommonModuleList]]
 
−
* [[Lua:inModule|inModule]]
 
−
* [[Lua:inSystemModule|inSystemModule]]
 
−
* [[Lua:targetIs64Bit|targetIs64Bit]]
 
−
* [[Lua:enumModules|enumModules]]
 

Latest revision as of 22:48, 26 June 2026

<> Lua API Reference

function getNameFromAddress(address, ModuleNames, Symbols, Sections) : string

Returns the given address as a string.

Depending on the address and the enabled lookup options, the returned string can be a registered symbol name, a module name with offset, a section name with offset, or a hexadecimal address string.

Function Parameters[edit]

Parameter Type Description
address Integer or CEAddressString The address to convert to a readable name string.
ModuleNames Boolean (optional) If true, module names may be used when formatting the returned address string. Defaults to true.
Symbols Boolean (optional) If true, registered symbols may be used when formatting the returned address string. Defaults to true.
Sections Boolean (optional) If true, section names may be used when formatting the returned address string. Defaults to false.

Returns[edit]

string — The given address represented as a readable string.

Examples[edit]

1 local address = getAddress("KERNEL32.AddAtomA")
2 local name = getNameFromAddress(address)
3 
4 print(name)

1 local address = getAddress("KERNEL32.AddAtomA")
2 
3 -- Allow module names and symbols, but do not include section names
4 local name = getNameFromAddress(address, true, true, false)
5 
6 print(name)

1 local address = getAddress("KERNEL32.AddAtomA")
2 
3 -- Return a more raw representation by disabling module names, symbols, and sections
4 local name = getNameFromAddress(address, false, false, false)
5 
6 print(name)

Main Pages

Core Lua documentation entry points

◆ Lua
◆ Script Engine

Symbol Related Lua Functions

Symbol lookup, address resolution, module checks, and lookup callbacks



Retrieved from "https://wiki.cheatengine.org/index.php?title=Lua:getNameFromAddress&oldid=8400"