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
|
<?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-ident">
<refmeta>
<refentrytitle id="top_of_page">prelude-ident</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBPRELUDE Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>prelude-ident</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="synopsis">
<title id="synopsis.title">Synopsis</title>
<synopsis>
typedef <link linkend="prelude-ident-t">prelude_ident_t</link>;
<link linkend="uint64-t">uint64_t</link> <link linkend="prelude-ident-inc">prelude_ident_inc</link> (<link linkend="prelude-ident-t">prelude_ident_t</link> *ident);
<link linkend="uint64-t">uint64_t</link> <link linkend="prelude-ident-dec">prelude_ident_dec</link> (<link linkend="prelude-ident-t">prelude_ident_t</link> *ident);
<link linkend="void">void</link> <link linkend="prelude-ident-destroy">prelude_ident_destroy</link> (<link linkend="prelude-ident-t">prelude_ident_t</link> *ident);
<link linkend="int">int</link> <link linkend="prelude-ident-new">prelude_ident_new</link> (<link linkend="prelude-ident-t">prelude_ident_t</link> **ret);
</synopsis>
</refsynopsisdiv>
<refsect1 id="desc">
<title id="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="details">
<title id="details.title">Details</title>
<refsect2>
<title><anchor id="prelude-ident-t" role="typedef"/>prelude_ident_t</title>
<indexterm><primary>prelude_ident_t</primary></indexterm><programlisting>typedef struct prelude_ident prelude_ident_t;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="prelude-ident-inc" role="function"/>prelude_ident_inc ()</title>
<indexterm><primary>prelude_ident_inc</primary></indexterm><programlisting><link linkend="uint64-t">uint64_t</link> prelude_ident_inc (<link linkend="prelude-ident-t">prelude_ident_t</link> *ident);</programlisting>
<para>
Increment the ident associated with the <link linkend="prelude-ident-t"><type>prelude_ident_t</type></link> object.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>ident</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="prelude-ident-t"><type>prelude_ident_t</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the new ident.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="prelude-ident-dec" role="function"/>prelude_ident_dec ()</title>
<indexterm><primary>prelude_ident_dec</primary></indexterm><programlisting><link linkend="uint64-t">uint64_t</link> prelude_ident_dec (<link linkend="prelude-ident-t">prelude_ident_t</link> *ident);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>ident</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="prelude-ident-destroy" role="function"/>prelude_ident_destroy ()</title>
<indexterm><primary>prelude_ident_destroy</primary></indexterm><programlisting><link linkend="void">void</link> prelude_ident_destroy (<link linkend="prelude-ident-t">prelude_ident_t</link> *ident);</programlisting>
<para>
Destroy a <link linkend="prelude-ident-t"><type>prelude_ident_t</type></link> object.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>ident</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="prelude-ident-t"><type>prelude_ident_t</type></link> object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="prelude-ident-new" role="function"/>prelude_ident_new ()</title>
<indexterm><primary>prelude_ident_new</primary></indexterm><programlisting><link linkend="int">int</link> prelude_ident_new (<link linkend="prelude-ident-t">prelude_ident_t</link> **ret);</programlisting>
<para>
Create a new <link linkend="prelude-ident-t"><type>prelude_ident_t</type></link> object with an unique value.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>ret</parameter> :</term>
<listitem><simpara> Pointer where to store the created object.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> 0 on success, or a negative value if an error occured.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
