GALANTHUS / ABI FUNCTION REFERENCE
gln_get_holding_at
Declared in <galanthus/c_api/gln_capi.h>.
GLN_API const gln_holding_t* GLN_CALL gln_get_holding_at(
const gln_holdings_t* in_holdings,
size_t in_index);
Purpose
Returns the holding row at in_index from a typed gln_holdings_t view.
Return
Returns the borrowed row or entry at in_index, or NULL when the handle is NULL or the index is out of range.
| Type | Nullability | Ownership |
|---|---|---|
const gln_holding_t* | nullable | borrowed |
Parameters
| Name | Direction | Type | Nullability | Ownership |
|---|---|---|---|---|
in_holdings | input | const gln_holdings_t* | nullable | borrowed |
in_index | input | size_t | value | value |
Collection Semantics
Indexes are zero-based over the security holding rows materialized in this gln_holdings_t view.
The returned row is borrowed from the typed holdings view. Row pointers and strings read from the row stay valid only while the owning backend result envelope is alive.
Notes
Passing NULL for in_holdings is allowed and returns NULL.
Indexes are zero-based. The accessor returns NULL when in_index >= gln_get_holdings_count(...).
The returned row is borrowed from the parent backend result envelope through the typed view and must not be released directly.