/usr/share/gtk-doc/html/libedataserverui/libedataserverui-e-passwords.html is in libedataserverui-3.0-dev 3.2.3-0ubuntu6.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>e-passwords</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Evolution-Data-Server Manual: Graphical Utilities (libedataserverui)">
<link rel="up" href="ch01.html" title="Evolution-Data-Server Manual: Graphical Utilities (libedataserverui)">
<link rel="prev" href="libedataserverui-ENameSelectorModel.html" title="ENameSelectorModel">
<link rel="next" href="libedataserverui-ESourceComboBox.html" title="ESourceComboBox">
<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="libedataserverui-ENameSelectorModel.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: Graphical Utilities (libedataserverui)</th>
<td><a accesskey="n" href="libedataserverui-ESourceComboBox.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libedataserverui-e-passwords.synopsis" class="shortcut">Top</a>
|
<a href="#libedataserverui-e-passwords.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libedataserverui-e-passwords"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libedataserverui-e-passwords.top_of_page"></a>e-passwords</span></h2>
<p>e-passwords</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libedataserverui-e-passwords.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"><span class="returnvalue">void</span> <a class="link" href="libedataserverui-e-passwords.html#e-passwords-init" title="e_passwords_init ()">e_passwords_init</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="libedataserverui-e-passwords.html#e-passwords-shutdown" title="e_passwords_shutdown ()">e_passwords_shutdown</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="libedataserverui-e-passwords.html#e-passwords-cancel" title="e_passwords_cancel ()">e_passwords_cancel</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="libedataserverui-e-passwords.html#e-passwords-set-online" title="e_passwords_set_online ()">e_passwords_set_online</a> (<em class="parameter"><code><span class="type">gint</span> state</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libedataserverui-e-passwords.html#e-passwords-remember-password" title="e_passwords_remember_password ()">e_passwords_remember_password</a> (<em class="parameter"><code>const <span class="type">gchar</span> *unused</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libedataserverui-e-passwords.html#e-passwords-add-password" title="e_passwords_add_password ()">e_passwords_add_password</a> (<em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *passwd</code></em>);
<span class="returnvalue">gchar</span> * <a class="link" href="libedataserverui-e-passwords.html#e-passwords-get-password" title="e_passwords_get_password ()">e_passwords_get_password</a> (<em class="parameter"><code>const <span class="type">gchar</span> *unused</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libedataserverui-e-passwords.html#e-passwords-forget-password" title="e_passwords_forget_password ()">e_passwords_forget_password</a> (<em class="parameter"><code>const <span class="type">gchar</span> *unused</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libedataserverui-e-passwords.html#e-passwords-forget-passwords" title="e_passwords_forget_passwords ()">e_passwords_forget_passwords</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="libedataserverui-e-passwords.html#e-passwords-clear-passwords" title="e_passwords_clear_passwords ()">e_passwords_clear_passwords</a> (<em class="parameter"><code>const <span class="type">gchar</span> *unused</code></em>);
enum <a class="link" href="libedataserverui-e-passwords.html#EPasswordsRememberType" title="enum EPasswordsRememberType">EPasswordsRememberType</a>;
<span class="returnvalue">gchar</span> * <a class="link" href="libedataserverui-e-passwords.html#e-passwords-ask-password" title="e_passwords_ask_password ()">e_passwords_ask_password</a> (<em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *unused</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> *prompt</code></em>,
<em class="parameter"><code><a class="link" href="libedataserverui-e-passwords.html#EPasswordsRememberType" title="enum EPasswordsRememberType"><span class="type">EPasswordsRememberType</span></a> remember_type</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> *remember</code></em>,
<em class="parameter"><code><span class="type">GtkWindow</span> *parent</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libedataserverui-e-passwords.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="libedataserverui-e-passwords.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="e-passwords-init"></a><h3>e_passwords_init ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_passwords_init (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Initializes the e_passwords routines. Must be called before any other
e_passwords_* function.
</p>
</div>
<hr>
<div class="refsect2">
<a name="e-passwords-shutdown"></a><h3>e_passwords_shutdown ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_passwords_shutdown (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Cleanup routine to call before exiting.
</p>
</div>
<hr>
<div class="refsect2">
<a name="e-passwords-cancel"></a><h3>e_passwords_cancel ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_passwords_cancel (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Cancel any outstanding password operations and close any dialogues
currently being shown.
</p>
</div>
<hr>
<div class="refsect2">
<a name="e-passwords-set-online"></a><h3>e_passwords_set_online ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_passwords_set_online (<em class="parameter"><code><span class="type">gint</span> state</code></em>);</pre>
<p>
Set the offline-state of the application. This is a work-around
for having the backends fully offline aware, and returns a
cancellation response instead of prompting for passwords.
</p>
<p>
FIXME: This is not a permanent api, review post 2.0.
</p>
</div>
<hr>
<div class="refsect2">
<a name="e-passwords-remember-password"></a><h3>e_passwords_remember_password ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_passwords_remember_password (<em class="parameter"><code>const <span class="type">gchar</span> *unused</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>);</pre>
<p>
Saves the password associated with <em class="parameter"><code>key</code></em> to disk.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>the key</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-passwords-add-password"></a><h3>e_passwords_add_password ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_passwords_add_password (<em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *passwd</code></em>);</pre>
<p>
This stores the <em class="parameter"><code>key</code></em>/<em class="parameter"><code>passwd</code></em> pair in the current session's password
hash.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>a key</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>passwd</code></em> :</span></p></td>
<td>the password for <em class="parameter"><code>key</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-passwords-get-password"></a><h3>e_passwords_get_password ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> * e_passwords_get_password (<em class="parameter"><code>const <span class="type">gchar</span> *unused</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>the key</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the password associated with <em class="parameter"><code>key</code></em>, or <code class="literal">NULL</code>. Caller
must free the returned password.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-passwords-forget-password"></a><h3>e_passwords_forget_password ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_passwords_forget_password (<em class="parameter"><code>const <span class="type">gchar</span> *unused</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>);</pre>
<p>
Forgets the password associated with <em class="parameter"><code>key</code></em>, in memory and on disk.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>the key</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-passwords-forget-passwords"></a><h3>e_passwords_forget_passwords ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_passwords_forget_passwords (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Forgets all cached passwords, in memory and on disk.
</p>
</div>
<hr>
<div class="refsect2">
<a name="e-passwords-clear-passwords"></a><h3>e_passwords_clear_passwords ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_passwords_clear_passwords (<em class="parameter"><code>const <span class="type">gchar</span> *unused</code></em>);</pre>
<p>
Forgets all disk cached passwords for the component.
</p>
</div>
<hr>
<div class="refsect2">
<a name="EPasswordsRememberType"></a><h3>enum EPasswordsRememberType</h3>
<pre class="programlisting">typedef enum {
E_PASSWORDS_REMEMBER_NEVER,
E_PASSWORDS_REMEMBER_SESSION,
E_PASSWORDS_REMEMBER_FOREVER,
E_PASSWORDS_REMEMBER_MASK = 0xf,
/* option bits */
E_PASSWORDS_SECRET = 1 << 8,
E_PASSWORDS_REPROMPT = 1 << 9,
E_PASSWORDS_ONLINE = 1<<10, /* only ask if we're online */
E_PASSWORDS_DISABLE_REMEMBER = 1<<11, /* disable the 'remember password' checkbox */
E_PASSWORDS_PASSPHRASE = 1<<12 /* We are asking a passphrase */
} EPasswordsRememberType;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="e-passwords-ask-password"></a><h3>e_passwords_ask_password ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> * e_passwords_ask_password (<em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *unused</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> *prompt</code></em>,
<em class="parameter"><code><a class="link" href="libedataserverui-e-passwords.html#EPasswordsRememberType" title="enum EPasswordsRememberType"><span class="type">EPasswordsRememberType</span></a> remember_type</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> *remember</code></em>,
<em class="parameter"><code><span class="type">GtkWindow</span> *parent</code></em>);</pre>
<p>
Asks the user for a password.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>title</code></em> :</span></p></td>
<td>title for the password dialog</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>key to store the password under</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>prompt</code></em> :</span></p></td>
<td>prompt string</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>remember</code></em> :</span></p></td>
<td>on input, the default state of the remember checkbox.
on output, the state of the checkbox when the dialog was closed.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>parent</code></em> :</span></p></td>
<td>parent window of the dialog, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the password, which the caller must free, or <code class="literal">NULL</code> if
the user cancelled the operation. *<em class="parameter"><code>remember</code></em> will be set if the
return value is non-<code class="literal">NULL</code> and <em class="parameter"><code>remember_type</code></em> is not
E_PASSWORDS_DO_NOT_REMEMBER.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|