GALANTHUS / ABI FUNCTION REFERENCE
gln_get_balance_overdraft
Declared in <galanthus/c_api/gln_capi.h>.
GLN_API const char* GLN_CALL gln_get_balance_overdraft(const gln_balance_t* in_balance);
Purpose
Returns the overdraft amount when available.
Return
Returns the provider's overdraft amount text when supplied. The field is distinct from the booked balance amount and the credit line. Returns NULL when the optional field is not materialized or when the input handle is NULL.
| Type | Nullability | Ownership |
|---|---|---|
const char* | nullable | borrowed |
Parameters
| Name | Direction | Type | Nullability | Ownership |
|---|---|---|---|---|
in_balance | input | const gln_balance_t* | nullable | borrowed |
Amount Semantics
Returns the provider's overdraft amount text when supplied. The field is distinct from the booked balance amount and the credit line.
NULL means the materialized balance row has no overdraft field.
Notes
Passing NULL for in_balance is allowed and returns NULL.
NULL means the provider did not supply this optional field for the row.
The returned pointer is borrowed from the owning backend result envelope and becomes invalid when that envelope is destroyed.