sven
/
libicsneo
mirror of https://github.com/intrepidcs/libicsneo.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Revise documentation for icsneo_getLastError

checksum-failure-logging
Paul Hollinsky 2019-07-23 15:03:43 -04:00
parent 69a7b9bc2d
commit 77eed8f58d
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
include/icsneo/icsneoc.h
View File

@ -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.
*