Skip to content

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

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

Purpose

Returns the token-persistence operation string stored in a GLN_ERROR_DETAIL_TOKEN_PERSIST payload.

Return

Returns the token persist operation from the error detail, or NULL when it is not available.

TypeNullabilityOwnership
const char*nullableborrowed

Parameters

NameDirectionTypeNullabilityOwnership
in_detailinputconst gln_error_detail_t*nullableborrowed

Notes

Passing NULL for in_detail is allowed and returns NULL.

The accessor returns NULL for any detail kind other than GLN_ERROR_DETAIL_TOKEN_PERSIST. For a token-persist payload, the operation field is part of the supported payload shape.

This accessor documents the supported token-persist payload shape; it does not imply that a current public operation produces that payload.

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