slot_subarray

Behaviour

C

• Look up the array in slot parent_slot
• Retrieve the sub-object at the index specified in array_id
• Place sub-object into the slot new_slot or the next available slot if new_slot is 0.
• Return the new slot number.

JavaScript

• Creates a subarray in the specified parent slot.
• Returns an error code or the result of the subarray creation.

Definition

C

int64_t slot_subarray (
    uint32_t parent_slot,
    uint32_t array_id,
    uint32_t new_slot
);

JavaScript

function slot_subarray(
    parent_slotno: number,
    array_id: number,
    new_slotno: number
  ): ErrorCode | number

Example

C

int64_t subslot = 0;
subslot =
    slot_subarray(slot_no, i, (uint32_t)subslot);

JavaScript

let subslot = 0
subslot = slot_subarray(slot_no, i, subslot)

Parameters

C

Name	Type	Description
parent_slot	uint32_t	Slot the parent array is in
array_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
new_slot	uint32_t	New slot number to place the object from the selected array index into. If null, choose the next available slot. May be null.

JavaScript

Name	Type	Description
parent_slotno	number	The parent slot number.
array_id	number	The ID of the array to create a subarray for.
new_slotno	number	The new slot number for the subarray.

Return Code

C

Type	Description
int64_t	The slot number of the newly allocated object If negative, an error: DOESNT_EXIST - The specified array_id doesn’t exist in the array pointed to by parent_slot NO_FREE_SLOTS - The API would require a new slot to be allocated but the Hook is already at the maximum number of slots. NOT_AN_ARRAY - The specified parent_slot does not contain an STArray.

JavaScript

Type	Description
number	Returns an error code or the result of the subarray creation.