gln_create_file_key_store

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

GLN_API gln_status_t GLN_CALL gln_create_file_key_store(
    const char*       in_key_blob_path,
    const char*       in_sidecar_key_path_or_null,
    gln_key_store_t** out_store,
    gln_error_t*      out_error);

Family: Create and open functions
Return type: gln_status_t

Purpose

Creates a built-in file-backed EBICS key store on supported builds.

Use gln_create_key_store instead when the caller supplies a key-store vtable.

Return

Returns GLN_OK on success and a non-OK gln_status_t value on failure.

Type	Nullability	Ownership
`gln_status_t`	value	value

Parameters

Name	Direction	Type	Nullability	Ownership
`in_key_blob_path`	input	`const char*`	nonnull	borrowed
`in_sidecar_key_path_or_null`	input	`const char*`	nullable	borrowed
`out_store`	output	`gln_key_store_t**`	nonnull	transferred_out
`out_error`	output	`gln_error_t*`	nullable	caller_allocated_output

Platform Support

The built-in file key store is supported on Windows x64 builds.

On other platforms, after validating the error slot and required arguments, the function clears *out_store when possible, writes a not_supported error when out_error is usable, and returns GLN_ERR_NOT_SUPPORTED.

Paths And Ownership

in_key_blob_path is required. in_sidecar_key_path_or_null may be NULL.

On Windows x64, the implementation copies the supplied paths into std::filesystem::path values while constructing the file key store; the caller retains ownership of the C strings.

On success, out_store receives a caller-owned key-store handle that must be released with gln_destroy_key_store.

Failure Cases

The call returns GLN_ERR_INVALID_ARG when in_key_blob_path or out_store is NULL.

out_error may be NULL; if it is non-NULL, its struct_size must describe a valid gln_error_t.