.\" -*- nroff -*-
.\"
.TH UMAD_INIT 3  "May 21, 2007" "OpenIB" "OpenIB Programmer\'s Manual"
.SH "NAME"
umad_init, umad_done \- perform library initialization and finalization
.SH "SYNOPSIS"
.nf
.B #include <infiniband/umad.h>
.sp
.BI "int umad_init(void);
.nl
.BI "int umad_done(void);
.fi
.SH "DESCRIPTION"
.B umad_init()
initializes the umad library for use. Must be called before any
other call to this library.
.PP
.B umad_done()
finalizes the use of the umad library.
.SH "RETURN VALUE"
.B umad_init()
and
.B umad_done()
return 0 on success, and \-1 on error.
Error is returned from
.B umad_init()
if infiniband umad
can\'t be opened, or the abi version doesn\'t match.
There are no errors currently returned by
.B umad_done().
.SH "NOTES"
If an error occurs during the library initialization, no further use of the
umad library should be attempted.
.SH "AUTHORS"
.TP
Hal Rosenstock <halr@voltaire.com>
.TP
Dotan Barak <dotanb@mellanox.co.il>