Skip to content

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

GLN_API const char* GLN_CALL gln_get_error_detail_status_message(
    const gln_error_detail_t* in_detail,
    size_t                    in_index);
  • Family: Error and interrupt accessors
  • Return type: const char*

Purpose

Returns the status message for one status row in a FinTS rejected or common rejected error detail payload.

Return

Returns the status message from the error detail, or NULL when it is not available.

TypeNullabilityOwnership
const char*nullableborrowed

Parameters

NameDirectionTypeNullabilityOwnership
in_detailinputconst gln_error_detail_t*nullableborrowed
in_indexinputsize_tvaluevalue

Notes

Passing NULL for in_detail is allowed and returns NULL.

The accessor returns NULL for detail kinds other than GLN_ERROR_DETAIL_FINTS_REJECTED or GLN_ERROR_DETAIL_COMMON_REJECTED, or when in_index is outside gln_get_error_detail_status_count(in_detail).

The returned string is borrowed from the owning detail object. Copy it before calling gln_release_error on the owning error or destroying the backend result envelope that owns that error.

See Also