Index into a xahaud serialized object and return the location and length of a subfield
Parse a STObject pointed to by read_ptr
Find the field specified by field_id
If the field is found, and:
It is an array, then return the start and length of the array including the leadin/leadout bytes, or
It is not an array, then return the start and length of the PAYLOAD of the field (excluding the leadin bytes).
🚧Field ID encodingThe
sto_apis accept afield_idparameter encoded as follows:(type << 16U) + fieldThus type 1 field 2 would be0x10002U.
C
C
📘hookmacro.h already contains the
SUB_OFFSETandSUB_LENGTHmacros.
read_ptr
uint32_t
Pointer to the buffer containing the STObject
read_len
uint32_t
Length of STObject
field_id
uint32_t
The sf code of the field you are searching for.
To compute this manually take the serialized type and shift it into the 16 highest bits of uint32_t, then take the field and place it in the 16 lowest bits.
For example:
sfEmitNonce has type 5 and field 11 thus its value is 0x050BU
int64_t
The location of the field within the specified buffer:
- The high 32 bits are the offset location.
- The low 32 bits are the length.
If negative, an error:
OUT_OF_BOUNDS
- pointers/lengths specified outside of hook memory.
TOO_SMALL
- Input buffer isn't large enough to possibly contain a valid STObject.
DOESNT_EXIST
- The searched for field isn't present in the supplied STObject.
PARSE_ERROR
- The supplied STObject is malformed or not an STObject.