doc/modbus_strerror.txt

   1 modbus_strerror(3)
   2 =================
   3
   4
   5 NAME
   6 ----
   7 modbus_strerror - return the error message
   8
   9
  10 SYNOPSIS
  11 --------
  12 *const char *modbus_strerror(int 'errnum');*
  13
  14
  15 DESCRIPTION
  16 -----------
  17 The *modbus_strerror()* function shall return a pointer to an error message
  18 string corresponding to the error number specified by the _errnum_ argument.  As
  19 libmodbus defines additional error numbers over and above those defined by the
  20 operating system, applications should use *modbus_strerror()* in preference to
  21 the standard *strerror()* function.
  22
  23
  24 RETURN VALUE
  25 ------------
  26 The *modbus_strerror()* function shall return a pointer to an error message
  27 string.
  28
  29
  30 ERRORS
  31 ------
  32 No errors are defined.
  33
  34
  35 EXAMPLE
  36 -------
  37 .Display an error message when a Modbus connection cannot be established
  38 [source,c]
  39 -------------------
  40 if (modbus_connect(ctx) == -1) {
  41     fprintf(stderr, "Connection failed: %s\n", modbus_strerror(errno));
  42     abort();
  43 }
  44 -------------------
  45
  46 SEE ALSO
  47 --------
  48 linkmb:libmodbus
  49
  50
  51 AUTHORS
  52 -------
  53 The libmodbus documentation was written by Stéphane Raimbault
  54 <stephane.raimbault@gmail.com>