libmodbus/doc/modbus_strerror.txt at master · novval/libmodbus · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
modbus_strerror(3)
=================


NAME
----
modbus_strerror - return the error message


SYNOPSIS
--------
*const char *modbus_strerror(int 'errnum');*


DESCRIPTION
-----------
The *modbus_strerror()* function shall return a pointer to an error message
string corresponding to the error number specified by the _errnum_ argument.  As
libmodbus defines additional error numbers over and above those defined by the
operating system, applications should use *modbus_strerror()* in preference to
the standard *strerror()* function.


RETURN VALUE
------------
The *modbus_strerror()* function shall return a pointer to an error message
string.


ERRORS
------
No errors are defined.


EXAMPLE
-------
.Display an error message when a Modbus connection cannot be established
[source,c]
-------------------
if (modbus_connect(ctx) == -1) {
    fprintf(stderr, "Connection failed: %s\n", modbus_strerror(errno));
    abort();
}
-------------------

SEE ALSO
--------
linkmb:libmodbus


AUTHORS
-------
The libmodbus documentation was written by Stéphane Raimbault
<stephane.raimbault@gmail.com>