GALANTHUS / ABI FUNCTION REFERENCE
gln_get_error_detail_plugin_hint
Declared in <galanthus/c_api/gln_capi.h>.
GLN_API const char* GLN_CALL gln_get_error_detail_plugin_hint(const gln_error_detail_t* in_detail);
Purpose
Returns the plugin-not-found hint string stored in a GLN_ERROR_DETAIL_PLUGIN_NOT_FOUND payload.
Return
Returns the plugin hint from the error detail, or NULL when it is not available.
| Type | Nullability | Ownership |
|---|---|---|
const char* | nullable | borrowed |
Parameters
| Name | Direction | Type | Nullability | Ownership |
|---|---|---|---|---|
in_detail | input | const gln_error_detail_t* | nullable | borrowed |
Notes
Passing NULL for in_detail is allowed and returns NULL.
The accessor returns NULL for any detail kind other than GLN_ERROR_DETAIL_PLUGIN_NOT_FOUND. For a plugin-not-found payload, the hint field is part of the supported payload shape.
This accessor documents the supported plugin-not-found 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.