GALANTHUS / ABI FUNCTION REFERENCE
gln_get_standing_order_amount
Declared in <galanthus/c_api/gln_capi.h>.
GLN_API const char* GLN_CALL gln_get_standing_order_amount(const gln_standing_order_t* in_standing_order);
Purpose
Returns the standing-order amount as a decimal string.
Return
Returns the standing-order amount as a borrowed decimal string. The currency is exposed separately by gln_get_standing_order_currency.
| Type | Nullability | Ownership |
|---|---|---|
const char* | nullable | borrowed |
Parameters
| Name | Direction | Type | Nullability | Ownership |
|---|---|---|---|---|
in_standing_order | input | const gln_standing_order_t* | nullable | borrowed |
Amount And Purpose
Returns the standing-order amount as a borrowed decimal string. The currency is exposed separately by gln_get_standing_order_currency.
For a valid row the returned pointer is non-null. An empty string means no amount text was materialized for the row.
Notes
Passing NULL for in_standing_order 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.