slot_type

Retrieve the field code of an object in a slot and, optionally, some other information

Behaviour

C

• Locate the object pointed to by the specified slot_no

• Determine its sf field code and return this, or some other information (see below) if flags are used

Javascript

• Retrieves the type of the specified slot.

• Returns an error code or the type of the slot.

Definition

C

int64_t slot_type (
    uint32_t slot_no,
    uint32_t flags
);

Javascript

function slot_type(slotno: number, flags: number): ErrorCode | number

Example

C

int64_t fidle_code = 
    slot_type(1, 0);

Javascript

const field_code = slot_type(1, 0)

Parameters

C

Name	Type	Description
slot_no	uint32_t	The slot number
flags	uin32_t	For normal operation this should be 0. To determine whether or not an STI_AMOUNT type contains a native (XAH) amount or a floating point (IOU) amount set to 1.

Javascript

Name	Type	Description
slotno	number	The slot number to check the type of.
flags	number	Flags to determine the type.

Return Code

C

Type	Description
int64_t	If flags is 0 then: The sf field code of the slotted object If flags is 1 then: 1 if and only if the slotted object is an STI_AMOUNT and the type of the amount is XAH. If negative, an error: DOESNT_EXIST - the specified slot_no does not contain an object. NOT_AN_AMOUNT - flags was set to 1 but the slotted object is not an STI_AMOUNT object

Javascript

Type	Description
ErrorCode or number	Returns an error code or the type of the slot.