doc/modbus_connect.txt

   1 modbus_connect(3)
   2 =================
   3
   4
   5 NAME
   6 ----
   7 modbus_connect - establish a Modbus connection
   8
   9
  10 SYNOPSIS
  11 --------
  12 *int modbus_connect(modbus_t *'ctx');*
  13
  14
  15 DESCRIPTION
  16 -----------
  17 The _modbus_connect()_ function shall etablish a connection to a Modbus server,
  18 a network or a bus using the context information of libmodbus context given in
  19 argument.
  20
  21
  22 RETURN VALUE
  23 ------------
  24 The modbus_connect() function shall return 0 if successful. Otherwise it shall
  25 return -1 and set errno to one of the values defined by the system calls of the
  26 underlying platform.
  27
  28
  29 EXAMPLE
  30 -------
  31 [source,c]
  32 -------------------
  33 modbus_t *ctx;
  34
  35 ctx = modbus_new_tcp("127.0.0.1", 502);
  36 if (modbus_connect(ctx) == -1) {
  37     fprintf(stderr, "Connection failed: %s\n", modbus_strerror(errno));
  38     modbus_free(ctx);
  39     return -1;
  40 }
  41 -------------------
  42
  43
  44 SEE ALSO
  45 --------
  46 linkmb:modbus_close[3]
  47
  48
  49 AUTHORS
  50 -------
  51 The libmodbus documentation was written by Stéphane Raimbault
  52 <stephane.raimbault@gmail.com>