← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/libgnome-keyring/oneiric-201109060911

« back to all changes in this revision

Viewing changes to docs/reference/gnome-keyring/html/gnome-keyring-Keyrings.html

  • Committer: Bazaar Package Importer
  • Author(s): Martin Pitt
  • Date: 2011-05-24 06:46:22 UTC
  • mfrom: (0.4.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20110524064622-opqq0ryso2uqzl01
Tags: 3.0.2-2
Add 01-fix-crash-from-memleak-fix.patch: Fix crash from recent memleak
fix. (See GNOME #650840)

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/gnome-keyring/html/gnome-keyring-Keyrings.html
8
8
<link rel="up" href="ch01.html" title="gnome-keyring API Reference">
9
9
<link rel="prev" href="gnome-keyring-Simple-Password-Storage.html" title="Simple Password Storage">
10
10
<link rel="next" href="gnome-keyring-Keyring-Info.html" title="Keyring Info">
11
 
<meta name="generator" content="GTK-Doc V1.16 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
118
118
<div class="refsect1">
119
119
<a name="gnome-keyring-Keyrings.description"></a><h2>Description</h2>
120
120
<p>
121
 
<code class="literal">gnome</code>-keyring-daemon manages multiple keyrings. Each keyring can store one or more items containing secrets.
122
 
</p>
123
 
<p>
124
 
One of the keyrings is the default keyring, which can in many cases be used by specifying <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for a keyring name.
125
 
</p>
126
 
<p>
127
 
Each keyring can be in a locked or unlocked state. A password must be specified, either by the user or the calling application, to unlock the keyring.
 
121
<code class="code">gnome-keyring-daemon</code> manages multiple keyrings. Each keyring can
 
122
store one or more items containing secrets.
 
123
</p>
 
124
<p>
 
125
One of the keyrings is the default keyring, which can in many cases be used
 
126
by specifying <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for a keyring name.
 
127
</p>
 
128
<p>
 
129
Each keyring can be in a locked or unlocked state. A password must be
 
130
specified, either by the user or the calling application, to unlock the
 
131
keyring.
128
132
</p>
129
133
</div>
130
134
<div class="refsect1">
198
202
<tr>
199
203
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
200
204
<td>
201
 
<code class="literal">GNOME_KEYRING_RESULT_OK</code> if the operation was succcessful or
 
205
<a class="link" href="gnome-keyring-Result-Codes.html#GNOME-KEYRING-RESULT-OK:CAPS"><code class="literal">GNOME_KEYRING_RESULT_OK</code></a> if the operation was succcessful or
202
206
an error result otherwise.</td>
203
207
</tr>
204
208
</tbody>
264
268
<tr>
265
269
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
266
270
<td>
267
 
<code class="literal">GNOME_KEYRING_RESULT_OK</code> if the operation was succcessful or
 
271
<a class="link" href="gnome-keyring-Result-Codes.html#GNOME-KEYRING-RESULT-OK:CAPS"><code class="literal">GNOME_KEYRING_RESULT_OK</code></a> if the operation was succcessful or
268
272
an error result otherwise.</td>
269
273
</tr>
270
274
</tbody>
285
289
<em class="parameter"><code>callback</code></em>. The list is freed after <em class="parameter"><code>callback</code></em> returns.
286
290
</p>
287
291
<p>
288
 
For a synchronous version of this function see <code class="function">gnome_keyring_list_keyrings_sync()</code>.
 
292
For a synchronous version of this function see <a class="link" href="gnome-keyring-Keyrings.html#gnome-keyring-list-keyring-names-sync" title="gnome_keyring_list_keyring_names_sync ()"><code class="function">gnome_keyring_list_keyring_names_sync()</code></a>.
289
293
</p>
290
294
<div class="variablelist"><table border="0">
291
295
<col align="left" valign="top">
334
338
<tr>
335
339
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
336
340
<td>
337
 
<code class="literal">GNOME_KEYRING_RESULT_OK</code> if the operation was succcessful or
 
341
<a class="link" href="gnome-keyring-Result-Codes.html#GNOME-KEYRING-RESULT-OK:CAPS"><code class="literal">GNOME_KEYRING_RESULT_OK</code></a> if the operation was succcessful or
338
342
an error result otherwise.</td>
339
343
</tr>
340
344
</tbody>
391
395
<tbody><tr>
392
396
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
393
397
<td>
394
 
<code class="literal">GNOME_KEYRING_RESULT_OK</code> if the operation was succcessful or
 
398
<a class="link" href="gnome-keyring-Result-Codes.html#GNOME-KEYRING-RESULT-OK:CAPS"><code class="literal">GNOME_KEYRING_RESULT_OK</code></a> if the operation was succcessful or
395
399
an error result otherwise.</td>
396
400
</tr></tbody>
397
401
</table></div>
470
474
<tr>
471
475
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
472
476
<td>
473
 
<code class="literal">GNOME_KEYRING_RESULT_OK</code> if the operation was succcessful or
 
477
<a class="link" href="gnome-keyring-Result-Codes.html#GNOME-KEYRING-RESULT-OK:CAPS"><code class="literal">GNOME_KEYRING_RESULT_OK</code></a> if the operation was succcessful or
474
478
an error result otherwise.</td>
475
479
</tr>
476
480
</tbody>
557
561
<tr>
558
562
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
559
563
<td>
560
 
<code class="literal">GNOME_KEYRING_RESULT_OK</code> if the operation was succcessful or
 
564
<a class="link" href="gnome-keyring-Result-Codes.html#GNOME-KEYRING-RESULT-OK:CAPS"><code class="literal">GNOME_KEYRING_RESULT_OK</code></a> if the operation was succcessful or
561
565
an error result otherwise.</td>
562
566
</tr>
563
567
</tbody>
632
636
<tr>
633
637
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
634
638
<td>
635
 
<code class="literal">GNOME_KEYRING_RESULT_OK</code> if the operation was succcessful or
 
639
<a class="link" href="gnome-keyring-Result-Codes.html#GNOME-KEYRING-RESULT-OK:CAPS"><code class="literal">GNOME_KEYRING_RESULT_OK</code></a> if the operation was succcessful or
636
640
an error result otherwise.</td>
637
641
</tr>
638
642
</tbody>
700
704
<tr>
701
705
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
702
706
<td>
703
 
<code class="literal">GNOME_KEYRING_RESULT_OK</code> if the operation was succcessful or
 
707
<a class="link" href="gnome-keyring-Result-Codes.html#GNOME-KEYRING-RESULT-OK:CAPS"><code class="literal">GNOME_KEYRING_RESULT_OK</code></a> if the operation was succcessful or
704
708
an error result otherwise.</td>
705
709
</tr>
706
710
</tbody>
775
779
<tr>
776
780
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
777
781
<td>
778
 
<code class="literal">GNOME_KEYRING_RESULT_OK</code> if the operation was succcessful or
 
782
<a class="link" href="gnome-keyring-Result-Codes.html#GNOME-KEYRING-RESULT-OK:CAPS"><code class="literal">GNOME_KEYRING_RESULT_OK</code></a> if the operation was succcessful or
779
783
an error result otherwise.</td>
780
784
</tr>
781
785
</tbody>
791
795
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy_data</code></em>);</pre>
792
796
<p>
793
797
Set flags and info for the <em class="parameter"><code>keyring</code></em>. The only fields in <em class="parameter"><code>info</code></em> that are used
794
 
are <code class="literal">lock_on_idle</code> and <code class="literal">lock_timeout</code>.
 
798
are lock_on_idle and lock_timeout.
795
799
</p>
796
800
<p>
797
801
For a synchronous version of this function see <a class="link" href="gnome-keyring-Keyrings.html#gnome-keyring-set-info-sync" title="gnome_keyring_set_info_sync ()"><code class="function">gnome_keyring_set_info_sync()</code></a>.
833
837
                                                         <em class="parameter"><code><a class="link" href="gnome-keyring-Keyring-Info.html#GnomeKeyringInfo" title="GnomeKeyringInfo"><span class="type">GnomeKeyringInfo</span></a> *info</code></em>);</pre>
834
838
<p>
835
839
Set flags and info for <em class="parameter"><code>keyring</code></em>. The only fields in <em class="parameter"><code>info</code></em> that are used
836
 
are <code class="literal">lock_on_idle</code> and <code class="literal">lock_timeout</code>.
 
840
are lock_on_idle and lock_timeout.
837
841
</p>
838
842
<p>
839
843
For an asynchronous version of this function see <a class="link" href="gnome-keyring-Keyrings.html#gnome-keyring-set-info" title="gnome_keyring_set_info ()"><code class="function">gnome_keyring_set_info()</code></a>.
852
856
<tr>
853
857
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
854
858
<td>
855
 
<code class="literal">GNOME_KEYRING_RESULT_OK</code> if the operation was succcessful or
 
859
<a class="link" href="gnome-keyring-Result-Codes.html#GNOME-KEYRING-RESULT-OK:CAPS"><code class="literal">GNOME_KEYRING_RESULT_OK</code></a> if the operation was succcessful or
856
860
an error result otherwise.</td>
857
861
</tr>
858
862
</tbody>
942
946
<tr>
943
947
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
944
948
<td>
945
 
<code class="literal">GNOME_KEYRING_RESULT_OK</code> if the operation was succcessful or
 
949
<a class="link" href="gnome-keyring-Result-Codes.html#GNOME-KEYRING-RESULT-OK:CAPS"><code class="literal">GNOME_KEYRING_RESULT_OK</code></a> if the operation was succcessful or
946
950
an error result otherwise.</td>
947
951
</tr>
948
952
</tbody>
961
965
The list is freed after <em class="parameter"><code>callback</code></em> returns.
962
966
</p>
963
967
<p>
964
 
All items that are not flagged as <code class="literal">GNOME_KEYRING_ITEM_APPLICATION_SECRET</code> are
 
968
All items that are not flagged as <a class="link" href="gnome-keyring-Keyring-Items.html#GNOME-KEYRING-ITEM-APPLICATION-SECRET:CAPS" title="GNOME_KEYRING_ITEM_APPLICATION_SECRET"><code class="literal">GNOME_KEYRING_ITEM_APPLICATION_SECRET</code></a> are
965
969
included in the list. This includes items that the calling application may not
966
970
(yet) have access to.
967
971
</p>
1023
1027
<tr>
1024
1028
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1025
1029
<td>
1026
 
<code class="literal">GNOME_KEYRING_RESULT_OK</code> if the operation was succcessful or
 
1030
<a class="link" href="gnome-keyring-Result-Codes.html#GNOME-KEYRING-RESULT-OK:CAPS"><code class="literal">GNOME_KEYRING_RESULT_OK</code></a> if the operation was succcessful or
1027
1031
an error result otherwise.</td>
1028
1032
</tr>
1029
1033
</tbody>
1033
1037
</div>
1034
1038
<div class="footer">
1035
1039
<hr>
1036
 
          Generated by GTK-Doc V1.16</div>
 
1040
          Generated by GTK-Doc V1.17</div>
1037
1041
</body>
1038
1042
</html>
 
 
b'\\ No newline at end of file'