Function sto_subarray

Source
pub unsafe extern "C" fn sto_subarray(
    read_ptr: u32,
    read_len: u32,
    array_id: u32,
) -> i64
Expand description

Index into a xrpld serialized array and return the location and length of an index. Unlike sto_subfield this api always returns the offset and length of the whole object at that index (not its payload.) Use SUB_OFFSET and SUB_LENGTH macros to extract return value. @param read_ptr The memory location of the stobject @param read_len The length of the stobject @param array_id The index requested @return high-word (most significant 4 bytes excluding the most significant bit (MSB)) is the field offset relative to read_ptr and the low-word (least significant 4 bytes) is its length. MSB is sign bit, if set (negative) return value indicates error (typically error means could not find.)