Skip to content

GALANTHUS / ABI FUNCTION REFERENCE

gln_get_transfer_submission_vop_explanatory_text

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

GLN_API const char* GLN_CALL gln_get_transfer_submission_vop_explanatory_text(
    const gln_transfer_submission_t* in_submission);
  • Family: Row field accessors
  • Return type: const char*

Purpose

Reads the VoP explanatory text field from a typed transfer submission without taking ownership of the handle.

The return is nullable; callers must handle NULL when the backend did not provide this optional field.

For FinTS success submissions, NULL means the whole VoP block is absent. If the VoP block is present and this field is empty, the accessor returns a non-null pointer to an empty string. EBICS transfer submissions return NULL for VoP fields.

Return

Returns provider explanatory text from a FinTS transfer submission VoP block when one is present. Returns NULL when the optional field is not materialized or when the input handle is NULL.

TypeNullabilityOwnership
const char*nullableborrowed

Parameters

NameDirectionTypeNullabilityOwnership
in_submissioninputconst gln_transfer_submission_t*nullableborrowed

Submission VoP

Returns provider explanatory text from a FinTS transfer submission VoP block when one is present.

NULL means the whole VoP block is absent; a non-null empty string means the block is present but this field is empty. EBICS transfer submissions return NULL for VoP fields.

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.

See Also