contrib/ofed/management/libibumad/man/umad_init.3

   1 .\" -*- nroff -*-
   2 .\"
   3 .TH UMAD_INIT 3  "May 21, 2007" "OpenIB" "OpenIB Programmer\'s Manual"
   4 .SH "NAME"
   5 umad_init, umad_done \- perform library initialization and finalization
   6 .SH "SYNOPSIS"
   7 .nf
   8 .B #include <infiniband/umad.h>
   9 .sp
  10 .BI "int umad_init(void);
  11 .nl
  12 .BI "int umad_done(void);
  13 .fi
  14 .SH "DESCRIPTION"
  15 .B umad_init()
  16 initializes the umad library for use. Must be called before any
  17 other call to this library.
  18 .PP
  19 .B umad_done()
  20 finalizes the use of the umad library.
  21 .SH "RETURN VALUE"
  22 .B umad_init()
  23 and
  24 .B umad_done()
  25 return 0 on success, and \-1 on error.
  26 Error is returned from
  27 .B umad_init()
  28 if infiniband umad
  29 can\'t be opened, or the abi version doesn\'t match.
  30 There are no errors currently returned by
  31 .B umad_done().
  32 .SH "NOTES"
  33 If an error occurs during the library initialization, no further use of the
  34 umad library should be attempted.
  35 .SH "AUTHORS"
  36 .TP
  37 Hal Rosenstock <halr@voltaire.com>
  38 .TP
  39 Dotan Barak <dotanb@mellanox.co.il>