|
253
|
1 # Module: core |
|
|
2 |
|
|
3 Synopsis |
|
|
4 |
|
|
5 ```c |
|
|
6 #include <core/core.h> |
|
|
7 ``` |
|
|
8 |
|
|
9 Main entry point for the libmlk-core library. |
|
|
10 |
|
|
11 The library must be initialized before attempting to call any other functions in |
|
|
12 the API. |
|
|
13 |
|
|
14 ## Functions |
|
|
15 |
|
|
16 ### core\_init |
|
|
17 |
|
|
18 Initialize the library. |
|
|
19 |
|
|
20 You must specify an `organization` and program `name`. The `organization` |
|
|
21 argument can be anything but [reversed domain name notation][rdnn] is often |
|
|
22 used. It will also determine the path to the preferred directories on certain |
|
|
23 platforms so make sure to not use characters that may be illegal on some |
|
|
24 filesystems. |
|
|
25 |
|
|
26 Returns false in case of errors. |
|
|
27 |
|
|
28 ```c |
|
|
29 bool |
|
|
30 core_init(const char *organization, const char *name) |
|
|
31 ``` |
|
|
32 |
|
|
33 ### core\_finish |
|
|
34 |
|
|
35 Close the library. |
|
|
36 |
|
|
37 ```c |
|
|
38 void |
|
|
39 core_finish(void) |
|
|
40 ``` |
|
|
41 |
|
|
42 [rdnn]: https://en.wikipedia.org/wiki/Reverse_domain_name_notation |
