Skip to content

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

GLN_API gln_error_detail_kind_t GLN_CALL gln_get_error_detail_kind(const gln_error_detail_t* in_detail);
  • Family: Error and interrupt accessors
  • Return type: gln_error_detail_kind_t

Purpose

Returns the structured detail payload kind stored in a borrowed gln_error_detail_t handle.

Return

Returns the kind from the error detail.

TypeNullabilityOwnership
gln_error_detail_kind_tvaluevalue

Parameters

NameDirectionTypeNullabilityOwnership
in_detailinputconst gln_error_detail_t*nullableborrowed

Notes

Passing NULL for in_detail is allowed and returns GLN_ERROR_DETAIL_NONE.

Use the returned kind to select the matching accessor family. Status and warning accessors apply to GLN_ERROR_DETAIL_FINTS_REJECTED and GLN_ERROR_DETAIL_COMMON_REJECTED; EBICS fields apply to GLN_ERROR_DETAIL_EBICS_STATUS; plugin and token accessors apply to their matching payload kinds.

The detail handle is borrowed from a gln_error_t. Releasing that error or destroying the backend result envelope that owns it invalidates the handle.

See Also