← Back to branch summary

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

« back to all changes in this revision

Viewing changes to docs/reference/gnome-keyring/xml/gnome-keyring-misc.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/gnome-keyring/xml/gnome-keyring-misc.xml
1
 
<?xml version="1.0"?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
3
 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4
 
<refentry id="gnome-keyring-gnome-keyring-misc">
5
 
<refmeta>
6
 
<refentrytitle role="top_of_page" id="gnome-keyring-gnome-keyring-misc.top_of_page">Miscellaneous Functions</refentrytitle>
7
 
<manvolnum>3</manvolnum>
8
 
<refmiscinfo>GNOME-KEYRING Library</refmiscinfo>
9
 
</refmeta>
10
 
 
11
 
<refnamediv>
12
 
<refname>Miscellaneous Functions</refname>
13
 
<refpurpose>Miscellaneous functions.</refpurpose>
14
 
</refnamediv>
15
 
 
16
 
<refsynopsisdiv id="gnome-keyring-gnome-keyring-misc.synopsis" role="synopsis">
17
 
<title role="synopsis.title">Synopsis</title>
18
 
 
19
 
<synopsis>
20
 
<link linkend="gboolean">gboolean</link>            <link linkend="gnome-keyring-is-available">gnome_keyring_is_available</link>          (void);
21
 
<link linkend="void">void</link>                <link linkend="gnome-keyring-cancel-request">gnome_keyring_cancel_request</link>        (<link linkend="gpointer">gpointer</link> request);
22
 
<link linkend="void">void</link>                <link linkend="gnome-keyring-string-list-free">gnome_keyring_string_list_free</link>      (<link linkend="GList">GList</link> *strings);
23
 
</synopsis>
24
 
</refsynopsisdiv>
25
 
 
26
 
 
27
 
 
28
 
 
29
 
 
30
 
 
31
 
 
32
 
 
33
 
 
34
 
<refsect1 id="gnome-keyring-gnome-keyring-misc.description" role="desc">
35
 
<title role="desc.title">Description</title>
36
 
<para>
37
 
</para>
38
 
<para>
39
 
</para>
40
 
</refsect1>
41
 
 
42
 
<refsect1 id="gnome-keyring-gnome-keyring-misc.details" role="details">
43
 
<title role="details.title">Details</title>
44
 
<refsect2 id="gnome-keyring-is-available" role="function">
45
 
<title>gnome_keyring_is_available ()</title>
46
 
<indexterm zone="gnome-keyring-is-available"><primary sortas="gnome_keyring_is_available">gnome_keyring_is_available</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gnome_keyring_is_available          (void);</programlisting>
47
 
<para>
48
 
Check whether you can communicate with a gnome-keyring-daemon.</para>
49
 
<para>
50
 
</para><variablelist role="params">
51
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> if you can't communicate with the daemon (so you 
52
 
can't load and save passwords).
53
 
</simpara></listitem></varlistentry>
54
 
</variablelist></refsect2>
55
 
<refsect2 id="gnome-keyring-cancel-request" role="function">
56
 
<title>gnome_keyring_cancel_request ()</title>
57
 
<indexterm zone="gnome-keyring-cancel-request"><primary sortas="gnome_keyring_cancel_request">gnome_keyring_cancel_request</primary></indexterm><programlisting><link linkend="void">void</link>                gnome_keyring_cancel_request        (<link linkend="gpointer">gpointer</link> request);</programlisting>
58
 
<para>
59
 
Cancel an asynchronous request. 
60
 
</para>
61
 
<para>
62
 
If a callback was registered when making the asynchronous request, that callback
63
 
function will be called with a result of <link linkend="GNOME-KEYRING-RESULT-CANCELLED--CAPS"><literal>GNOME_KEYRING_RESULT_CANCELLED</literal></link></para>
64
 
<para>
65
 
</para><variablelist role="params">
66
 
<varlistentry><term><parameter>request</parameter>&#160;:</term>
67
 
<listitem><simpara> The request returned from the asynchronous call function. 
68
 
</simpara></listitem></varlistentry>
69
 
</variablelist></refsect2>
70
 
<refsect2 id="gnome-keyring-string-list-free" role="function">
71
 
<title>gnome_keyring_string_list_free ()</title>
72
 
<indexterm zone="gnome-keyring-string-list-free"><primary sortas="gnome_keyring_string_list_free">gnome_keyring_string_list_free</primary></indexterm><programlisting><link linkend="void">void</link>                gnome_keyring_string_list_free      (<link linkend="GList">GList</link> *strings);</programlisting>
73
 
<para>
74
 
Free a list of string pointers.</para>
75
 
<para>
76
 
</para><variablelist role="params">
77
 
<varlistentry><term><parameter>strings</parameter>&#160;:</term>
78
 
<listitem><simpara> A <link linkend="GList"><literal>GList</literal></link> of string pointers. 
79
 
</simpara></listitem></varlistentry>
80
 
</variablelist></refsect2>
81
 
 
82
 
</refsect1>
83
 
 
84
 
 
85
 
 
86
 
 
87
 
</refentry>