← Back to branch summary

~ubuntu-branches/ubuntu/natty/gnome-keyring/natty

« back to all changes in this revision

Viewing changes to docs/reference/gp11/xml/gp11-module.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-02-16 19:00:06 UTC
  • mfrom: (1.1.58 upstream)
  • Revision ID: james.westby@ubuntu.com-20100216190006-cqpnic4zxlkmmi0o
Tags: 2.29.90git20100218-0ubuntu1
Updated to a git snapshot version

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/gp11/xml/gp11-module.xml
32
32
                                                         <link linkend="gboolean">gboolean</link> token_present);
33
33
<link linkend="gboolean">gboolean</link>            <link linkend="gp11-module-get-pool-sessions">gp11_module_get_pool_sessions</link>       (<link linkend="GP11Module">GP11Module</link> *self);
34
34
<link linkend="void">void</link>                <link linkend="gp11-module-set-pool-sessions">gp11_module_set_pool_sessions</link>       (<link linkend="GP11Module">GP11Module</link> *self,
35
 
                                                         <link linkend="gboolean">gboolean</link> pool_sessions);
 
35
                                                         <link linkend="gboolean">gboolean</link> pool);
36
36
<link linkend="gint">gint</link>                <link linkend="gp11-module-get-auto-authenticate">gp11_module_get_auto_authenticate</link>   (<link linkend="GP11Module">GP11Module</link> *self);
37
37
<link linkend="void">void</link>                <link linkend="gp11-module-set-auto-authenticate">gp11_module_set_auto_authenticate</link>   (<link linkend="GP11Module">GP11Module</link> *self,
38
38
                                                         <link linkend="gint">gint</link> auto_authenticate);
39
39
<link linkend="gboolean">gboolean</link>            <link linkend="gp11-module-enumerate-objects">gp11_module_enumerate_objects</link>       (<link linkend="GP11Module">GP11Module</link> *self,
40
40
                                                         <link linkend="GP11ObjectForeachFunc">GP11ObjectForeachFunc</link> func,
41
 
                                                         <link linkend="gpointer">gpointer</link> user_data);
 
41
                                                         <link linkend="gpointer">gpointer</link> user_data,
 
42
                                                         ...);
42
43
<link linkend="gboolean">gboolean</link>            (<link linkend="GP11ObjectForeachFunc">*GP11ObjectForeachFunc</link>)            (<link linkend="GP11Object">GP11Object</link> *object,
43
44
                                                         <link linkend="gpointer">gpointer</link> user_data);
44
45
                    <link linkend="GP11ModuleInfo">GP11ModuleInfo</link>;
245
246
<refsect2 id="gp11-module-set-pool-sessions" role="function">
246
247
<title>gp11_module_set_pool_sessions ()</title>
247
248
<indexterm zone="gp11-module-set-pool-sessions"><primary sortas="gp11_module_set_pool_sessions">gp11_module_set_pool_sessions</primary></indexterm><programlisting><link linkend="void">void</link>                gp11_module_set_pool_sessions       (<link linkend="GP11Module">GP11Module</link> *self,
248
 
                                                         <link linkend="gboolean">gboolean</link> pool_sessions);</programlisting>
 
249
                                                         <link linkend="gboolean">gboolean</link> pool);</programlisting>
249
250
<para>
250
251
When this is set, sessions will be pooled and reused
251
252
if their flags match when <link linkend="gp11-slot-open-session"><function>gp11_slot_open_session()</function></link> is called.</para>
254
255
<varlistentry><term><parameter>self</parameter>&#160;:</term>
255
256
<listitem><simpara> The module to set the setting on.
256
257
</simpara></listitem></varlistentry>
257
 
<varlistentry><term><parameter>pool_sessions</parameter>&#160;:</term>
258
 
<listitem><simpara>
 
258
<varlistentry><term><parameter>pool</parameter>&#160;:</term>
 
259
<listitem><simpara> Whether to reuse sessions or not.
259
260
</simpara></listitem></varlistentry>
260
261
</variablelist></refsect2>
261
262
<refsect2 id="gp11-module-get-auto-authenticate" role="function">
289
290
<listitem><simpara> The module to set the setting on.
290
291
</simpara></listitem></varlistentry>
291
292
<varlistentry><term><parameter>auto_authenticate</parameter>&#160;:</term>
292
 
<listitem><simpara>
 
293
<listitem><simpara> Whether auto login or not.
293
294
</simpara></listitem></varlistentry>
294
295
</variablelist></refsect2>
295
296
<refsect2 id="gp11-module-enumerate-objects" role="function">
296
297
<title>gp11_module_enumerate_objects ()</title>
297
298
<indexterm zone="gp11-module-enumerate-objects"><primary sortas="gp11_module_enumerate_objects">gp11_module_enumerate_objects</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gp11_module_enumerate_objects       (<link linkend="GP11Module">GP11Module</link> *self,
298
299
                                                         <link linkend="GP11ObjectForeachFunc">GP11ObjectForeachFunc</link> func,
299
 
                                                         <link linkend="gpointer">gpointer</link> user_data);</programlisting>
 
300
                                                         <link linkend="gpointer">gpointer</link> user_data,
 
301
                                                         ...);</programlisting>
300
302
<para>
301
303
Call a function for every matching object on the module. This call may 
302
304
block for an indefinite period.
303
305
</para>
304
306
<para>
305
 
The arguments must be triples of: attribute type, data type, value
306
 
</para>
307
 
<para>
308
307
<para>The variable argument list should contain:
309
308
        <variablelist>
310
309
        <varlistentry>
350
349
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
351
350
<listitem><simpara> Data to pass to the function.
352
351
</simpara></listitem></varlistentry>
 
352
<varlistentry><term><parameter>...</parameter>&#160;:</term>
 
353
<listitem><simpara> The arguments must be triples of: attribute type, data type, value.
 
354
</simpara></listitem></varlistentry>
353
355
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> If FALSE then an error prevented all matching objects from being enumerated.
354
356
</simpara></listitem></varlistentry>
355
357
</variablelist></refsect2>