gln_get_direct_debit_submission_provider_status_at

Declared in <galanthus/c_api/gln_capi.h>.

GLN_API const gln_provider_status_t* GLN_CALL gln_get_direct_debit_submission_provider_status_at(
    const gln_direct_debit_submission_t* in_submission,
    size_t                               in_index);

Family: Count and at accessors
Return type: const gln_provider_status_t*

Purpose

Returns the element at in_index from the direct-debit submission. The accessor returns NULL when the index is outside the reported count.

Returned pointers are borrowed from the parent result object and must not be released directly.

Rows are EBICS provider-status rows populated from the EBICS order status. FinTS direct-debit submissions expose no provider-status rows.

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_provider_status_t*`	nullable	borrowed

Parameters

Name	Direction	Type	Nullability	Ownership
`in_submission`	input	`const gln_direct_debit_submission_t*`	nullable	borrowed
`in_index`	input	`size_t`	value	value

Provider Status Row Semantics

These accessors read the provider-status rows materialized on a successful EBICS transfer, batch-transfer, or direct-debit submission. EBICS success submissions expose provider-status rows from the EBICS outer order status. FinTS success submissions expose no provider-status rows for these submission views; unsupported backend kinds do not produce these success submission views.

Field	Meaning
`kind`	`GLN_PROVIDER_STATUS_KIND_EBICS` for rows exposed by these submission accessors.
`code_or_null`	EBICS business code when the order status carries one; otherwise the EBICS technical code.
`subcode_or_null`	EBICS technical code when `code_or_null` carries a business code; otherwise `NULL`.
`message_or_null`	Galanthus summary of the EBICS status, built from the technical status and any business status text.
`reference_or_null`	EBICS transaction ID when present; otherwise the EBICS order ID when present; otherwise `NULL`.
`provider_text_or_null`	Raw EBICS status fields formatted as provider text for diagnostics.

Use the corresponding _count function as the exclusive upper bound for _at. A null submission handle or an out-of-range index yields count 0 or row pointer NULL, depending on the accessor.

Provider Status Row Lifetime

Rows returned by _at are borrowed from the typed submission view. The row object and every const char* field in it remain valid only while the owning gln_backend_result_t envelope is alive.

Copy any string field that must outlive the backend result envelope. Do not release the row pointer or any string field directly.

Notes

Passing NULL for in_submission is allowed and returns NULL.

The returned pointer is borrowed from the owning backend result envelope and becomes invalid when that envelope is destroyed.