NumPut

AutoHotkey GUI

NumPut

Stores a number in binary format at the specified address+offset.

NumPut(Number, VarOrAddress , Offset := 0, Type := "UPtr")

Parameters

Number

The number to store.

VarOrAddress

A memory address or variable. If VarOrAddress is a variable such as MyVar, the address of the variable's string buffer is used. This is usually equivalent to passing &MyVar, but omitting the "&" performs better and ensures that the target address + offset is valid.

Do not pass a variable reference if the variable contains the target address; in that case, pass an expression such as MyVar+0.

Offset

An offset - in bytes - which is added to VarOrAddress to determine the target address.

Type

One of the following strings (defaults to UPtr if omitted):
UInt, Int, Int64, Short, UShort, Char, UChar, Double, Float, Ptr or UPtr

Unlike DllCall, these must be enclosed in quotes when used as literal strings.

For details see DllCall Types.

Return Value

If the target address is invalid, an empty string is returned. However, some invalid addresses cannot be detected as such and may cause unpredictable behaviour.

Otherwise, the address to the right of the item just written is returned. This is often used when writing a sequence of numbers of different types, such as in a structure for use with DllCall.

General Remarks

If an integer is too large to fit in the specified Type, its most significant bytes are ignored; e.g. NumPut(257, var, 0, "Char") would store the number 1.

If only three parameters are present, the third parameter can be either Offset or Type. For example, NumPut(x, var, "int") is valid.

Related

NumGet, DllCall, VarSetCapacity