summaryrefslogtreecommitdiff
path: root/NK_C_API.h
diff options
context:
space:
mode:
authorRobin Krahl <robin.krahl@ireas.org>2019-01-28 12:00:51 +0100
committerSzczepan Zalega <szczepan@nitrokey.com>2019-01-29 16:37:02 +0100
commitb2f35949dec2251aeb162324864292cdd7596c9b (patch)
tree2538baca7bd4ab3c47e74ad1a1642409cc0371ce /NK_C_API.h
parentd82829f6fc0f55d3eddcf26d14637883541ce452 (diff)
downloadlibnitrokey-b2f35949dec2251aeb162324864292cdd7596c9b.tar.gz
libnitrokey-b2f35949dec2251aeb162324864292cdd7596c9b.tar.bz2
Replace NK_status with NK_get_status_as_string
For naming consistency, this patch adds the NK_get_status_as_string function to replace NK_status and marks NK_status as deprecated.
Diffstat (limited to 'NK_C_API.h')
-rw-r--r--NK_C_API.h14
1 files changed, 12 insertions, 2 deletions
diff --git a/NK_C_API.h b/NK_C_API.h
index c59beb4..79d80c0 100644
--- a/NK_C_API.h
+++ b/NK_C_API.h
@@ -353,12 +353,22 @@ extern "C" {
NK_C_API enum NK_device_model NK_get_device_model();
/**
- * Return the debug status string. Debug purposes.
- * @return command processing error code
+ * Return the debug status string. Debug purposes. This function is
+ * deprecated in favor of NK_get_status_as_string.
+ * @return string representation of the status or an empty string
+ * if the command failed
*/
+ DEPRECATED
NK_C_API char * NK_status();
/**
+ * Return the debug status string. Debug purposes.
+ * @return string representation of the status or an empty string
+ * if the command failed
+ */
+ NK_C_API char * NK_get_status_as_string();
+
+ /**
* Get the stick status common to all Nitrokey devices and return the
* command processing error code. If the code is zero, i. e. the
* command was successful, the storage status is written to the output