Documentation improvements to libmodbus page
[libmodbus.git] / doc / modbus_flush.txt
blob5ccc2f5ce65a951b62fed9b022e73e4353df4e9e
1 modbus_flush(3)
2 ===============
5 NAME
6 ----
7 modbus_flush - flush non-transmitted data
10 SYNOPSIS
11 --------
12 *int modbus_flush(modbus_t *'ctx');*
15 DESCRIPTION
16 -----------
17 The _modbus_flush()_ function shall discard data received but not read to the
18 socket or file descriptor associated to the context 'ctx'.
21 RETURN VALUE
22 ------------
23 The _modbus_flush()_ function shall return 0 or the number of flushed bytes if
24 successful. Otherwise it shall return -1 and set errno.
27 AUTHORS
28 -------
29 The libmodbus documentation was written by Stéphane Raimbault
30 <stephane.raimbault@gmail.com>