Lua:readString

From Cheat Engine
Jump to navigation Jump to search

function readString(Address, MaxLength, [WideChar]) : String

Reads a string from the specified address in the currently opened (target) process until a 0-terminator is encountered. The maximum number of characters to read is limited by MaxLength to prevent freezing. Set WideChar to true if the string is encoded using widechar (UTF-16/Unicode) formatting.

Function Parameters[edit]

Parameter Type Description
Address Integer or CEAddressString The address in the target process to read from.
MaxLength Integer The maximum number of characters to read (prevents infinite loops; use 6000 if you don't care).
WideChar Boolean (optional) Set to true to read as a widechar (UTF-16/Unicode) string. Default is false (ASCII/ANSI).

Returns[edit]

String — The string read from the specified address.

Examples[edit]

-- Read an ASCII string from address 0x123456, up to 100 characters
local str = readString(0x123456, 100)
print("String:", str)

-- Read a widechar (Unicode) string from a CEAddressString
local wstr = readString("game.exe+1234", 256, true)
print("Wide string:", wstr)

See also[edit]

Related Functions[edit]