Skip to content

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

GLN_API gln_status_t GLN_CALL gln_generate_ebics_ini_brief(
    gln_backend_t*                   in_backend,
    const gln_ebics_brief_request_t* in_request_or_null,
    char**                           out_brief_text,
    gln_error_t*                     out_error);
  • Family: Backend operations
  • Return type: gln_status_t

Purpose

gln_generate_ebics_ini_brief renders the EBICS INI brief text for the current client keys.

Return

Returns GLN_OK when the call produced caller-owned output in out_brief_text. Failures return a non-OK status directly.

TypeNullabilityOwnership
gln_status_tvaluevalue

Parameters

NameDirectionTypeNullabilityOwnership
in_backendinputgln_backend_t*nonnullborrowed
in_request_or_nullinputconst gln_ebics_brief_request_t*nullableborrowed
out_brief_textoutputchar**nonnulltransferred_out
out_erroroutputgln_error_t*nullablecaller_allocated_output

Call Contract

GLN_OK from the function means caller-owned direct output was produced in *out_brief_text.

out_brief_text == NULL is an invalid-argument case. In that case the function returns GLN_ERR_INVALID_ARG directly.

out_error may be NULL; when supplied, non-OK returns populate it with caller-releasable error details.

The parameter table is binding for required handles and output slots.

in_request_or_null may be NULL; otherwise initialize it with gln_default_ebics_brief_request. out_error may be NULL.

Ownership And Lifetime

The string returned through out_brief_text is caller-owned and must be released with gln_release_string.

The backend handle, request pointer, and optional error output are borrowed for the duration of the call.

See Also