Lua:generateAPIHookScript

<> Lua API Reference

function generateAPIHookScript(address, addresstojumpto, addresstogetnewcalladdress OPTIONAL, ext OPTIONAL, targetself OPTIONAL) : string

Generates an Auto Assembler script that hooks the given address when the script is executed.

Function Parameters

Parameter	Type	Description
address	CEAddressString	The address or symbol to hook.
addresstojumpto	CEAddressString	The address or symbol the hook should jump to.
addresstogetnewcalladdress	CEAddressString OPTIONAL	Optional address or symbol used by the generated hook script to get the new call address.
ext	CEAddressString OPTIONAL	Optional extension text used by the generated script.
targetself	Boolean OPTIONAL	Optional flag that controls whether the generated hook targets the current process context.

Returns

String — The generated Auto Assembler script.

Examples

Generate an API hook script

1 local script = generateAPIHookScript("kernel32.dll+1234", "MyHook")
2 
3 print(script)

Generate and execute the hook script

1 local script = generateAPIHookScript("kernel32.dll+1234", "MyHook")
2 
3 if script ~= nil and script ~= "" then
4   autoAssemble(script)
5 end

Use symbols as hook targets

1 local script = generateAPIHookScript("SomeModule.SomeAPI", "MyAPIHook")
2 
3 print(script)

Use the optional new-call-address parameter

1 local script = generateAPIHookScript("SomeModule.SomeAPI", "MyAPIHook", "NewCallAddress")
2 
3 print(script)

Use all optional parameters

1 local script = generateAPIHookScript("SomeModule.SomeAPI", "MyAPIHook", "NewCallAddress", "", false)
2 
3 print(script)

Save the generated script to a file

 1 local script = generateAPIHookScript("SomeModule.SomeAPI", "MyAPIHook")
 2 
 3 if script ~= nil then
 4   local file = io.open([[C:\\Temp\\generated_hook.cea]], "w")
 5 
 6   if file ~= nil then
 7     file:write(script)
 8     file:close()
 9   end
10 end

Preview before execution

1 local script = generateAPIHookScript("SomeModule.SomeAPI", "MyAPIHook")
2 
3 if script ~= nil then
4   print("Generated script:")
5   print(script)
6 end

Main Pages

Core Lua documentation entry points

◆ Lua
◆ Script Engine