Debian Codegraph @

docs/api/html/libprelude-prelude-ident.html

raw
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>prelude-ident: libprelude Reference Manual</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7 <link rel="home" href="index.html" title="libprelude Reference Manual">
8 <link rel="up" href="ch01.html" title="[Insert title here]">
9 <link rel="prev" href="libprelude-idmef-message-write.html" title="idmef-message-write">
10 <link rel="next" href="libprelude-prelude-client.html" title="prelude-client">
11 <meta name="generator" content="GTK-Doc V1.28 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 </head>
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
16 <td width="100%" align="left" class="shortcuts">
17 <a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
18 <a href="#libprelude-prelude-ident.description" class="shortcut">Description</a></span>
19 </td>
20 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
21 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
22 <td><a accesskey="p" href="libprelude-idmef-message-write.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
23 <td><a accesskey="n" href="libprelude-prelude-client.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
24 </tr></table>
25 <div class="refentry">
26 <a name="libprelude-prelude-ident"></a><div class="titlepage"></div>
27 <div class="refnamediv"><table width="100%"><tr>
28 <td valign="top">
29 <h2><span class="refentrytitle"><a name="libprelude-prelude-ident.top_of_page"></a>prelude-ident</span></h2>
30 <p>prelude-ident</p>
31 </td>
32 <td class="gallery_image" valign="top" align="right"></td>
33 </tr></table></div>
34 <div class="refsect1">
35 <a name="libprelude-prelude-ident.functions"></a><h2>Functions</h2>
36 <div class="informaltable"><table width="100%" border="0">
37 <colgroup>
38 <col width="150px" class="functions_return">
39 <col class="functions_name">
40 </colgroup>
41 <tbody>
42 <tr>
43 <td class="function_type">
44 <a class="link" href="libprelude-prelude-inttypes.html#uint64-t" title="uint64_t"><span class="returnvalue">uint64_t</span></a>
45 </td>
46 <td class="function_name">
47 <a class="link" href="libprelude-prelude-ident.html#prelude-ident-inc" title="prelude_ident_inc ()">prelude_ident_inc</a> <span class="c_punctuation">()</span>
48 </td>
49 </tr>
50 <tr>
51 <td class="function_type">
52 <span class="returnvalue">int</span>
53 </td>
54 <td class="function_name">
55 <a class="link" href="libprelude-prelude-ident.html#prelude-ident-generate" title="prelude_ident_generate ()">prelude_ident_generate</a> <span class="c_punctuation">()</span>
56 </td>
57 </tr>
58 <tr>
59 <td class="function_type">
60 <span class="returnvalue">void</span>
61 </td>
62 <td class="function_name">
63 <a class="link" href="libprelude-prelude-ident.html#prelude-ident-destroy" title="prelude_ident_destroy ()">prelude_ident_destroy</a> <span class="c_punctuation">()</span>
64 </td>
65 </tr>
66 <tr>
67 <td class="function_type">
68 <span class="returnvalue">int</span>
69 </td>
70 <td class="function_name">
71 <a class="link" href="libprelude-prelude-ident.html#prelude-ident-new" title="prelude_ident_new ()">prelude_ident_new</a> <span class="c_punctuation">()</span>
72 </td>
73 </tr>
74 </tbody>
75 </table></div>
76 </div>
77 <div class="refsect1">
78 <a name="libprelude-prelude-ident.other"></a><h2>Types and Values</h2>
79 <div class="informaltable"><table width="100%" border="0">
80 <colgroup>
81 <col width="150px" class="name">
82 <col class="description">
83 </colgroup>
84 <tbody><tr>
85 <td class="typedef_keyword">typedef</td>
86 <td class="function_name"><a class="link" href="libprelude-prelude-ident.html#prelude-ident-t" title="prelude_ident_t">prelude_ident_t</a></td>
87 </tr></tbody>
88 </table></div>
89 </div>
90 <div class="refsect1">
91 <a name="libprelude-prelude-ident.description"></a><h2>Description</h2>
92 </div>
93 <div class="refsect1">
94 <a name="libprelude-prelude-ident.functions_details"></a><h2>Functions</h2>
95 <div class="refsect2">
96 <a name="prelude-ident-inc"></a><h3>prelude_ident_inc ()</h3>
97 <pre class="programlisting"><a class="link" href="libprelude-prelude-inttypes.html#uint64-t" title="uint64_t"><span class="returnvalue">uint64_t</span></a>
98 prelude_ident_inc (<em class="parameter"><code><a class="link" href="libprelude-prelude-ident.html#prelude-ident-t" title="prelude_ident_t"><span class="type">prelude_ident_t</span></a> *ident</code></em>);</pre>
99 <p>Deprecated.</p>
100 <div class="refsect3">
101 <a name="prelude-ident-inc.parameters"></a><h4>Parameters</h4>
102 <div class="informaltable"><table width="100%" border="0">
103 <colgroup>
104 <col width="150px" class="parameters_name">
105 <col class="parameters_description">
106 <col width="200px" class="parameters_annotations">
107 </colgroup>
108 <tbody><tr>
109 <td class="parameter_name"><p>ident</p></td>
110 <td class="parameter_description"><p>Pointer to a <a class="link" href="libprelude-prelude-ident.html#prelude-ident-t" title="prelude_ident_t"><span class="type">prelude_ident_t</span></a> object.</p></td>
111 <td class="parameter_annotations"> </td>
112 </tr></tbody>
113 </table></div>
114 </div>
115 <div class="refsect3">
116 <a name="prelude-ident-inc.returns"></a><h4>Returns</h4>
117 <p> A new ident.</p>
118 </div>
119 </div>
120 <hr>
121 <div class="refsect2">
122 <a name="prelude-ident-generate"></a><h3>prelude_ident_generate ()</h3>
123 <pre class="programlisting"><span class="returnvalue">int</span>
124 prelude_ident_generate (<em class="parameter"><code><a class="link" href="libprelude-prelude-ident.html#prelude-ident-t" title="prelude_ident_t"><span class="type">prelude_ident_t</span></a> *ident</code></em>,
125 <em class="parameter"><code><a class="link" href="libprelude-prelude-string.html#prelude-string-t" title="prelude_string_t"><span class="type">prelude_string_t</span></a> *out</code></em>);</pre>
126 <p>Generate an UUID and store it in <em class="parameter"><code>out</code></em>
127 .</p>
128 <div class="refsect3">
129 <a name="prelude-ident-generate.parameters"></a><h4>Parameters</h4>
130 <div class="informaltable"><table width="100%" border="0">
131 <colgroup>
132 <col width="150px" class="parameters_name">
133 <col class="parameters_description">
134 <col width="200px" class="parameters_annotations">
135 </colgroup>
136 <tbody>
137 <tr>
138 <td class="parameter_name"><p>ident</p></td>
139 <td class="parameter_description"><p>Pointer to a <a class="link" href="libprelude-prelude-ident.html#prelude-ident-t" title="prelude_ident_t"><span class="type">prelude_ident_t</span></a> object.</p></td>
140 <td class="parameter_annotations"> </td>
141 </tr>
142 <tr>
143 <td class="parameter_name"><p>out</p></td>
144 <td class="parameter_description"><p><a class="link" href="libprelude-prelude-string.html#prelude-string-t" title="prelude_string_t"><span class="type">prelude_string_t</span></a> where the ident will be generated.</p></td>
145 <td class="parameter_annotations"> </td>
146 </tr>
147 </tbody>
148 </table></div>
149 </div>
150 <div class="refsect3">
151 <a name="prelude-ident-generate.returns"></a><h4>Returns</h4>
152 <p> A negative value if an error occur.</p>
153 </div>
154 </div>
155 <hr>
156 <div class="refsect2">
157 <a name="prelude-ident-destroy"></a><h3>prelude_ident_destroy ()</h3>
158 <pre class="programlisting"><span class="returnvalue">void</span>
159 prelude_ident_destroy (<em class="parameter"><code><a class="link" href="libprelude-prelude-ident.html#prelude-ident-t" title="prelude_ident_t"><span class="type">prelude_ident_t</span></a> *ident</code></em>);</pre>
160 <p>Destroy a <a class="link" href="libprelude-prelude-ident.html#prelude-ident-t" title="prelude_ident_t"><span class="type">prelude_ident_t</span></a> object.</p>
161 <div class="refsect3">
162 <a name="prelude-ident-destroy.parameters"></a><h4>Parameters</h4>
163 <div class="informaltable"><table width="100%" border="0">
164 <colgroup>
165 <col width="150px" class="parameters_name">
166 <col class="parameters_description">
167 <col width="200px" class="parameters_annotations">
168 </colgroup>
169 <tbody><tr>
170 <td class="parameter_name"><p>ident</p></td>
171 <td class="parameter_description"><p>Pointer to a <a class="link" href="libprelude-prelude-ident.html#prelude-ident-t" title="prelude_ident_t"><span class="type">prelude_ident_t</span></a> object.</p></td>
172 <td class="parameter_annotations"> </td>
173 </tr></tbody>
174 </table></div>
175 </div>
176 </div>
177 <hr>
178 <div class="refsect2">
179 <a name="prelude-ident-new"></a><h3>prelude_ident_new ()</h3>
180 <pre class="programlisting"><span class="returnvalue">int</span>
181 prelude_ident_new (<em class="parameter"><code><a class="link" href="libprelude-prelude-ident.html#prelude-ident-t" title="prelude_ident_t"><span class="type">prelude_ident_t</span></a> **ret</code></em>);</pre>
182 <p>Create a new <a class="link" href="libprelude-prelude-ident.html#prelude-ident-t" title="prelude_ident_t"><span class="type">prelude_ident_t</span></a> object with an unique value.</p>
183 <div class="refsect3">
184 <a name="prelude-ident-new.parameters"></a><h4>Parameters</h4>
185 <div class="informaltable"><table width="100%" border="0">
186 <colgroup>
187 <col width="150px" class="parameters_name">
188 <col class="parameters_description">
189 <col width="200px" class="parameters_annotations">
190 </colgroup>
191 <tbody><tr>
192 <td class="parameter_name"><p>ret</p></td>
193 <td class="parameter_description"><p>Pointer where to store the created object.</p></td>
194 <td class="parameter_annotations"> </td>
195 </tr></tbody>
196 </table></div>
197 </div>
198 <div class="refsect3">
199 <a name="prelude-ident-new.returns"></a><h4>Returns</h4>
200 <p> 0 on success, or a negative value if an error occured.</p>
201 </div>
202 </div>
203 </div>
204 <div class="refsect1">
205 <a name="libprelude-prelude-ident.other_details"></a><h2>Types and Values</h2>
206 <div class="refsect2">
207 <a name="prelude-ident-t"></a><h3>prelude_ident_t</h3>
208 <pre class="programlisting">typedef struct prelude_ident prelude_ident_t;
209 </pre>
210 </div>
211 </div>
212 </div>
213 <div class="footer">
214 <hr>Generated by GTK-Doc V1.28</div>
215 </body>
216 </html>