Minor adjustments to MD files
[libmodbus.git] / docs / modbus_close.md
blob6fe760666dc6f7752703bedcf4937741b56ab830
1 # modbus_close
3 ## Name
5 modbus_close - close a Modbus connection
7 ## Synopsis
9 ```c
10 void modbus_close(modbus_t *ctx);
11 ```
13 ## Description
15 The *modbus_close()* function shall close the connection established with the
16 backend set in the context.
18 ## Return value
20 There is no return value.
22 ## Example
24 ```c
25 modbus_t *ctx;
27 ctx = modbus_new_tcp("127.0.0.1", 502);
28 if (modbus_connect(ctx) == -1) {
29     fprintf(stderr, "Connection failed: %s\n", modbus_strerror(errno));
30     modbus_free(ctx);
31     return -1;
34 modbus_close(ctx);
35 modbus_free(ctx);
36 ```
38 ## See also
40 - [modbus_connect](modbus_connect)