aboutsummaryrefslogtreecommitdiff
path: root/NK_C_API.h
diff options
context:
space:
mode:
authorRobin Krahl <me@robin-krahl.de>2018-05-25 00:15:40 +0200
committerRobin Krahl <me@robin-krahl.de>2018-05-25 00:15:40 +0200
commit6e44c2b11bd1be9e080f1179283c49f9bb8955a5 (patch)
tree2394d3c79376a34e2b6b65120b3c8c1ec3a6a92a /NK_C_API.h
parent391a276ba35216337b777c65fda62561a6e9383f (diff)
downloadlibnitrokey-6e44c2b11bd1be9e080f1179283c49f9bb8955a5.tar.gz
libnitrokey-6e44c2b11bd1be9e080f1179283c49f9bb8955a5.tar.bz2
Expose device model in C API
The C++ API already provides access to the model of the connected device in NitrokeyManager::get_connected_device_model(). This patch also exposes this information in the C API by adding NK_get_device_model. As there might be no device connected, the function returns a boolean indicating the connection status and writes the model of the connected device to a pointer passed as an argument.
Diffstat (limited to 'NK_C_API.h')
-rw-r--r--NK_C_API.h11
1 files changed, 11 insertions, 0 deletions
diff --git a/NK_C_API.h b/NK_C_API.h
index 222e5e1..10cc29f 100644
--- a/NK_C_API.h
+++ b/NK_C_API.h
@@ -90,6 +90,17 @@ extern "C" {
NK_C_API int NK_logout();
/**
+ * Query the model of the connected device. If the out argument is
+ * NULL or if there is no connected device, this function returns
+ * false. Otherwise it returns true and sets the target of the out
+ * pointer to the model of the connected device.
+ *
+ * @param out a pointer to write the model to
+ * @return true if a device is connected and the out argument has been set
+ */
+ NK_C_API bool NK_get_device_model(enum NK_device_model *out);
+
+ /**
* Return the debug status string. Debug purposes.
* @return command processing error code
*/