etxn_details

Concepts

Emitted Transactions

Behaviour

Generate and write a 105 byte sfEmitDetails object into the write_ptr if cbak is not defined
Generate and write a 127 byte sfEmitDetails object into the write_ptr if cbak is defined.

Definition

int64_t etxn_details (
    uint32_t write_ptr,
  	uint32_t write_len
);

Example

uint8_t emitdet[105];
int64_t result =
    etxn_details(emitdet, 105);
if (result != 105)
    rollback("Etxndetails failed.", 19, 1);

Parameters

Name	Type	Description
write_ptr	uint32_t	Pointer to the buffer receiving the sfEmitDetails record
write_len	uint32_t	Length of the buffer

Return Code

Type Description

int64_t The number of bytes written.

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

TOO_SMALL
- Buffer isn't large enough to receive record

PREREQUISITE_NOT_MET
- The hook failed to call etxn_reserve(n) first

FEE_TOO_LARGE
- The burden would be too high for the network to allow.

INTERNAL_ERROR
- A generic error in which rippled had trouble generating the required field.

Type	Description
int64_t	The number of bytes written. If negative, an error: `OUT_OF_BOUNDS` - pointers/lengths specified outside of hook memory. `TOO_SMALL` - Buffer isn't large enough to receive record `PREREQUISITE_NOT_MET` - The hook failed to call `etxn_reserve(n)` first `FEE_TOO_LARGE` - The burden would be too high for the network to allow. `INTERNAL_ERROR` - A generic error in which rippled had trouble generating the required field.