Debian Codegraph @

docs/api/html/libprelude-prelude-client-profile.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-client-profile: 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-prelude-client.html" title="prelude-client">
10 <link rel="next" href="libprelude-prelude-plugin.html" title="prelude-plugin">
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-client-profile.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-prelude-client.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
23 <td><a accesskey="n" href="libprelude-prelude-plugin.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-client-profile"></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-client-profile.top_of_page"></a>prelude-client-profile</span></h2>
30 <p>prelude-client-profile</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-client-profile.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 <span class="returnvalue">int</span>
45 </td>
46 <td class="function_name">
47 <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-new" title="prelude_client_profile_new ()">prelude_client_profile_new</a> <span class="c_punctuation">()</span>
48 </td>
49 </tr>
50 <tr>
51 <td class="function_type">
52 <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="returnvalue">prelude_client_profile_t</span></a> *
53 </td>
54 <td class="function_name">
55 <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-ref" title="prelude_client_profile_ref ()">prelude_client_profile_ref</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-client-profile.html#prelude-client-profile-destroy" title="prelude_client_profile_destroy ()">prelude_client_profile_destroy</a> <span class="c_punctuation">()</span>
64 </td>
65 </tr>
66 <tr>
67 <td class="function_type">
68 <span class="returnvalue">void</span>
69 </td>
70 <td class="function_name">
71 <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-get-config-filename" title="prelude_client_profile_get_config_filename ()">prelude_client_profile_get_config_filename</a> <span class="c_punctuation">()</span>
72 </td>
73 </tr>
74 <tr>
75 <td class="function_type">
76 <span class="returnvalue">void</span>
77 </td>
78 <td class="function_name">
79 <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-get-analyzerid-filename" title="prelude_client_profile_get_analyzerid_filename ()">prelude_client_profile_get_analyzerid_filename</a> <span class="c_punctuation">()</span>
80 </td>
81 </tr>
82 <tr>
83 <td class="function_type">
84 <span class="returnvalue">void</span>
85 </td>
86 <td class="function_name">
87 <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-get-tls-key-filename" title="prelude_client_profile_get_tls_key_filename ()">prelude_client_profile_get_tls_key_filename</a> <span class="c_punctuation">()</span>
88 </td>
89 </tr>
90 <tr>
91 <td class="function_type">
92 <span class="returnvalue">void</span>
93 </td>
94 <td class="function_name">
95 <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-get-tls-server-ca-cert-filename" title="prelude_client_profile_get_tls_server_ca_cert_filename ()">prelude_client_profile_get_tls_server_ca_cert_filename</a> <span class="c_punctuation">()</span>
96 </td>
97 </tr>
98 <tr>
99 <td class="function_type">
100 <span class="returnvalue">void</span>
101 </td>
102 <td class="function_name">
103 <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-get-tls-server-keycert-filename" title="prelude_client_profile_get_tls_server_keycert_filename ()">prelude_client_profile_get_tls_server_keycert_filename</a> <span class="c_punctuation">()</span>
104 </td>
105 </tr>
106 <tr>
107 <td class="function_type">
108 <span class="returnvalue">void</span>
109 </td>
110 <td class="function_name">
111 <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-get-tls-server-crl-filename" title="prelude_client_profile_get_tls_server_crl_filename ()">prelude_client_profile_get_tls_server_crl_filename</a> <span class="c_punctuation">()</span>
112 </td>
113 </tr>
114 <tr>
115 <td class="function_type">
116 <span class="returnvalue">void</span>
117 </td>
118 <td class="function_name">
119 <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-get-tls-client-keycert-filename" title="prelude_client_profile_get_tls_client_keycert_filename ()">prelude_client_profile_get_tls_client_keycert_filename</a> <span class="c_punctuation">()</span>
120 </td>
121 </tr>
122 <tr>
123 <td class="function_type">
124 <span class="returnvalue">void</span>
125 </td>
126 <td class="function_name">
127 <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-get-tls-client-trusted-cert-filename" title="prelude_client_profile_get_tls_client_trusted_cert_filename ()">prelude_client_profile_get_tls_client_trusted_cert_filename</a> <span class="c_punctuation">()</span>
128 </td>
129 </tr>
130 <tr>
131 <td class="function_type">
132 <span class="returnvalue">void</span>
133 </td>
134 <td class="function_name">
135 <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-get-backup-dirname" title="prelude_client_profile_get_backup_dirname ()">prelude_client_profile_get_backup_dirname</a> <span class="c_punctuation">()</span>
136 </td>
137 </tr>
138 <tr>
139 <td class="function_type">
140 <span class="returnvalue">void</span>
141 </td>
142 <td class="function_name">
143 <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-get-profile-dirname" title="prelude_client_profile_get_profile_dirname ()">prelude_client_profile_get_profile_dirname</a> <span class="c_punctuation">()</span>
144 </td>
145 </tr>
146 <tr>
147 <td class="function_type">
148 <span class="returnvalue">void</span>
149 </td>
150 <td class="function_name">
151 <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-get-default-config-dirname" title="prelude_client_profile_get_default_config_dirname ()">prelude_client_profile_get_default_config_dirname</a> <span class="c_punctuation">()</span>
152 </td>
153 </tr>
154 <tr>
155 <td class="function_type">
156 <span class="returnvalue">int</span>
157 </td>
158 <td class="function_name">
159 <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-set-prefix" title="prelude_client_profile_set_prefix ()">prelude_client_profile_set_prefix</a> <span class="c_punctuation">()</span>
160 </td>
161 </tr>
162 <tr>
163 <td class="function_type">
164 <span class="returnvalue">void</span>
165 </td>
166 <td class="function_name">
167 <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-get-prefix" title="prelude_client_profile_get_prefix ()">prelude_client_profile_get_prefix</a> <span class="c_punctuation">()</span>
168 </td>
169 </tr>
170 <tr>
171 <td class="function_type">
172 <span class="returnvalue">void</span>
173 </td>
174 <td class="function_name">
175 <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-set-uid" title="prelude_client_profile_set_uid ()">prelude_client_profile_set_uid</a> <span class="c_punctuation">()</span>
176 </td>
177 </tr>
178 <tr>
179 <td class="function_type">
180 <a class="link" href="libprelude-prelude-client-profile.html#prelude-uid-t" title="prelude_uid_t"><span class="returnvalue">prelude_uid_t</span></a>
181 </td>
182 <td class="function_name">
183 <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-get-uid" title="prelude_client_profile_get_uid ()">prelude_client_profile_get_uid</a> <span class="c_punctuation">()</span>
184 </td>
185 </tr>
186 <tr>
187 <td class="function_type">
188 <span class="returnvalue">void</span>
189 </td>
190 <td class="function_name">
191 <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-set-gid" title="prelude_client_profile_set_gid ()">prelude_client_profile_set_gid</a> <span class="c_punctuation">()</span>
192 </td>
193 </tr>
194 <tr>
195 <td class="function_type">
196 <a class="link" href="libprelude-prelude-client-profile.html#prelude-gid-t" title="prelude_gid_t"><span class="returnvalue">prelude_gid_t</span></a>
197 </td>
198 <td class="function_name">
199 <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-get-gid" title="prelude_client_profile_get_gid ()">prelude_client_profile_get_gid</a> <span class="c_punctuation">()</span>
200 </td>
201 </tr>
202 <tr>
203 <td class="function_type">
204 <span class="returnvalue">int</span>
205 </td>
206 <td class="function_name">
207 <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-set-name" title="prelude_client_profile_set_name ()">prelude_client_profile_set_name</a> <span class="c_punctuation">()</span>
208 </td>
209 </tr>
210 <tr>
211 <td class="function_type">const <span class="returnvalue">char</span> *
212 </td>
213 <td class="function_name">
214 <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-get-name" title="prelude_client_profile_get_name ()">prelude_client_profile_get_name</a> <span class="c_punctuation">()</span>
215 </td>
216 </tr>
217 <tr>
218 <td class="function_type">
219 <a class="link" href="libprelude-prelude-inttypes.html#uint64-t" title="uint64_t"><span class="returnvalue">uint64_t</span></a>
220 </td>
221 <td class="function_name">
222 <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-get-analyzerid" title="prelude_client_profile_get_analyzerid ()">prelude_client_profile_get_analyzerid</a> <span class="c_punctuation">()</span>
223 </td>
224 </tr>
225 <tr>
226 <td class="function_type">
227 <span class="returnvalue">void</span>
228 </td>
229 <td class="function_name">
230 <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-set-analyzerid" title="prelude_client_profile_set_analyzerid ()">prelude_client_profile_set_analyzerid</a> <span class="c_punctuation">()</span>
231 </td>
232 </tr>
233 <tr>
234 <td class="function_type">
235 <span class="returnvalue">int</span>
236 </td>
237 <td class="function_name">
238 <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-get-credentials" title="prelude_client_profile_get_credentials ()">prelude_client_profile_get_credentials</a> <span class="c_punctuation">()</span>
239 </td>
240 </tr>
241 </tbody>
242 </table></div>
243 </div>
244 <div class="refsect1">
245 <a name="libprelude-prelude-client-profile.other"></a><h2>Types and Values</h2>
246 <div class="informaltable"><table width="100%" border="0">
247 <colgroup>
248 <col width="150px" class="name">
249 <col class="description">
250 </colgroup>
251 <tbody>
252 <tr>
253 <td class="typedef_keyword">typedef</td>
254 <td class="function_name"><a class="link" href="libprelude-prelude-client-profile.html#prelude-gid-t" title="prelude_gid_t">prelude_gid_t</a></td>
255 </tr>
256 <tr>
257 <td class="typedef_keyword">typedef</td>
258 <td class="function_name"><a class="link" href="libprelude-prelude-client-profile.html#prelude-uid-t" title="prelude_uid_t">prelude_uid_t</a></td>
259 </tr>
260 <tr>
261 <td class="typedef_keyword">typedef</td>
262 <td class="function_name"><a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t">prelude_client_profile_t</a></td>
263 </tr>
264 </tbody>
265 </table></div>
266 </div>
267 <div class="refsect1">
268 <a name="libprelude-prelude-client-profile.description"></a><h2>Description</h2>
269 </div>
270 <div class="refsect1">
271 <a name="libprelude-prelude-client-profile.functions_details"></a><h2>Functions</h2>
272 <div class="refsect2">
273 <a name="prelude-client-profile-new"></a><h3>prelude_client_profile_new ()</h3>
274 <pre class="programlisting"><span class="returnvalue">int</span>
275 prelude_client_profile_new (<em class="parameter"><code><a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="type">prelude_client_profile_t</span></a> **ret</code></em>,
276 <em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre>
277 <p>Creates a new <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="type">prelude_client_profile_t</span></a> object and store its
278 address into <em class="parameter"><code>ret</code></em>
279 .</p>
280 <div class="refsect3">
281 <a name="prelude-client-profile-new.parameters"></a><h4>Parameters</h4>
282 <div class="informaltable"><table width="100%" border="0">
283 <colgroup>
284 <col width="150px" class="parameters_name">
285 <col class="parameters_description">
286 <col width="200px" class="parameters_annotations">
287 </colgroup>
288 <tbody>
289 <tr>
290 <td class="parameter_name"><p>ret</p></td>
291 <td class="parameter_description"><p>Pointer where to store the address of the created object.</p></td>
292 <td class="parameter_annotations"> </td>
293 </tr>
294 <tr>
295 <td class="parameter_name"><p>name</p></td>
296 <td class="parameter_description"><p>Name for this profile.</p></td>
297 <td class="parameter_annotations"> </td>
298 </tr>
299 </tbody>
300 </table></div>
301 </div>
302 <div class="refsect3">
303 <a name="prelude-client-profile-new.returns"></a><h4>Returns</h4>
304 <p> 0 on success or a negative value if an error occured.</p>
305 </div>
306 </div>
307 <hr>
308 <div class="refsect2">
309 <a name="prelude-client-profile-ref"></a><h3>prelude_client_profile_ref ()</h3>
310 <pre class="programlisting"><a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="returnvalue">prelude_client_profile_t</span></a> *
311 prelude_client_profile_ref (<em class="parameter"><code><a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="type">prelude_client_profile_t</span></a> *cp</code></em>);</pre>
312 </div>
313 <hr>
314 <div class="refsect2">
315 <a name="prelude-client-profile-destroy"></a><h3>prelude_client_profile_destroy ()</h3>
316 <pre class="programlisting"><span class="returnvalue">void</span>
317 prelude_client_profile_destroy (<em class="parameter"><code><a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="type">prelude_client_profile_t</span></a> *cp</code></em>);</pre>
318 <p>Destroys <em class="parameter"><code>cp</code></em>
319 .</p>
320 <div class="refsect3">
321 <a name="prelude-client-profile-destroy.parameters"></a><h4>Parameters</h4>
322 <div class="informaltable"><table width="100%" border="0">
323 <colgroup>
324 <col width="150px" class="parameters_name">
325 <col class="parameters_description">
326 <col width="200px" class="parameters_annotations">
327 </colgroup>
328 <tbody><tr>
329 <td class="parameter_name"><p>cp</p></td>
330 <td class="parameter_description"><p>Pointer to a <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="type">prelude_client_profile_t</span></a>.</p></td>
331 <td class="parameter_annotations"> </td>
332 </tr></tbody>
333 </table></div>
334 </div>
335 </div>
336 <hr>
337 <div class="refsect2">
338 <a name="prelude-client-profile-get-config-filename"></a><h3>prelude_client_profile_get_config_filename ()</h3>
339 <pre class="programlisting"><span class="returnvalue">void</span>
340 prelude_client_profile_get_config_filename
341 (<em class="parameter"><code>const <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="type">prelude_client_profile_t</span></a> *cp</code></em>,
342 <em class="parameter"><code><span class="type">char</span> *buf</code></em>,
343 <em class="parameter"><code><span class="type">size_t</span> size</code></em>);</pre>
344 <p>Writes the filename used to store <em class="parameter"><code>cp</code></em>
345 configuration template.</p>
346 <div class="refsect3">
347 <a name="prelude-client-profile-get-config-filename.parameters"></a><h4>Parameters</h4>
348 <div class="informaltable"><table width="100%" border="0">
349 <colgroup>
350 <col width="150px" class="parameters_name">
351 <col class="parameters_description">
352 <col width="200px" class="parameters_annotations">
353 </colgroup>
354 <tbody>
355 <tr>
356 <td class="parameter_name"><p>cp</p></td>
357 <td class="parameter_description"><p>pointer on a <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="type">prelude_client_profile_t</span></a> object.</p></td>
358 <td class="parameter_annotations"> </td>
359 </tr>
360 <tr>
361 <td class="parameter_name"><p>buf</p></td>
362 <td class="parameter_description"><p>buffer to write the returned filename to.</p></td>
363 <td class="parameter_annotations"> </td>
364 </tr>
365 <tr>
366 <td class="parameter_name"><p>size</p></td>
367 <td class="parameter_description"><p>size of <em class="parameter"><code>buf</code></em>
368 .</p></td>
369 <td class="parameter_annotations"> </td>
370 </tr>
371 </tbody>
372 </table></div>
373 </div>
374 </div>
375 <hr>
376 <div class="refsect2">
377 <a name="prelude-client-profile-get-analyzerid-filename"></a><h3>prelude_client_profile_get_analyzerid_filename ()</h3>
378 <pre class="programlisting"><span class="returnvalue">void</span>
379 prelude_client_profile_get_analyzerid_filename
380 (<em class="parameter"><code>const <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="type">prelude_client_profile_t</span></a> *cp</code></em>,
381 <em class="parameter"><code><span class="type">char</span> *buf</code></em>,
382 <em class="parameter"><code><span class="type">size_t</span> size</code></em>);</pre>
383 <p>Writes the filename used to store <em class="parameter"><code>cp</code></em>
384 unique and permanent analyzer ident.</p>
385 <div class="refsect3">
386 <a name="prelude-client-profile-get-analyzerid-filename.parameters"></a><h4>Parameters</h4>
387 <div class="informaltable"><table width="100%" border="0">
388 <colgroup>
389 <col width="150px" class="parameters_name">
390 <col class="parameters_description">
391 <col width="200px" class="parameters_annotations">
392 </colgroup>
393 <tbody>
394 <tr>
395 <td class="parameter_name"><p>cp</p></td>
396 <td class="parameter_description"><p>pointer on a <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="type">prelude_client_profile_t</span></a> object.</p></td>
397 <td class="parameter_annotations"> </td>
398 </tr>
399 <tr>
400 <td class="parameter_name"><p>buf</p></td>
401 <td class="parameter_description"><p>buffer to write the returned filename to.</p></td>
402 <td class="parameter_annotations"> </td>
403 </tr>
404 <tr>
405 <td class="parameter_name"><p>size</p></td>
406 <td class="parameter_description"><p>size of <em class="parameter"><code>buf</code></em>
407 .</p></td>
408 <td class="parameter_annotations"> </td>
409 </tr>
410 </tbody>
411 </table></div>
412 </div>
413 </div>
414 <hr>
415 <div class="refsect2">
416 <a name="prelude-client-profile-get-tls-key-filename"></a><h3>prelude_client_profile_get_tls_key_filename ()</h3>
417 <pre class="programlisting"><span class="returnvalue">void</span>
418 prelude_client_profile_get_tls_key_filename
419 (<em class="parameter"><code>const <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="type">prelude_client_profile_t</span></a> *cp</code></em>,
420 <em class="parameter"><code><span class="type">char</span> *buf</code></em>,
421 <em class="parameter"><code><span class="type">size_t</span> size</code></em>);</pre>
422 <p>Writes the filename used to store <em class="parameter"><code>cp</code></em>
423 private key.</p>
424 <div class="refsect3">
425 <a name="prelude-client-profile-get-tls-key-filename.parameters"></a><h4>Parameters</h4>
426 <div class="informaltable"><table width="100%" border="0">
427 <colgroup>
428 <col width="150px" class="parameters_name">
429 <col class="parameters_description">
430 <col width="200px" class="parameters_annotations">
431 </colgroup>
432 <tbody>
433 <tr>
434 <td class="parameter_name"><p>cp</p></td>
435 <td class="parameter_description"><p>pointer on a <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="type">prelude_client_profile_t</span></a> object.</p></td>
436 <td class="parameter_annotations"> </td>
437 </tr>
438 <tr>
439 <td class="parameter_name"><p>buf</p></td>
440 <td class="parameter_description"><p>buffer to write the returned filename to.</p></td>
441 <td class="parameter_annotations"> </td>
442 </tr>
443 <tr>
444 <td class="parameter_name"><p>size</p></td>
445 <td class="parameter_description"><p>size of <em class="parameter"><code>buf</code></em>
446 .</p></td>
447 <td class="parameter_annotations"> </td>
448 </tr>
449 </tbody>
450 </table></div>
451 </div>
452 </div>
453 <hr>
454 <div class="refsect2">
455 <a name="prelude-client-profile-get-tls-server-ca-cert-filename"></a><h3>prelude_client_profile_get_tls_server_ca_cert_filename ()</h3>
456 <pre class="programlisting"><span class="returnvalue">void</span>
457 prelude_client_profile_get_tls_server_ca_cert_filename
458 (<em class="parameter"><code>const <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="type">prelude_client_profile_t</span></a> *cp</code></em>,
459 <em class="parameter"><code><span class="type">char</span> *buf</code></em>,
460 <em class="parameter"><code><span class="type">size_t</span> size</code></em>);</pre>
461 <p>Writes the filename used to store <em class="parameter"><code>cp</code></em>
462 related CA certificate.
463 This only apply to <em class="parameter"><code>cp</code></em>
464 receiving connection from analyzer (server).</p>
465 <div class="refsect3">
466 <a name="prelude-client-profile-get-tls-server-ca-cert-filename.parameters"></a><h4>Parameters</h4>
467 <div class="informaltable"><table width="100%" border="0">
468 <colgroup>
469 <col width="150px" class="parameters_name">
470 <col class="parameters_description">
471 <col width="200px" class="parameters_annotations">
472 </colgroup>
473 <tbody>
474 <tr>
475 <td class="parameter_name"><p>cp</p></td>
476 <td class="parameter_description"><p>pointer on a <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="type">prelude_client_profile_t</span></a> object.</p></td>
477 <td class="parameter_annotations"> </td>
478 </tr>
479 <tr>
480 <td class="parameter_name"><p>buf</p></td>
481 <td class="parameter_description"><p>buffer to write the returned filename to.</p></td>
482 <td class="parameter_annotations"> </td>
483 </tr>
484 <tr>
485 <td class="parameter_name"><p>size</p></td>
486 <td class="parameter_description"><p>size of <em class="parameter"><code>buf</code></em>
487 .</p></td>
488 <td class="parameter_annotations"> </td>
489 </tr>
490 </tbody>
491 </table></div>
492 </div>
493 </div>
494 <hr>
495 <div class="refsect2">
496 <a name="prelude-client-profile-get-tls-server-keycert-filename"></a><h3>prelude_client_profile_get_tls_server_keycert_filename ()</h3>
497 <pre class="programlisting"><span class="returnvalue">void</span>
498 prelude_client_profile_get_tls_server_keycert_filename
499 (<em class="parameter"><code>const <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="type">prelude_client_profile_t</span></a> *cp</code></em>,
500 <em class="parameter"><code><span class="type">char</span> *buf</code></em>,
501 <em class="parameter"><code><span class="type">size_t</span> size</code></em>);</pre>
502 <p>Writes the filename used to store certificate for <em class="parameter"><code>cp</code></em>
503 server.
504 This only apply to <em class="parameter"><code>cp</code></em>
505 receiving connection from analyzer (server).</p>
506 <div class="refsect3">
507 <a name="prelude-client-profile-get-tls-server-keycert-filename.parameters"></a><h4>Parameters</h4>
508 <div class="informaltable"><table width="100%" border="0">
509 <colgroup>
510 <col width="150px" class="parameters_name">
511 <col class="parameters_description">
512 <col width="200px" class="parameters_annotations">
513 </colgroup>
514 <tbody>
515 <tr>
516 <td class="parameter_name"><p>cp</p></td>
517 <td class="parameter_description"><p>pointer on a <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="type">prelude_client_profile_t</span></a> object.</p></td>
518 <td class="parameter_annotations"> </td>
519 </tr>
520 <tr>
521 <td class="parameter_name"><p>buf</p></td>
522 <td class="parameter_description"><p>buffer to write the returned filename to.</p></td>
523 <td class="parameter_annotations"> </td>
524 </tr>
525 <tr>
526 <td class="parameter_name"><p>size</p></td>
527 <td class="parameter_description"><p>size of <em class="parameter"><code>buf</code></em>
528 .</p></td>
529 <td class="parameter_annotations"> </td>
530 </tr>
531 </tbody>
532 </table></div>
533 </div>
534 </div>
535 <hr>
536 <div class="refsect2">
537 <a name="prelude-client-profile-get-tls-server-crl-filename"></a><h3>prelude_client_profile_get_tls_server_crl_filename ()</h3>
538 <pre class="programlisting"><span class="returnvalue">void</span>
539 prelude_client_profile_get_tls_server_crl_filename
540 (<em class="parameter"><code>const <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="type">prelude_client_profile_t</span></a> *cp</code></em>,
541 <em class="parameter"><code><span class="type">char</span> *buf</code></em>,
542 <em class="parameter"><code><span class="type">size_t</span> size</code></em>);</pre>
543 <p>Writes the filename used to store CRL for <em class="parameter"><code>cp</code></em>
544 server.
545 This only apply to <em class="parameter"><code>cp</code></em>
546 receiving connection from analyzer (server).</p>
547 <div class="refsect3">
548 <a name="prelude-client-profile-get-tls-server-crl-filename.parameters"></a><h4>Parameters</h4>
549 <div class="informaltable"><table width="100%" border="0">
550 <colgroup>
551 <col width="150px" class="parameters_name">
552 <col class="parameters_description">
553 <col width="200px" class="parameters_annotations">
554 </colgroup>
555 <tbody>
556 <tr>
557 <td class="parameter_name"><p>cp</p></td>
558 <td class="parameter_description"><p>pointer on a <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="type">prelude_client_profile_t</span></a> object.</p></td>
559 <td class="parameter_annotations"> </td>
560 </tr>
561 <tr>
562 <td class="parameter_name"><p>buf</p></td>
563 <td class="parameter_description"><p>buffer to write the returned filename to.</p></td>
564 <td class="parameter_annotations"> </td>
565 </tr>
566 <tr>
567 <td class="parameter_name"><p>size</p></td>
568 <td class="parameter_description"><p>size of <em class="parameter"><code>buf</code></em>
569 .</p></td>
570 <td class="parameter_annotations"> </td>
571 </tr>
572 </tbody>
573 </table></div>
574 </div>
575 </div>
576 <hr>
577 <div class="refsect2">
578 <a name="prelude-client-profile-get-tls-client-keycert-filename"></a><h3>prelude_client_profile_get_tls_client_keycert_filename ()</h3>
579 <pre class="programlisting"><span class="returnvalue">void</span>
580 prelude_client_profile_get_tls_client_keycert_filename
581 (<em class="parameter"><code>const <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="type">prelude_client_profile_t</span></a> *cp</code></em>,
582 <em class="parameter"><code><span class="type">char</span> *buf</code></em>,
583 <em class="parameter"><code><span class="type">size_t</span> size</code></em>);</pre>
584 <p>Writes the filename used to store public certificate for <em class="parameter"><code>cp</code></em>
585 private key.
586 This only apply to client connecting to a peer.</p>
587 <div class="refsect3">
588 <a name="prelude-client-profile-get-tls-client-keycert-filename.parameters"></a><h4>Parameters</h4>
589 <div class="informaltable"><table width="100%" border="0">
590 <colgroup>
591 <col width="150px" class="parameters_name">
592 <col class="parameters_description">
593 <col width="200px" class="parameters_annotations">
594 </colgroup>
595 <tbody>
596 <tr>
597 <td class="parameter_name"><p>cp</p></td>
598 <td class="parameter_description"><p>pointer on a <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="type">prelude_client_profile_t</span></a> object.</p></td>
599 <td class="parameter_annotations"> </td>
600 </tr>
601 <tr>
602 <td class="parameter_name"><p>buf</p></td>
603 <td class="parameter_description"><p>buffer to write the returned filename to.</p></td>
604 <td class="parameter_annotations"> </td>
605 </tr>
606 <tr>
607 <td class="parameter_name"><p>size</p></td>
608 <td class="parameter_description"><p>size of <em class="parameter"><code>buf</code></em>
609 .</p></td>
610 <td class="parameter_annotations"> </td>
611 </tr>
612 </tbody>
613 </table></div>
614 </div>
615 </div>
616 <hr>
617 <div class="refsect2">
618 <a name="prelude-client-profile-get-tls-client-trusted-cert-filename"></a><h3>prelude_client_profile_get_tls_client_trusted_cert_filename ()</h3>
619 <pre class="programlisting"><span class="returnvalue">void</span>
620 prelude_client_profile_get_tls_client_trusted_cert_filename
621 (<em class="parameter"><code>const <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="type">prelude_client_profile_t</span></a> *cp</code></em>,
622 <em class="parameter"><code><span class="type">char</span> *buf</code></em>,
623 <em class="parameter"><code><span class="type">size_t</span> size</code></em>);</pre>
624 <p>Writes the filename used to store peers public certificates that <em class="parameter"><code>cp</code></em>
625 trust.
626 This only apply to client connecting to a peer.</p>
627 <div class="refsect3">
628 <a name="prelude-client-profile-get-tls-client-trusted-cert-filename.parameters"></a><h4>Parameters</h4>
629 <div class="informaltable"><table width="100%" border="0">
630 <colgroup>
631 <col width="150px" class="parameters_name">
632 <col class="parameters_description">
633 <col width="200px" class="parameters_annotations">
634 </colgroup>
635 <tbody>
636 <tr>
637 <td class="parameter_name"><p>cp</p></td>
638 <td class="parameter_description"><p>pointer on a <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="type">prelude_client_profile_t</span></a> object.</p></td>
639 <td class="parameter_annotations"> </td>
640 </tr>
641 <tr>
642 <td class="parameter_name"><p>buf</p></td>
643 <td class="parameter_description"><p>buffer to write the returned filename to.</p></td>
644 <td class="parameter_annotations"> </td>
645 </tr>
646 <tr>
647 <td class="parameter_name"><p>size</p></td>
648 <td class="parameter_description"><p>size of <em class="parameter"><code>buf</code></em>
649 .</p></td>
650 <td class="parameter_annotations"> </td>
651 </tr>
652 </tbody>
653 </table></div>
654 </div>
655 </div>
656 <hr>
657 <div class="refsect2">
658 <a name="prelude-client-profile-get-backup-dirname"></a><h3>prelude_client_profile_get_backup_dirname ()</h3>
659 <pre class="programlisting"><span class="returnvalue">void</span>
660 prelude_client_profile_get_backup_dirname
661 (<em class="parameter"><code>const <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="type">prelude_client_profile_t</span></a> *cp</code></em>,
662 <em class="parameter"><code><span class="type">char</span> *buf</code></em>,
663 <em class="parameter"><code><span class="type">size_t</span> size</code></em>);</pre>
664 <p>Writes the directory name where the profile for <em class="parameter"><code>cp</code></em>
665 is stored. If
666 <em class="parameter"><code>cp</code></em>
667 is NULL or has no name, then this function will provide the main
668 profile directory.</p>
669 <div class="refsect3">
670 <a name="prelude-client-profile-get-backup-dirname.parameters"></a><h4>Parameters</h4>
671 <div class="informaltable"><table width="100%" border="0">
672 <colgroup>
673 <col width="150px" class="parameters_name">
674 <col class="parameters_description">
675 <col width="200px" class="parameters_annotations">
676 </colgroup>
677 <tbody>
678 <tr>
679 <td class="parameter_name"><p>cp</p></td>
680 <td class="parameter_description"><p>pointer on a <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="type">prelude_client_profile_t</span></a> object.</p></td>
681 <td class="parameter_annotations"> </td>
682 </tr>
683 <tr>
684 <td class="parameter_name"><p>buf</p></td>
685 <td class="parameter_description"><p>buffer to write the returned filename to.</p></td>
686 <td class="parameter_annotations"> </td>
687 </tr>
688 <tr>
689 <td class="parameter_name"><p>size</p></td>
690 <td class="parameter_description"><p>size of <em class="parameter"><code>buf</code></em>
691 .</p></td>
692 <td class="parameter_annotations"> </td>
693 </tr>
694 </tbody>
695 </table></div>
696 </div>
697 </div>
698 <hr>
699 <div class="refsect2">
700 <a name="prelude-client-profile-get-profile-dirname"></a><h3>prelude_client_profile_get_profile_dirname ()</h3>
701 <pre class="programlisting"><span class="returnvalue">void</span>
702 prelude_client_profile_get_profile_dirname
703 (<em class="parameter"><code>const <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="type">prelude_client_profile_t</span></a> *cp</code></em>,
704 <em class="parameter"><code><span class="type">char</span> *buf</code></em>,
705 <em class="parameter"><code><span class="type">size_t</span> size</code></em>);</pre>
706 </div>
707 <hr>
708 <div class="refsect2">
709 <a name="prelude-client-profile-get-default-config-dirname"></a><h3>prelude_client_profile_get_default_config_dirname ()</h3>
710 <pre class="programlisting"><span class="returnvalue">void</span>
711 prelude_client_profile_get_default_config_dirname
712 (<em class="parameter"><code>const <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="type">prelude_client_profile_t</span></a> *cp</code></em>,
713 <em class="parameter"><code><span class="type">char</span> *buf</code></em>,
714 <em class="parameter"><code><span class="type">size_t</span> size</code></em>);</pre>
715 </div>
716 <hr>
717 <div class="refsect2">
718 <a name="prelude-client-profile-set-prefix"></a><h3>prelude_client_profile_set_prefix ()</h3>
719 <pre class="programlisting"><span class="returnvalue">int</span>
720 prelude_client_profile_set_prefix (<em class="parameter"><code><a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="type">prelude_client_profile_t</span></a> *cp</code></em>,
721 <em class="parameter"><code>const <span class="type">char</span> *prefix</code></em>);</pre>
722 <p>This function allow to dynamically change the prefix used to acess
723 libprelude related file. This is particularly usefull in case of
724 application running under certain condition (chroot).</p>
725 <div class="refsect3">
726 <a name="prelude-client-profile-set-prefix.parameters"></a><h4>Parameters</h4>
727 <div class="informaltable"><table width="100%" border="0">
728 <colgroup>
729 <col width="150px" class="parameters_name">
730 <col class="parameters_description">
731 <col width="200px" class="parameters_annotations">
732 </colgroup>
733 <tbody>
734 <tr>
735 <td class="parameter_name"><p>cp</p></td>
736 <td class="parameter_description"><p>pointer on a <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="type">prelude_client_profile_t</span></a> object.</p></td>
737 <td class="parameter_annotations"> </td>
738 </tr>
739 <tr>
740 <td class="parameter_name"><p>prefix</p></td>
741 <td class="parameter_description"><p>Prefix to use for various libprelude files.</p></td>
742 <td class="parameter_annotations"> </td>
743 </tr>
744 </tbody>
745 </table></div>
746 </div>
747 <div class="refsect3">
748 <a name="prelude-client-profile-set-prefix.returns"></a><h4>Returns</h4>
749 <p> 0 on success, a negative value if an error occured.</p>
750 </div>
751 </div>
752 <hr>
753 <div class="refsect2">
754 <a name="prelude-client-profile-get-prefix"></a><h3>prelude_client_profile_get_prefix ()</h3>
755 <pre class="programlisting"><span class="returnvalue">void</span>
756 prelude_client_profile_get_prefix (<em class="parameter"><code>const <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="type">prelude_client_profile_t</span></a> *cp</code></em>,
757 <em class="parameter"><code><span class="type">char</span> *buf</code></em>,
758 <em class="parameter"><code><span class="type">size_t</span> size</code></em>);</pre>
759 <p>Retrieve current prefix used with this profile.</p>
760 <div class="refsect3">
761 <a name="prelude-client-profile-get-prefix.parameters"></a><h4>Parameters</h4>
762 <div class="informaltable"><table width="100%" border="0">
763 <colgroup>
764 <col width="150px" class="parameters_name">
765 <col class="parameters_description">
766 <col width="200px" class="parameters_annotations">
767 </colgroup>
768 <tbody>
769 <tr>
770 <td class="parameter_name"><p>cp</p></td>
771 <td class="parameter_description"><p>pointer on a <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="type">prelude_client_profile_t</span></a> object.</p></td>
772 <td class="parameter_annotations"> </td>
773 </tr>
774 <tr>
775 <td class="parameter_name"><p>buf</p></td>
776 <td class="parameter_description"><p>buffer to write the returned filename to.</p></td>
777 <td class="parameter_annotations"> </td>
778 </tr>
779 <tr>
780 <td class="parameter_name"><p>size</p></td>
781 <td class="parameter_description"><p>size of <em class="parameter"><code>buf</code></em>
782 .</p></td>
783 <td class="parameter_annotations"> </td>
784 </tr>
785 </tbody>
786 </table></div>
787 </div>
788 </div>
789 <hr>
790 <div class="refsect2">
791 <a name="prelude-client-profile-set-uid"></a><h3>prelude_client_profile_set_uid ()</h3>
792 <pre class="programlisting"><span class="returnvalue">void</span>
793 prelude_client_profile_set_uid (<em class="parameter"><code><a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="type">prelude_client_profile_t</span></a> *cp</code></em>,
794 <em class="parameter"><code><a class="link" href="libprelude-prelude-client-profile.html#prelude-uid-t" title="prelude_uid_t"><span class="type">prelude_uid_t</span></a> uid</code></em>);</pre>
795 <p>Sets the UID used by <em class="parameter"><code>cp</code></em>
796 to <em class="parameter"><code>uid</code></em>
797 .</p>
798 <div class="refsect3">
799 <a name="prelude-client-profile-set-uid.parameters"></a><h4>Parameters</h4>
800 <div class="informaltable"><table width="100%" border="0">
801 <colgroup>
802 <col width="150px" class="parameters_name">
803 <col class="parameters_description">
804 <col width="200px" class="parameters_annotations">
805 </colgroup>
806 <tbody>
807 <tr>
808 <td class="parameter_name"><p>cp</p></td>
809 <td class="parameter_description"><p>Pointer to a <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="type">prelude_client_profile_t</span></a> object.</p></td>
810 <td class="parameter_annotations"> </td>
811 </tr>
812 <tr>
813 <td class="parameter_name"><p>uid</p></td>
814 <td class="parameter_description"><p>UID to be used by <em class="parameter"><code>cp</code></em>
815 .</p></td>
816 <td class="parameter_annotations"> </td>
817 </tr>
818 </tbody>
819 </table></div>
820 </div>
821 </div>
822 <hr>
823 <div class="refsect2">
824 <a name="prelude-client-profile-get-uid"></a><h3>prelude_client_profile_get_uid ()</h3>
825 <pre class="programlisting"><a class="link" href="libprelude-prelude-client-profile.html#prelude-uid-t" title="prelude_uid_t"><span class="returnvalue">prelude_uid_t</span></a>
826 prelude_client_profile_get_uid (<em class="parameter"><code>const <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="type">prelude_client_profile_t</span></a> *cp</code></em>);</pre>
827 <p>Gets the UID associated with <em class="parameter"><code>cp</code></em>
828 .</p>
829 <div class="refsect3">
830 <a name="prelude-client-profile-get-uid.parameters"></a><h4>Parameters</h4>
831 <div class="informaltable"><table width="100%" border="0">
832 <colgroup>
833 <col width="150px" class="parameters_name">
834 <col class="parameters_description">
835 <col width="200px" class="parameters_annotations">
836 </colgroup>
837 <tbody><tr>
838 <td class="parameter_name"><p>cp</p></td>
839 <td class="parameter_description"><p>Pointer to a <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="type">prelude_client_profile_t</span></a> object.</p></td>
840 <td class="parameter_annotations"> </td>
841 </tr></tbody>
842 </table></div>
843 </div>
844 <div class="refsect3">
845 <a name="prelude-client-profile-get-uid.returns"></a><h4>Returns</h4>
846 <p> the UID associated used by <em class="parameter"><code>cp</code></em>
847 .</p>
848 </div>
849 </div>
850 <hr>
851 <div class="refsect2">
852 <a name="prelude-client-profile-set-gid"></a><h3>prelude_client_profile_set_gid ()</h3>
853 <pre class="programlisting"><span class="returnvalue">void</span>
854 prelude_client_profile_set_gid (<em class="parameter"><code><a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="type">prelude_client_profile_t</span></a> *cp</code></em>,
855 <em class="parameter"><code><a class="link" href="libprelude-prelude-client-profile.html#prelude-uid-t" title="prelude_uid_t"><span class="type">prelude_uid_t</span></a> gid</code></em>);</pre>
856 <p>Sets the GID used by <em class="parameter"><code>cp</code></em>
857 to <em class="parameter"><code>gid</code></em>
858 .</p>
859 <div class="refsect3">
860 <a name="prelude-client-profile-set-gid.parameters"></a><h4>Parameters</h4>
861 <div class="informaltable"><table width="100%" border="0">
862 <colgroup>
863 <col width="150px" class="parameters_name">
864 <col class="parameters_description">
865 <col width="200px" class="parameters_annotations">
866 </colgroup>
867 <tbody>
868 <tr>
869 <td class="parameter_name"><p>cp</p></td>
870 <td class="parameter_description"><p>Pointer to a <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="type">prelude_client_profile_t</span></a> object.</p></td>
871 <td class="parameter_annotations"> </td>
872 </tr>
873 <tr>
874 <td class="parameter_name"><p>gid</p></td>
875 <td class="parameter_description"><p>GID to be used by <em class="parameter"><code>cp</code></em>
876 .</p></td>
877 <td class="parameter_annotations"> </td>
878 </tr>
879 </tbody>
880 </table></div>
881 </div>
882 </div>
883 <hr>
884 <div class="refsect2">
885 <a name="prelude-client-profile-get-gid"></a><h3>prelude_client_profile_get_gid ()</h3>
886 <pre class="programlisting"><a class="link" href="libprelude-prelude-client-profile.html#prelude-gid-t" title="prelude_gid_t"><span class="returnvalue">prelude_gid_t</span></a>
887 prelude_client_profile_get_gid (<em class="parameter"><code>const <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="type">prelude_client_profile_t</span></a> *cp</code></em>);</pre>
888 <p>Gets the GID associated with <em class="parameter"><code>cp</code></em>
889 .</p>
890 <div class="refsect3">
891 <a name="prelude-client-profile-get-gid.parameters"></a><h4>Parameters</h4>
892 <div class="informaltable"><table width="100%" border="0">
893 <colgroup>
894 <col width="150px" class="parameters_name">
895 <col class="parameters_description">
896 <col width="200px" class="parameters_annotations">
897 </colgroup>
898 <tbody><tr>
899 <td class="parameter_name"><p>cp</p></td>
900 <td class="parameter_description"><p>Pointer to a <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="type">prelude_client_profile_t</span></a> object.</p></td>
901 <td class="parameter_annotations"> </td>
902 </tr></tbody>
903 </table></div>
904 </div>
905 <div class="refsect3">
906 <a name="prelude-client-profile-get-gid.returns"></a><h4>Returns</h4>
907 <p> the GID associated used by <em class="parameter"><code>cp</code></em>
908 .</p>
909 </div>
910 </div>
911 <hr>
912 <div class="refsect2">
913 <a name="prelude-client-profile-set-name"></a><h3>prelude_client_profile_set_name ()</h3>
914 <pre class="programlisting"><span class="returnvalue">int</span>
915 prelude_client_profile_set_name (<em class="parameter"><code><a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="type">prelude_client_profile_t</span></a> *cp</code></em>,
916 <em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre>
917 <p>Sets the prelude client profile name.</p>
918 <div class="refsect3">
919 <a name="prelude-client-profile-set-name.parameters"></a><h4>Parameters</h4>
920 <div class="informaltable"><table width="100%" border="0">
921 <colgroup>
922 <col width="150px" class="parameters_name">
923 <col class="parameters_description">
924 <col width="200px" class="parameters_annotations">
925 </colgroup>
926 <tbody>
927 <tr>
928 <td class="parameter_name"><p>cp</p></td>
929 <td class="parameter_description"><p>Pointer to a <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="type">prelude_client_profile_t</span></a> object.</p></td>
930 <td class="parameter_annotations"> </td>
931 </tr>
932 <tr>
933 <td class="parameter_name"><p>name</p></td>
934 <td class="parameter_description"><p>Name to associate the profile with.</p></td>
935 <td class="parameter_annotations"> </td>
936 </tr>
937 </tbody>
938 </table></div>
939 </div>
940 <div class="refsect3">
941 <a name="prelude-client-profile-set-name.returns"></a><h4>Returns</h4>
942 <p> 0 on success or a negative value if an error occured.</p>
943 </div>
944 </div>
945 <hr>
946 <div class="refsect2">
947 <a name="prelude-client-profile-get-name"></a><h3>prelude_client_profile_get_name ()</h3>
948 <pre class="programlisting">const <span class="returnvalue">char</span> *
949 prelude_client_profile_get_name (<em class="parameter"><code>const <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="type">prelude_client_profile_t</span></a> *cp</code></em>);</pre>
950 <p>Gets the name of <em class="parameter"><code>cp</code></em>
951 client profile.</p>
952 <div class="refsect3">
953 <a name="prelude-client-profile-get-name.parameters"></a><h4>Parameters</h4>
954 <div class="informaltable"><table width="100%" border="0">
955 <colgroup>
956 <col width="150px" class="parameters_name">
957 <col class="parameters_description">
958 <col width="200px" class="parameters_annotations">
959 </colgroup>
960 <tbody><tr>
961 <td class="parameter_name"><p>cp</p></td>
962 <td class="parameter_description"><p>Pointer to a <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="type">prelude_client_profile_t</span></a> object.</p></td>
963 <td class="parameter_annotations"> </td>
964 </tr></tbody>
965 </table></div>
966 </div>
967 <div class="refsect3">
968 <a name="prelude-client-profile-get-name.returns"></a><h4>Returns</h4>
969 <p> the name used by <em class="parameter"><code>cp</code></em>
970 .</p>
971 </div>
972 </div>
973 <hr>
974 <div class="refsect2">
975 <a name="prelude-client-profile-get-analyzerid"></a><h3>prelude_client_profile_get_analyzerid ()</h3>
976 <pre class="programlisting"><a class="link" href="libprelude-prelude-inttypes.html#uint64-t" title="uint64_t"><span class="returnvalue">uint64_t</span></a>
977 prelude_client_profile_get_analyzerid (<em class="parameter"><code>const <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="type">prelude_client_profile_t</span></a> *cp</code></em>);</pre>
978 <p>Gets the unique and permanent analyzer ident associated with <em class="parameter"><code>cp</code></em>
979 .</p>
980 <div class="refsect3">
981 <a name="prelude-client-profile-get-analyzerid.parameters"></a><h4>Parameters</h4>
982 <div class="informaltable"><table width="100%" border="0">
983 <colgroup>
984 <col width="150px" class="parameters_name">
985 <col class="parameters_description">
986 <col width="200px" class="parameters_annotations">
987 </colgroup>
988 <tbody><tr>
989 <td class="parameter_name"><p>cp</p></td>
990 <td class="parameter_description"><p>Pointer to a <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="type">prelude_client_profile_t</span></a> object.</p></td>
991 <td class="parameter_annotations"> </td>
992 </tr></tbody>
993 </table></div>
994 </div>
995 <div class="refsect3">
996 <a name="prelude-client-profile-get-analyzerid.returns"></a><h4>Returns</h4>
997 <p> the analyzer ident used by <em class="parameter"><code>cp</code></em>
998 .</p>
999 </div>
1000 </div>
1001 <hr>
1002 <div class="refsect2">
1003 <a name="prelude-client-profile-set-analyzerid"></a><h3>prelude_client_profile_set_analyzerid ()</h3>
1004 <pre class="programlisting"><span class="returnvalue">void</span>
1005 prelude_client_profile_set_analyzerid (<em class="parameter"><code><a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="type">prelude_client_profile_t</span></a> *cp</code></em>,
1006 <em class="parameter"><code><a class="link" href="libprelude-prelude-inttypes.html#uint64-t" title="uint64_t"><span class="type">uint64_t</span></a> analyzerid</code></em>);</pre>
1007 <p>Sets the Analyzer ID used by <em class="parameter"><code>cp</code></em>
1008 to <em class="parameter"><code>analyzerid</code></em>
1009 .</p>
1010 <div class="refsect3">
1011 <a name="prelude-client-profile-set-analyzerid.parameters"></a><h4>Parameters</h4>
1012 <div class="informaltable"><table width="100%" border="0">
1013 <colgroup>
1014 <col width="150px" class="parameters_name">
1015 <col class="parameters_description">
1016 <col width="200px" class="parameters_annotations">
1017 </colgroup>
1018 <tbody>
1019 <tr>
1020 <td class="parameter_name"><p>cp</p></td>
1021 <td class="parameter_description"><p>Pointer to a <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="type">prelude_client_profile_t</span></a> object.</p></td>
1022 <td class="parameter_annotations"> </td>
1023 </tr>
1024 <tr>
1025 <td class="parameter_name"><p>analyzerid</p></td>
1026 <td class="parameter_description"><p>Analyzer ID to be used by <em class="parameter"><code>cp</code></em>
1027 .</p></td>
1028 <td class="parameter_annotations"> </td>
1029 </tr>
1030 </tbody>
1031 </table></div>
1032 </div>
1033 </div>
1034 <hr>
1035 <div class="refsect2">
1036 <a name="prelude-client-profile-get-credentials"></a><h3>prelude_client_profile_get_credentials ()</h3>
1037 <pre class="programlisting"><span class="returnvalue">int</span>
1038 prelude_client_profile_get_credentials
1039 (<em class="parameter"><code><a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="type">prelude_client_profile_t</span></a> *cp</code></em>,
1040 <em class="parameter"><code><span class="type">void</span> **credentials</code></em>);</pre>
1041 </div>
1042 </div>
1043 <div class="refsect1">
1044 <a name="libprelude-prelude-client-profile.other_details"></a><h2>Types and Values</h2>
1045 <div class="refsect2">
1046 <a name="prelude-gid-t"></a><h3>prelude_gid_t</h3>
1047 <pre class="programlisting">typedef gid_t prelude_gid_t;
1048 </pre>
1049 </div>
1050 <hr>
1051 <div class="refsect2">
1052 <a name="prelude-uid-t"></a><h3>prelude_uid_t</h3>
1053 <pre class="programlisting">typedef uid_t prelude_uid_t;
1054 </pre>
1055 </div>
1056 <hr>
1057 <div class="refsect2">
1058 <a name="prelude-client-profile-t"></a><h3>prelude_client_profile_t</h3>
1059 <pre class="programlisting">typedef struct prelude_client_profile prelude_client_profile_t;
1060 </pre>
1061 </div>
1062 </div>
1063 </div>
1064 <div class="footer">
1065 <hr>Generated by GTK-Doc V1.28</div>
1066 </body>
1067 </html>