/usr/share/gtk-doc/html/libedataserver/libedataserver-ECredentials.html is in libedataserver1.2-dev 3.2.3-0ubuntu7.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ECredentials</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Evolution-Data-Server Manual: Utilities (libedataserver)">
<link rel="up" href="ch01.html" title="Evolution-Data-Server Manual: Utilities (libedataserver)">
<link rel="prev" href="libedataserver-EClient.html" title="EClient">
<link rel="next" href="libedataserver-e-debug-log.html" title="e-debug-log">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libedataserver-EClient.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Evolution-Data-Server Manual: Utilities (libedataserver)</th>
<td><a accesskey="n" href="libedataserver-e-debug-log.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libedataserver-ECredentials.synopsis" class="shortcut">Top</a>
|
<a href="#libedataserver-ECredentials.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libedataserver-ECredentials"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libedataserver-ECredentials.top_of_page"></a>ECredentials</span></h2>
<p>ECredentials</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libedataserver-ECredentials.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials">ECredentials</a>;
#define <a class="link" href="libedataserver-ECredentials.html#E-CREDENTIALS-KEY-USERNAME:CAPS" title="E_CREDENTIALS_KEY_USERNAME">E_CREDENTIALS_KEY_USERNAME</a>
#define <a class="link" href="libedataserver-ECredentials.html#E-CREDENTIALS-KEY-PASSWORD:CAPS" title="E_CREDENTIALS_KEY_PASSWORD">E_CREDENTIALS_KEY_PASSWORD</a>
#define <a class="link" href="libedataserver-ECredentials.html#E-CREDENTIALS-KEY-AUTH-METHOD:CAPS" title="E_CREDENTIALS_KEY_AUTH_METHOD">E_CREDENTIALS_KEY_AUTH_METHOD</a>
#define <a class="link" href="libedataserver-ECredentials.html#E-CREDENTIALS-KEY-PROMPT-TITLE:CAPS" title="E_CREDENTIALS_KEY_PROMPT_TITLE">E_CREDENTIALS_KEY_PROMPT_TITLE</a>
#define <a class="link" href="libedataserver-ECredentials.html#E-CREDENTIALS-KEY-PROMPT-TEXT:CAPS" title="E_CREDENTIALS_KEY_PROMPT_TEXT">E_CREDENTIALS_KEY_PROMPT_TEXT</a>
#define <a class="link" href="libedataserver-ECredentials.html#E-CREDENTIALS-KEY-PROMPT-REASON:CAPS" title="E_CREDENTIALS_KEY_PROMPT_REASON">E_CREDENTIALS_KEY_PROMPT_REASON</a>
#define <a class="link" href="libedataserver-ECredentials.html#E-CREDENTIALS-KEY-PROMPT-KEY:CAPS" title="E_CREDENTIALS_KEY_PROMPT_KEY">E_CREDENTIALS_KEY_PROMPT_KEY</a>
#define <a class="link" href="libedataserver-ECredentials.html#E-CREDENTIALS-KEY-PROMPT-FLAGS:CAPS" title="E_CREDENTIALS_KEY_PROMPT_FLAGS">E_CREDENTIALS_KEY_PROMPT_FLAGS</a>
enum <a class="link" href="libedataserver-ECredentials.html#ECredentialsPromptFlags" title="enum ECredentialsPromptFlags">ECredentialsPromptFlags</a>;
<a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="returnvalue">ECredentials</span></a> * <a class="link" href="libedataserver-ECredentials.html#e-credentials-new" title="e_credentials_new ()">e_credentials_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="returnvalue">ECredentials</span></a> * <a class="link" href="libedataserver-ECredentials.html#e-credentials-new-strv" title="e_credentials_new_strv ()">e_credentials_new_strv</a> (<em class="parameter"><code>const <span class="type">gchar</span> * const *strv</code></em>);
<a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="returnvalue">ECredentials</span></a> * <a class="link" href="libedataserver-ECredentials.html#e-credentials-new-args" title="e_credentials_new_args ()">e_credentials_new_args</a> (<em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>,
<em class="parameter"><code>...</code></em>);
<a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="returnvalue">ECredentials</span></a> * <a class="link" href="libedataserver-ECredentials.html#e-credentials-new-clone" title="e_credentials_new_clone ()">e_credentials_new_clone</a> (<em class="parameter"><code>const <a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="type">ECredentials</span></a> *credentials</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libedataserver-ECredentials.html#e-credentials-free" title="e_credentials_free ()">e_credentials_free</a> (<em class="parameter"><code><a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="type">ECredentials</span></a> *credentials</code></em>);
<span class="returnvalue">gchar</span> ** <a class="link" href="libedataserver-ECredentials.html#e-credentials-to-strv" title="e_credentials_to_strv ()">e_credentials_to_strv</a> (<em class="parameter"><code>const <a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="type">ECredentials</span></a> *credentials</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libedataserver-ECredentials.html#e-credentials-set" title="e_credentials_set ()">e_credentials_set</a> (<em class="parameter"><code><a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="type">ECredentials</span></a> *credentials</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *value</code></em>);
<span class="returnvalue">gchar</span> * <a class="link" href="libedataserver-ECredentials.html#e-credentials-get" title="e_credentials_get ()">e_credentials_get</a> (<em class="parameter"><code>const <a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="type">ECredentials</span></a> *credentials</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="libedataserver-ECredentials.html#e-credentials-peek" title="e_credentials_peek ()">e_credentials_peek</a> (<em class="parameter"><code><a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="type">ECredentials</span></a> *credentials</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libedataserver-ECredentials.html#e-credentials-equal" title="e_credentials_equal ()">e_credentials_equal</a> (<em class="parameter"><code>const <a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="type">ECredentials</span></a> *credentials1</code></em>,
<em class="parameter"><code>const <a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="type">ECredentials</span></a> *credentials2</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libedataserver-ECredentials.html#e-credentials-equal-keys" title="e_credentials_equal_keys ()">e_credentials_equal_keys</a> (<em class="parameter"><code>const <a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="type">ECredentials</span></a> *credentials1</code></em>,
<em class="parameter"><code>const <a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="type">ECredentials</span></a> *credentials2</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *key1</code></em>,
<em class="parameter"><code>...</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libedataserver-ECredentials.html#e-credentials-has-key" title="e_credentials_has_key ()">e_credentials_has_key</a> (<em class="parameter"><code>const <a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="type">ECredentials</span></a> *credentials</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>);
<span class="returnvalue">guint</span> <a class="link" href="libedataserver-ECredentials.html#e-credentials-keys-size" title="e_credentials_keys_size ()">e_credentials_keys_size</a> (<em class="parameter"><code>const <a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="type">ECredentials</span></a> *credentials</code></em>);
<span class="returnvalue">GSList</span> * <a class="link" href="libedataserver-ECredentials.html#e-credentials-list-keys" title="e_credentials_list_keys ()">e_credentials_list_keys</a> (<em class="parameter"><code>const <a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="type">ECredentials</span></a> *credentials</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libedataserver-ECredentials.html#e-credentials-clear" title="e_credentials_clear ()">e_credentials_clear</a> (<em class="parameter"><code><a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="type">ECredentials</span></a> *credentials</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libedataserver-ECredentials.html#e-credentials-clear-peek" title="e_credentials_clear_peek ()">e_credentials_clear_peek</a> (<em class="parameter"><code><a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="type">ECredentials</span></a> *credentials</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libedataserver-ECredentials.html#e-credentials-util-safe-free-string" title="e_credentials_util_safe_free_string ()">e_credentials_util_safe_free_string</a> (<em class="parameter"><code><span class="type">gchar</span> *str</code></em>);
<span class="returnvalue">gchar</span> * <a class="link" href="libedataserver-ECredentials.html#e-credentials-util-prompt-flags-to-string" title="e_credentials_util_prompt_flags_to_string ()">e_credentials_util_prompt_flags_to_string</a>
(<em class="parameter"><code><span class="type">guint</span> prompt_flags</code></em>);
<span class="returnvalue">guint</span> <a class="link" href="libedataserver-ECredentials.html#e-credentials-util-string-to-prompt-flags" title="e_credentials_util_string_to_prompt_flags ()">e_credentials_util_string_to_prompt_flags</a>
(<em class="parameter"><code>const <span class="type">gchar</span> *prompt_flags_string</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libedataserver-ECredentials.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="libedataserver-ECredentials.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="ECredentials"></a><h3>struct ECredentials</h3>
<pre class="programlisting">struct ECredentials {
ECredentialsPrivate *priv;
};
</pre>
<p>
Contains only private data that should be read and manipulated using the
functions below.
</p>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="E-CREDENTIALS-KEY-USERNAME:CAPS"></a><h3>E_CREDENTIALS_KEY_USERNAME</h3>
<pre class="programlisting">#define E_CREDENTIALS_KEY_USERNAME "username"
</pre>
<p>
FIXME Docment me.
</p>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="E-CREDENTIALS-KEY-PASSWORD:CAPS"></a><h3>E_CREDENTIALS_KEY_PASSWORD</h3>
<pre class="programlisting">#define E_CREDENTIALS_KEY_PASSWORD "password"
</pre>
<p>
FIXME Document me.
</p>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="E-CREDENTIALS-KEY-AUTH-METHOD:CAPS"></a><h3>E_CREDENTIALS_KEY_AUTH_METHOD</h3>
<pre class="programlisting">#define E_CREDENTIALS_KEY_AUTH_METHOD "auth-method"
</pre>
<p>
FIXME Document me.
</p>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="E-CREDENTIALS-KEY-PROMPT-TITLE:CAPS"></a><h3>E_CREDENTIALS_KEY_PROMPT_TITLE</h3>
<pre class="programlisting">#define E_CREDENTIALS_KEY_PROMPT_TITLE "prompt-title"
</pre>
<p>
FIXME Document me.
</p>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="E-CREDENTIALS-KEY-PROMPT-TEXT:CAPS"></a><h3>E_CREDENTIALS_KEY_PROMPT_TEXT</h3>
<pre class="programlisting">#define E_CREDENTIALS_KEY_PROMPT_TEXT "prompt-text"
</pre>
<p>
FIXME: Document me.
</p>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="E-CREDENTIALS-KEY-PROMPT-REASON:CAPS"></a><h3>E_CREDENTIALS_KEY_PROMPT_REASON</h3>
<pre class="programlisting">#define E_CREDENTIALS_KEY_PROMPT_REASON "prompt-reason"
</pre>
<p>
FIXME: Document me.
</p>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="E-CREDENTIALS-KEY-PROMPT-KEY:CAPS"></a><h3>E_CREDENTIALS_KEY_PROMPT_KEY</h3>
<pre class="programlisting">#define E_CREDENTIALS_KEY_PROMPT_KEY "prompt-key"
</pre>
<p>
FIXME: Document me.
</p>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="E-CREDENTIALS-KEY-PROMPT-FLAGS:CAPS"></a><h3>E_CREDENTIALS_KEY_PROMPT_FLAGS</h3>
<pre class="programlisting">#define E_CREDENTIALS_KEY_PROMPT_FLAGS "prompt-flags"
</pre>
<p>
FIXME Document me.
</p>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="ECredentialsPromptFlags"></a><h3>enum ECredentialsPromptFlags</h3>
<pre class="programlisting">typedef enum {
E_CREDENTIALS_PROMPT_FLAG_REMEMBER_NEVER,
E_CREDENTIALS_PROMPT_FLAG_REMEMBER_SESSION,
E_CREDENTIALS_PROMPT_FLAG_REMEMBER_FOREVER,
E_CREDENTIALS_PROMPT_FLAG_REMEMBER_MASK = 0xf,
E_CREDENTIALS_PROMPT_FLAG_SECRET = 1 << 8, /* whether hide password letters in the UI */
E_CREDENTIALS_PROMPT_FLAG_REPROMPT = 1 << 9, /* automatically set when username and password is provided */
E_CREDENTIALS_PROMPT_FLAG_ONLINE = 1 << 10, /* only ask if we're online */
E_CREDENTIALS_PROMPT_FLAG_DISABLE_REMEMBER = 1 << 11, /* disable the 'remember password' checkbox */
E_CREDENTIALS_PROMPT_FLAG_PASSPHRASE = 1 << 12 /* We are asking a passphrase */
} ECredentialsPromptFlags;
</pre>
<p>
FIXME Document me.
</p>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="e-credentials-new"></a><h3>e_credentials_new ()</h3>
<pre class="programlisting"><a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="returnvalue">ECredentials</span></a> * e_credentials_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
FIXME: Document me.
</p>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="e-credentials-new-strv"></a><h3>e_credentials_new_strv ()</h3>
<pre class="programlisting"><a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="returnvalue">ECredentials</span></a> * e_credentials_new_strv (<em class="parameter"><code>const <span class="type">gchar</span> * const *strv</code></em>);</pre>
<p>
FIXME: Document me.
</p>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="e-credentials-new-args"></a><h3>e_credentials_new_args ()</h3>
<pre class="programlisting"><a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="returnvalue">ECredentials</span></a> * e_credentials_new_args (<em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>
FIXME: Document me.
</p>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="e-credentials-new-clone"></a><h3>e_credentials_new_clone ()</h3>
<pre class="programlisting"><a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="returnvalue">ECredentials</span></a> * e_credentials_new_clone (<em class="parameter"><code>const <a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="type">ECredentials</span></a> *credentials</code></em>);</pre>
<p>
FIXME: Document me.
</p>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="e-credentials-free"></a><h3>e_credentials_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_credentials_free (<em class="parameter"><code><a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="type">ECredentials</span></a> *credentials</code></em>);</pre>
<p>
FIXME: Document me.
</p>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="e-credentials-to-strv"></a><h3>e_credentials_to_strv ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> ** e_credentials_to_strv (<em class="parameter"><code>const <a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="type">ECredentials</span></a> *credentials</code></em>);</pre>
<p>
Returns <code class="literal">NULL</code>-terminated array of strings with keys and encoded values;
To read them back pass this pointer to <a class="link" href="libedataserver-ECredentials.html#e-credentials-new" title="e_credentials_new ()"><code class="function">e_credentials_new()</code></a>. As it returns
newly allocated string then this should be freed with <code class="function">g_strfreev()</code> when no
longer needed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>credentials</code></em> :</span></p></td>
<td>an <a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="type">ECredentials</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <code class="literal">NULL</code>-terminated array of key/value strings</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="e-credentials-set"></a><h3>e_credentials_set ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_credentials_set (<em class="parameter"><code><a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="type">ECredentials</span></a> *credentials</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *value</code></em>);</pre>
<p>
Sets value for <em class="parameter"><code>key</code></em>, if <em class="parameter"><code>value</code></em> is <code class="literal">NULL</code> or an empty string then <em class="parameter"><code>key</code></em> is
removed. The value is supposed to be in a clear form (unencoded).
<em class="parameter"><code>key</code></em> cannot contain colon.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>credentials</code></em> :</span></p></td>
<td>an <a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="type">ECredentials</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>a key string</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>a value string</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="e-credentials-get"></a><h3>e_credentials_get ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> * e_credentials_get (<em class="parameter"><code>const <a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="type">ECredentials</span></a> *credentials</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>);</pre>
<p>
FIXME: Document me.
</p>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="e-credentials-peek"></a><h3>e_credentials_peek ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * e_credentials_peek (<em class="parameter"><code><a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="type">ECredentials</span></a> *credentials</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>);</pre>
<p>
Peeks at the value for <em class="parameter"><code>key</code></em>, in a clear form. The returned value is valid
until free of the <em class="parameter"><code>credentials</code></em> structure or until the key value is rewritten
by <a class="link" href="libedataserver-ECredentials.html#e-credentials-set" title="e_credentials_set ()"><code class="function">e_credentials_set()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>credentials</code></em> :</span></p></td>
<td>an <a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="type">ECredentials</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>a key string</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the value for <em class="parameter"><code>key</code></em>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="e-credentials-equal"></a><h3>e_credentials_equal ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> e_credentials_equal (<em class="parameter"><code>const <a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="type">ECredentials</span></a> *credentials1</code></em>,
<em class="parameter"><code>const <a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="type">ECredentials</span></a> *credentials2</code></em>);</pre>
<p>
Returns whether two <span class="type">ECredential</span> structures contain the same keys with
same values.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>credentials1</code></em> :</span></p></td>
<td>an <a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="type">ECredentials</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>credentials2</code></em> :</span></p></td>
<td>another <a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="type">ECredentials</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> if they are equal, <code class="literal">FALSE</code> otherwise</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="e-credentials-equal-keys"></a><h3>e_credentials_equal_keys ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> e_credentials_equal_keys (<em class="parameter"><code>const <a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="type">ECredentials</span></a> *credentials1</code></em>,
<em class="parameter"><code>const <a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="type">ECredentials</span></a> *credentials2</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *key1</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>
Returns whether two <a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="type">ECredentials</span></a> structures have the same keys. Key names
are NULL-terminated.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>credentials1</code></em> :</span></p></td>
<td>an <a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="type">ECredentials</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>credentials2</code></em> :</span></p></td>
<td>another <a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="type">ECredentials</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> if the key sets match, <code class="literal">FALSE</code> otherwise</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="e-credentials-has-key"></a><h3>e_credentials_has_key ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> e_credentials_has_key (<em class="parameter"><code>const <a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="type">ECredentials</span></a> *credentials</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>);</pre>
<p>
Returns whether <em class="parameter"><code>credentials</code></em> contains <em class="parameter"><code>key</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>credentials</code></em> :</span></p></td>
<td>an <a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="type">ECredentials</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>a key string</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> if <em class="parameter"><code>credentials</code></em> contains <em class="parameter"><code>key</code></em>, <code class="literal">FALSE</code> otherwise</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="e-credentials-keys-size"></a><h3>e_credentials_keys_size ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span> e_credentials_keys_size (<em class="parameter"><code>const <a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="type">ECredentials</span></a> *credentials</code></em>);</pre>
<p>
Returns the number of keys in <em class="parameter"><code>credentials</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>credentials</code></em> :</span></p></td>
<td>an <a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="type">ECredentials</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the number of keys in <em class="parameter"><code>credentials</code></em>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="e-credentials-list-keys"></a><h3>e_credentials_list_keys ()</h3>
<pre class="programlisting"><span class="returnvalue">GSList</span> * e_credentials_list_keys (<em class="parameter"><code>const <a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="type">ECredentials</span></a> *credentials</code></em>);</pre>
<p>
Returns a newly-allocated <span class="type">GSList</span> of key names stored in <em class="parameter"><code>credentials</code></em>.
The key names are internal credentials values and should not be modified
or freed. Free the list with <code class="function">g_slist_free()</code> when no longer needed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>credentials</code></em> :</span></p></td>
<td>an <a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="type">ECredentials</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a newly-allocated <span class="type">GSList</span> of key names</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="e-credentials-clear"></a><h3>e_credentials_clear ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_credentials_clear (<em class="parameter"><code><a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="type">ECredentials</span></a> *credentials</code></em>);</pre>
<p>
FIXME: Document me.
</p>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="e-credentials-clear-peek"></a><h3>e_credentials_clear_peek ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_credentials_clear_peek (<em class="parameter"><code><a class="link" href="libedataserver-ECredentials.html#ECredentials" title="struct ECredentials"><span class="type">ECredentials</span></a> *credentials</code></em>);</pre>
<p>
FIXME: Document me.
</p>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="e-credentials-util-safe-free-string"></a><h3>e_credentials_util_safe_free_string ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_credentials_util_safe_free_string (<em class="parameter"><code><span class="type">gchar</span> *str</code></em>);</pre>
<p>
FIXME Document me.
</p>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="e-credentials-util-prompt-flags-to-string"></a><h3>e_credentials_util_prompt_flags_to_string ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> * e_credentials_util_prompt_flags_to_string
(<em class="parameter"><code><span class="type">guint</span> prompt_flags</code></em>);</pre>
<p>
FIXME: Document me.
</p>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="e-credentials-util-string-to-prompt-flags"></a><h3>e_credentials_util_string_to_prompt_flags ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span> e_credentials_util_string_to_prompt_flags
(<em class="parameter"><code>const <span class="type">gchar</span> *prompt_flags_string</code></em>);</pre>
<p>
FIXME: Document me.
</p>
<p class="since">Since 3.2</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|