← Back to branch summary

~ubuntu-branches/ubuntu/trusty/libprelude/trusty

« back to all changes in this revision

Viewing changes to docs/api/xml/prelude-ident.xml

  • Committer: Bazaar Package Importer
  • Author(s): Pierre Chifflier
  • Date: 2008-04-28 15:23:30 UTC
  • mfrom: (1.1.9 upstream)
  • Revision ID: james.westby@ubuntu.com-20080428152330-su7zlfscjjeh30ig
Tags: 0.9.17.1-1
New upstream release (remove debug output)

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/api/xml/prelude-ident.xml
3
3
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4
4
<refentry id="libprelude-prelude-ident">
5
5
<refmeta>
6
 
<refentrytitle role="top_of_page">prelude-ident</refentrytitle>
 
6
<refentrytitle role="top_of_page" id="libprelude-prelude-ident.top_of_page">prelude-ident</refentrytitle>
7
7
<manvolnum>3</manvolnum>
8
8
<refmiscinfo>LIBPRELUDE Library</refmiscinfo>
9
9
</refmeta>
14
14
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
15
15
</refnamediv>
16
16
 
17
 
<refsynopsisdiv role="synopsis">
 
17
<refsynopsisdiv id="libprelude-prelude-ident.synopsis" role="synopsis">
18
18
<title role="synopsis.title">Synopsis</title>
19
19
 
20
20
<synopsis>
21
 
 
22
 
 
23
 
 
24
21
typedef             <link linkend="prelude-ident-t">prelude_ident_t</link>;
25
22
<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);
26
 
<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);
 
23
<link linkend="int">int</link>                 <link linkend="prelude-ident-generate">prelude_ident_generate</link>              (<link linkend="prelude-ident-t">prelude_ident_t</link> *ident,
 
24
                                                         <link linkend="prelude-string-t">prelude_string_t</link> *out);
27
25
<link linkend="void">void</link>                <link linkend="prelude-ident-destroy">prelude_ident_destroy</link>               (<link linkend="prelude-ident-t">prelude_ident_t</link> *ident);
28
26
<link linkend="int">int</link>                 <link linkend="prelude-ident-new">prelude_ident_new</link>                   (<link linkend="prelude-ident-t">prelude_ident_t</link> **ret);
29
27
</synopsis>
37
35
 
38
36
 
39
37
 
40
 
<refsect1 role="desc">
 
38
<refsect1 id="libprelude-prelude-ident.description" role="desc">
41
39
<title role="desc.title">Description</title>
42
40
<para>
43
41
 
44
42
</para>
45
43
</refsect1>
46
44
 
47
 
<refsect1 role="details">
 
45
<refsect1 id="libprelude-prelude-ident.details" role="details">
48
46
<title role="details.title">Details</title>
49
 
<refsect2>
50
 
<title><anchor id="prelude-ident-t" role="typedef"/>prelude_ident_t</title>
51
 
<indexterm><primary>prelude_ident_t</primary></indexterm><programlisting>typedef struct prelude_ident prelude_ident_t;
 
47
<refsect2 id="prelude-ident-t" role="typedef">
 
48
<title>prelude_ident_t</title>
 
49
<indexterm zone="prelude-ident-t"><primary>prelude_ident_t</primary></indexterm><programlisting>typedef struct prelude_ident prelude_ident_t;
52
50
</programlisting>
53
51
<para>
54
52
 
55
53
</para></refsect2>
56
 
<refsect2>
57
 
<title><anchor id="prelude-ident-inc" role="function"/>prelude_ident_inc ()</title>
58
 
<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>
59
 
<para>
60
 
Increment the ident associated with the <link linkend="prelude-ident-t"><type>prelude_ident_t</type></link> object.</para>
61
 
<para>
62
 
 
63
 
</para><variablelist role="params">
64
 
<varlistentry><term><parameter>ident</parameter>&nbsp;:</term>
65
 
<listitem><simpara> Pointer to a <link linkend="prelude-ident-t"><type>prelude_ident_t</type></link> object.
66
 
</simpara></listitem></varlistentry>
67
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the new ident.
68
 
</simpara></listitem></varlistentry>
69
 
</variablelist></refsect2>
70
 
<refsect2>
71
 
<title><anchor id="prelude-ident-dec" role="function"/>prelude_ident_dec ()</title>
72
 
<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>
73
 
<para>
74
 
 
75
 
</para><variablelist role="params">
76
 
<varlistentry><term><parameter>ident</parameter>&nbsp;:</term>
77
 
<listitem><simpara>
78
 
</simpara></listitem></varlistentry>
79
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
80
 
 
81
 
 
82
 
</simpara></listitem></varlistentry>
83
 
</variablelist></refsect2>
84
 
<refsect2>
85
 
<title><anchor id="prelude-ident-destroy" role="function"/>prelude_ident_destroy ()</title>
86
 
<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>
 
54
<refsect2 id="prelude-ident-inc" role="function">
 
55
<title>prelude_ident_inc ()</title>
 
56
<indexterm zone="prelude-ident-inc"><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>
 
57
<para>
 
58
Deprecated.</para>
 
59
<para>
 
60
 
 
61
</para><variablelist role="params">
 
62
<varlistentry><term><parameter>ident</parameter>&nbsp;:</term>
 
63
<listitem><simpara> Pointer to a <link linkend="prelude-ident-t"><type>prelude_ident_t</type></link> object.
 
64
</simpara></listitem></varlistentry>
 
65
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A new ident.
 
66
</simpara></listitem></varlistentry>
 
67
</variablelist></refsect2>
 
68
<refsect2 id="prelude-ident-generate" role="function">
 
69
<title>prelude_ident_generate ()</title>
 
70
<indexterm zone="prelude-ident-generate"><primary>prelude_ident_generate</primary></indexterm><programlisting><link linkend="int">int</link>                 prelude_ident_generate              (<link linkend="prelude-ident-t">prelude_ident_t</link> *ident,
 
71
                                                         <link linkend="prelude-string-t">prelude_string_t</link> *out);</programlisting>
 
72
<para>
 
73
Generate an UUID and store it in <parameter>out</parameter>.</para>
 
74
<para>
 
75
 
 
76
</para><variablelist role="params">
 
77
<varlistentry><term><parameter>ident</parameter>&nbsp;:</term>
 
78
<listitem><simpara> Pointer to a <link linkend="prelude-ident-t"><type>prelude_ident_t</type></link> object.
 
79
</simpara></listitem></varlistentry>
 
80
<varlistentry><term><parameter>out</parameter>&nbsp;:</term>
 
81
<listitem><simpara> <link linkend="prelude-string-t"><type>prelude_string_t</type></link> where the ident will be generated.
 
82
</simpara></listitem></varlistentry>
 
83
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A negative value if an error occur.
 
84
</simpara></listitem></varlistentry>
 
85
</variablelist></refsect2>
 
86
<refsect2 id="prelude-ident-destroy" role="function">
 
87
<title>prelude_ident_destroy ()</title>
 
88
<indexterm zone="prelude-ident-destroy"><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>
87
89
<para>
88
90
Destroy a <link linkend="prelude-ident-t"><type>prelude_ident_t</type></link> object.</para>
89
91
<para>
93
95
<listitem><simpara> Pointer to a <link linkend="prelude-ident-t"><type>prelude_ident_t</type></link> object.
94
96
</simpara></listitem></varlistentry>
95
97
</variablelist></refsect2>
96
 
<refsect2>
97
 
<title><anchor id="prelude-ident-new" role="function"/>prelude_ident_new ()</title>
98
 
<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>
 
98
<refsect2 id="prelude-ident-new" role="function">
 
99
<title>prelude_ident_new ()</title>
 
100
<indexterm zone="prelude-ident-new"><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>
99
101
<para>
100
102
Create a new <link linkend="prelude-ident-t"><type>prelude_ident_t</type></link> object with an unique value.</para>
101
103
<para>