Skip to content

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

GLN_API void GLN_CALL gln_destroy_secret(gln_secret_t* in_secret);
  • Family: Destroy and release functions
  • Return type: void

Purpose

Releases a caller-owned secret handle.

Return

Returns no value.

TypeNullabilityOwnership
voidvaluevalue

Parameters

NameDirectionTypeNullabilityOwnership
in_secretinputgln_secret_t*nonnullborrowed

Notes

Passing NULL for in_secret is allowed and has no effect.

Destroying a non-NULL handle destroys the contained Secure_string, which performs best-effort wiping of its live buffer and heap storage before the handle allocation is freed.

Test-transport builds may print diagnostics for non-live secret pointers. That diagnostic path is not part of the production C ABI contract.

See Also