Remove a field from an STObject
Parse an STObject pointed to by read_ptr
Write a new STObject to write_ptr but without field_id if it was present in the original object.
C
🚧Field ID encodingThe
sto_apis accept afield_idparameter encoded as follows:(type << 16U) + fieldThus type 1 field 2 would be0x10002U.
C
📘Emplace equivalence
sto_eraseis the same assto_emplacewith0,0forfield_ptr, field_lenparameters.
write_ptr
uint32_t
The buffer to write the modified STObject to
write_len
uint32_t
The length of the output buffer
read_ptr
uint32_t
The buffer to read the source STObject from
read_len
uint32_t
The Length of the source object
field_id
uint32_t
The sf code (location) to erase
int64_t
The number of bytes written to write_ptr
If negative, an error:
OUT_OF_BOUNDS
- pointers/lengths specified outside of hook memory.
TOO_SMALL
- Output buffer must be at least as large as the source object.
TOO_BIG
- Field you are attempting to erase from is too large
PARSE_ERROR
- The supplied STObject is malformed or not an STObject.
DOESNT_EXIST
- The specified field_id isn't present in the STObject.