1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="libprelude-prelude">
<refmeta>
<refentrytitle id="top_of_page">prelude</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBPRELUDE Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>prelude</refname>
<refpurpose>
Initializing the library</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="synopsis">
<title id="synopsis.title">Synopsis</title>
<synopsis>
#define <link linkend="LIBPRELUDE-VERSION:CAPS">LIBPRELUDE_VERSION</link>
<link linkend="int">int</link> <link linkend="prelude-init">prelude_init</link> (<link linkend="int">int</link> *argc,
<link linkend="char">char</link> **argv);
<link linkend="void">void</link> <link linkend="prelude-deinit">prelude_deinit</link> (void);
const <link linkend="char">char</link>* <link linkend="prelude-check-version">prelude_check_version</link> (const <link linkend="char">char</link> *req_version);
<link linkend="int">int</link> <link linkend="prelude-thread-init">prelude_thread_init</link> (<link linkend="void">void</link> *future_use);
</synopsis>
</refsynopsisdiv>
<refsect1 id="desc">
<title id="desc.title">Description</title>
<para>
Before any operation are done using the prelude library, the user first need
to initialize it using the <link linkend="prelude-init"><function>prelude_init()</function></link> function.
<programlisting>
int ret;
ret = prelude_init(&argc, argv);
if ( ret < 0 ) {
prelude_perror(ret, "unable to initialize the prelude library");
return -1;
}
</programlisting>
</para>
</refsect1>
<refsect1 id="details">
<title id="details.title">Details</title>
<refsect2>
<title><anchor id="LIBPRELUDE-VERSION:CAPS" role="macro"/>LIBPRELUDE_VERSION</title>
<indexterm><primary>LIBPRELUDE_VERSION</primary></indexterm><programlisting>#define LIBPRELUDE_VERSION "0.9.7.2"
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="prelude-init" role="function"/>prelude_init ()</title>
<indexterm><primary>prelude_init</primary></indexterm><programlisting><link linkend="int">int</link> prelude_init (<link linkend="int">int</link> *argc,
<link linkend="char">char</link> **argv);</programlisting>
<para>
Call this function before using any other Prelude functions in your applications.
It will initialize everything needed to operate the library and parses some standard
command line options. <parameter>argc</parameter> and <parameter>argv</parameter> are adjusted accordingly so your own code will
never see those standard arguments.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>argc</parameter> :</term>
<listitem><simpara> Address of the argc parameter of your <link linkend="main"><function>main()</function></link> function.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>argv</parameter> :</term>
<listitem><simpara> Address of the argv parameter of your <link linkend="main"><function>main()</function></link> function.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> 0 on success, a negative value if an error occured.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="prelude-deinit" role="function"/>prelude_deinit ()</title>
<indexterm><primary>prelude_deinit</primary></indexterm><programlisting><link linkend="void">void</link> prelude_deinit (void);</programlisting>
<para>
Call this function if you're done using the library and want to free global
shared ressource allocated by libprelude.</para>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="prelude-check-version" role="function"/>prelude_check_version ()</title>
<indexterm><primary>prelude_check_version</primary></indexterm><programlisting>const <link linkend="char">char</link>* prelude_check_version (const <link linkend="char">char</link> *req_version);</programlisting>
<para>
If <parameter>req_version</parameter> is NULL this function will return the version of the library.
Otherwise, <parameter>req_version</parameter> will be compared to the current library version. If
the library version is higher or equal, this function will return the current
library version. Otherwise, NULL is returned.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>req_version</parameter> :</term>
<listitem><simpara> The minimum acceptable version number.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The current library version, or NULL if <parameter>req_version</parameter> doesn't match.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="prelude-thread-init" role="function"/>prelude_thread_init ()</title>
<indexterm><primary>prelude_thread_init</primary></indexterm><programlisting><link linkend="int">int</link> prelude_thread_init (<link linkend="void">void</link> *future_use);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>future_use</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
