diff options
author | Jörg Frings-Fürst <debian@jff-webhosting.net> | 2022-10-24 21:03:42 +0200 |
---|---|---|
committer | Jörg Frings-Fürst <debian@jff-webhosting.net> | 2022-10-24 21:03:42 +0200 |
commit | 532d4a24e2013262dfa41fd85c06a9715c99abf7 (patch) | |
tree | 3b7f4fac1e983ead408c20a2f330b41aa2399ab1 /doc/init.rst | |
parent | a1bdcfa3ca8af4ddb69ee57d716aa943cf3fe94a (diff) |
New upstream version 4.7upstream/4.7
Diffstat (limited to 'doc/init.rst')
-rw-r--r-- | doc/init.rst | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/init.rst b/doc/init.rst new file mode 100644 index 0000000..ebaa4d8 --- /dev/null +++ b/doc/init.rst @@ -0,0 +1,17 @@ +Initialization +============== + +.. code-block:: c + + #include <libHX/init.h> + + int HX_init(void); + void HX_exit(void); + +Before using the library's functions, ``HX_init`` must be called. This function +will initialize any needed state libHX needs for itself, if any. It is designed +to be invoked multiple times, such as for example, from different libraries +linking to libHX itself, and will refcount. On success, >0 is returned. If +there was an error, it will return a negative error code or zero. ``HX_exit`` +is the logical counterpart of notifying that the library is no longer used. + |