GALANTHUS / ABI FUNCTION REFERENCE
gln_get_tan_mode_at
Declared in <galanthus/c_api/gln_capi.h>.
GLN_API const gln_tan_mode_t* GLN_CALL gln_get_tan_mode_at(
const gln_tan_modes_t* in_tan_modes,
size_t in_index);
Purpose
Returns the TAN mode row at in_index from a gln_tan_modes_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_tan_mode_t* | nullable | borrowed |
Parameters
| Name | Direction | Type | Nullability | Ownership |
|---|---|---|---|---|
in_tan_modes | input | const gln_tan_modes_t* | nullable | borrowed |
in_index | input | size_t | value | value |
Collection Semantics
Indexes are zero-based over the TAN mode rows materialized in this gln_tan_modes_t view.
The returned row is borrowed from the typed TAN mode 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_tan_modes is allowed and returns NULL.
Indexes are zero-based. The accessor returns NULL when in_index >= gln_get_tan_modes_count(in_tan_modes).
The returned row is borrowed from the parent envelope through the TAN modes view and must not be released directly.