GALANTHUS / ABI FUNCTION REFERENCE
gln_get_balance_status
Declared in <galanthus/c_api/gln_capi.h>.
GLN_API const char* GLN_CALL gln_get_balance_status(const gln_balance_t* in_balance);
Purpose
Returns the balance status stored on the row.
Return
Returns the balance status stored on the row. Owned producers materialize booked balances as booked.
| Type | Nullability | Ownership |
|---|---|---|
const char* | nullable | borrowed |
Parameters
| Name | Direction | Type | Nullability | Ownership |
|---|---|---|---|---|
in_balance | input | const gln_balance_t* | nullable | borrowed |
Balance Semantics
Returns the balance status stored on the row. Owned producers materialize booked balances as booked.
Treat the value as open row data; compare only status values the caller explicitly recognizes.
Notes
Passing NULL for in_balance is allowed and returns NULL.
Rows returned by the matching _at accessor carry this field as part of the materialized typed result.
The returned pointer is borrowed from the owning backend result envelope and becomes invalid when that envelope is destroyed.