Use new modbus_mapping_new_start_address in unit tests
[libmodbus.git] / doc / modbus_close.txt
blob5a0afc0fd0afa3488a436d28ef5ed30a2e1111b3
1 modbus_close(3)
2 ===============
5 NAME
6 ----
7 modbus_close - close a Modbus connection
10 SYNOPSIS
11 --------
12 *void modbus_close(modbus_t *'ctx');*
15 DESCRIPTION
16 -----------
17 The *modbus_close()* function shall close the connection established with the
18 backend set in the context.
21 RETURN VALUE
22 ------------
23 There is no return value.
26 EXAMPLE
27 -------
28 [source,c]
29 -------------------
30 modbus_t *ctx;
32 ctx = modbus_new_tcp("127.0.0.1", 502);
33 if (modbus_connect(ctx) == -1) {
34     fprintf(stderr, "Connection failed: %s\n", modbus_strerror(errno));
35     modbus_free(ctx);
36     return -1;
39 modbus_close(ctx);
40 modbus_free(ctx);
41 -------------------
43 SEE ALSO
44 --------
45 linkmb:modbus_connect[3]
48 AUTHORS
49 -------
50 The libmodbus documentation was written by Stéphane Raimbault
51 <stephane.raimbault@gmail.com>