Skip to content

Commit e716181

Browse files
committed
Fix hid_read_error documentation
1 parent 3425db0 commit e716181

File tree

1 file changed

+1
-5
lines changed

1 file changed

+1
-5
lines changed

hidapi/hidapi.h

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -379,14 +379,10 @@ extern "C" {
379379
380380
This function is intended for logging/debugging purposes.
381381
382-
This function guarantees to never return NULL.
382+
This function guarantees to never return NULL for a valid @ref dev.
383383
If there was no error in the last call to hid_read/hid_read_error -
384384
the returned string clearly indicates that.
385385
386-
Any HIDAPI function that can explicitly indicate an execution failure
387-
(e.g. by an error code, or by returning NULL) - may set the error string,
388-
to be returned by this function.
389-
390386
Strings returned from hid_read_error() must not be freed by the user,
391387
i.e. owned by HIDAPI library.
392388
Device-specific error string may remain allocated at most until hid_close() is called.

0 commit comments

Comments
 (0)