float_sto

write_ptr

uint32_t

Pointer to a buffer of a suitable size to store the serialized amount field. Recommend at least 48 bytes.

write_len

uint32_t

The length of the output buffer.

cread_ptr

uint32_t

Pointer to a buffer contianing the currency code to serialize into the output. May be null.

cread_len

uint32_t

The length of the currency code. This must be 20 or 3 or 0 (null).

iread_ptr

uint32_t

Pointer to a buffer containing the issuer's Account ID to serialize into the output. May be null.

iread_len

uint32_t

The length of the issuer's Account ID. This must be either 20 or 0 (null).

float1

int64_t

An XFL floating point enclosing number to serialize.

field_code

uint32_t

The sf field code to prefix the serialized amount with. E.g. sfAmount. If this field is 0xFFFFFFFFU (i.e. (uint32_t)(-1)) then no field code is prepended to the output, and no issuer or currency code is appended, but serialization proceeds as a floating point amount. If this field is 0 no field code is prepended to the output, and no issuer or currency code is appended, but serialization proceeds as though the amount is an XRP native amount rather than a floating point.

int64_t

The number of bytes written to the output buffer. If negative, an error: INVALID_FLOAT - the supplied float was not a valid XFL enclosing number OUT_OF_BOUNDS - pointers/lengths specified outside of hook memory. INVALID_ARGUMENT - If instructed to output as XRP or without field code then all non-write pointers and lengths should be 0 (null). TOO_SMALL - The output buffer was too small to receive the serialized object. XFL_OVERFLOW - Expressing the output caused an overflow during normalization.