These docs are for v2.0. Click to read the latest docs for v3.0.

Write a XFL float to the XRPLD trace log

Behaviour

  • Write a XFL floating point to the trace log along with a message (if any)

Definition

int64_t trace_float (
    uint32_t mread_ptr,
    uint32_t mread_len,
  	int64_t float1 
);

Example

#define SBUF(str) (uint32_t)(str), sizeof(str)
trace_float(SBUF("This is a float"), float_one());

Parameters

NameTypeDescription
rmead_ptruint32_tPointer to a message to output before the hex-encoded serialized object found in the slot. May be null.
mread_lenuint32_tLength of the message. May be null.
float1int64_tThe enclosing XFL integer.

Return Code

TypeDescription
int64_t0 if successful

If negative, an error:
OUT_OF_BOUNDS
- pointers/lengths specified outside of hook memory.