From 77eed8f58d20dfb35cd563455641052ba0f1ad43 Mon Sep 17 00:00:00 2001 From: Paul Hollinsky Date: Tue, 23 Jul 2019 15:03:43 -0400 Subject: [PATCH] Revise documentation for icsneo_getLastError --- include/icsneo/icsneoc.h | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/include/icsneo/icsneoc.h b/include/icsneo/icsneoc.h index 4530e52..1c77d1b 100644 --- a/include/icsneo/icsneoc.h +++ b/include/icsneo/icsneoc.h @@ -601,9 +601,10 @@ extern bool DLLExport icsneo_getDeviceEvents(const neodevice_t* device, neoevent * \returns True if an error was read out. * * All errors are stored on a per-thread basis, meaning that calling icsneo_getLastError() will return the last error that occured on the calling thread. - * Any errors can only be retrieved through this function, and NOT ics_neo_getEvents() or similar! Only INFO and WARNING level events are accessible through those. - * Only the last error is stored, so call this function often! - * Calling icsneo_getLastError() will remove the returned error, meaning that subsequent calls to icsneo_getLastError() on the same thread will return false (barring any additional errors) + * Any errors can only be retrieved through this function, and NOT icsneo_getEvents() or similar! Only INFO and WARNING level events are accessible through those. + * Only the last error is stored, so the intention is for this function to be called immediately following another failed API call. + * + * The API error system is thread-safe. Only an API error which occurred on the current thread will be returned. * * See icsneo_getEvents() for more information about the event system. *