aboutsummaryrefslogtreecommitdiff
path: root/NK_C_API.h
diff options
context:
space:
mode:
authorSzczepan Zalega <szczepan@nitrokey.com>2020-06-13 19:20:02 +0200
committerSzczepan Zalega <szczepan@nitrokey.com>2020-06-13 19:20:02 +0200
commit9b929a0bacd03657ddc232e6b4a9ed0fade82f68 (patch)
tree3f68326ab72db4c2cb95f63db07c005276b91de5 /NK_C_API.h
parent712c82ee94d1ef0d96becfce9bc1a7f8d95bdac1 (diff)
parent2a7b3f4e2ae09d665f9783030323dfb1a4c5ee9f (diff)
downloadlibnitrokey-9b929a0bacd03657ddc232e6b4a9ed0fade82f68.tar.gz
libnitrokey-9b929a0bacd03657ddc232e6b4a9ed0fade82f68.tar.bz2
Merge branch 'free'
Add functions for freeing memory of some C API results Fixes #175
Diffstat (limited to 'NK_C_API.h')
-rw-r--r--NK_C_API.h14
1 files changed, 14 insertions, 0 deletions
diff --git a/NK_C_API.h b/NK_C_API.h
index fe4cdd0..376241e 100644
--- a/NK_C_API.h
+++ b/NK_C_API.h
@@ -466,6 +466,7 @@ extern "C" {
/**
* Get currently set config - status of function Numlock/Capslock/Scrollock OTP sending and is enabled PIN protected OTP
+ * The return value must be freed using NK_free_config.
* @see NK_write_config
* @return uint8_t general_config[5]:
* uint8_t numlock;
@@ -477,6 +478,12 @@ extern "C" {
*/
NK_C_API uint8_t* NK_read_config();
+ /**
+ * Free a value returned by NK_read_config. May be called with a NULL
+ * argument.
+ */
+ NK_C_API void NK_free_config(uint8_t* config);
+
//OTP
/**
@@ -649,10 +656,17 @@ extern "C" {
/**
* Get password safe slots' status
+ * The return value must be freed using NK_free_password_safe_slot_status.
* @return uint8_t[16] slot statuses - each byte represents one slot with 0 (not programmed) and 1 (programmed)
*/
NK_C_API uint8_t * NK_get_password_safe_slot_status();
+ /**
+ * Free a value returned by NK_get_password_safe_slot_status. May be
+ * called with a NULL argument.
+ */
+ NK_C_API void NK_free_password_safe_slot_status(uint8_t* status);
+
/**
* Get password safe slot name
* @param slot_number password safe slot number, slot_number<16