Difference between revisions of "Lua:readString"
Jump to navigation
Jump to search
m (Syntax Highlighting.) |
|||
| (10 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | '''function''' readString(''Address'', '' | + | [[Category:Lua]] |
| + | {{CodeBox|'''function''' readString(''Address'', ''MaxLength'', [''WideChar'']) ''':''' String}} | ||
| − | Reads the | + | 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=== | ===Function Parameters=== | ||
| − | {|width="85%" cellpadding="10 | + | {|width="85%" cellpadding="10%" cellspacing="0" border="0" |
!align="left"|Parameter | !align="left"|Parameter | ||
!align="left"|Type | !align="left"|Type | ||
| Line 10: | Line 13: | ||
|- | |- | ||
|Address | |Address | ||
| − | |[[CEAddressString]] | + | |Integer or [[CEAddressString]] |
| − | |The address to read | + | |The address in the target process to read from. |
|- | |- | ||
| − | | | + | |MaxLength |
|Integer | |Integer | ||
| − | |The maximum number of characters to read. | + | |The maximum number of characters to read (prevents infinite loops; use 6000 if you don't care). |
|- | |- | ||
| − | | | + | |WideChar |
| − | |Boolean | + | |Boolean (optional) |
| − | | | + | |Set to true to read as a widechar (UTF-16/Unicode) string. Default is false (ASCII/ANSI). |
|} | |} | ||
| − | == | + | ===Returns=== |
| − | + | String — The string read from the specified address. | |
| − | |||
| − | === | + | ===Examples=== |
| − | + | <syntaxhighlight lang="lua" line> | |
| − | + | -- 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) | |
| − | + | </syntaxhighlight> | |
| − | + | ||
| − | + | {{LuaSeeAlso}} | |
| − | + | ||
| − | + | {{RelatedStrings}} | |
| − | + | ||
| − | + | {{ReadWriteMemory}} | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Latest revision as of 15:36, 25 June 2026
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]
1 -- Read an ASCII string from address 0x123456, up to 100 characters
2 local str = readString(0x123456, 100)
3 print("String:", str)
4
5 -- Read a widechar (Unicode) string from a CEAddressString
6 local wstr = readString("game.exe+1234", 256, true)
7 print("Wide string:", wstr)
