omlc_close(3)
=============

NAME
----
omlc_close - shutdown the OML client library

SYNOPSIS
--------
[verse]
*#include <oml2/omlc.h>*
[verse]
'int' *omlc_close*('void');

DESCRIPTION
-----------

*omlc_close*() shuts down the OML client library, and stops all
measurement processes.  It also flushes all measurement streams to try
to ensure that all measurements are stored correctly before the
application terminates.  The application should call *omlc_close*() if
it intends to exit.

If linkoml:omlc_inject[3] is called after *omlc_close*() has been called,
then it will be ignored and not measurement collection will take
place.  Other API functions will return with an error.

RETURN VALUE
------------

*omlc_close*() returns 0 on success; on error it returns -1.

ERRORS
------

*omlc_close*() will succeed unless the API has not already been
initialized by a call to linkoml:omlc_init[3].

BUGS
----
include::bugs.txt[]

SEE ALSO
--------
Manual Pages
~~~~~~~~~~~~
linkoml:oml2-server[1], linkoml:liboml2[1], linkoml:liboml2[3], linkoml:liboml2.conf[5]

linkoml:omlc_init[3], linkoml:omlc_add_mp[3], linkoml:omlc_start[3], linkoml:omlc_inject[3]

include::manual.txt[]

// vim: ft=asciidoc:tw=72
