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.

2 files changed, 16 insertions, 2 deletions

diff --git a/NK_C_API.cc b/NK_C_API.cc
index 6905ef4..e560c3f 100644
--- a/NK_C_API.cc
+++ b/NK_C_API.cc
@@ -252,6 +252,10 @@ extern "C" {
 
 
 	NK_C_API char * NK_status() {
+		return NK_get_status_as_string();
+	}
+
+	NK_C_API char * NK_get_status_as_string() {
 		auto m = NitrokeyManager::instance();
 		return get_with_string_result([&]() {
 			string && s = m->get_status_as_string();
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