← 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-item-info.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-item-info.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-item-info">
5
 
<refmeta>
6
 
<refentrytitle role="top_of_page" id="gnome-keyring-gnome-keyring-item-info.top_of_page">Item Information</refentrytitle>
7
 
<manvolnum>3</manvolnum>
8
 
<refmiscinfo>GNOME-KEYRING Library</refmiscinfo>
9
 
</refmeta>
10
 
 
11
 
<refnamediv>
12
 
<refname>Item Information</refname>
13
 
<refpurpose>Keyring Item Info</refpurpose>
14
 
</refnamediv>
15
 
 
16
 
<refsynopsisdiv id="gnome-keyring-gnome-keyring-item-info.synopsis" role="synopsis">
17
 
<title role="synopsis.title">Synopsis</title>
18
 
 
19
 
<synopsis>
20
 
enum                <link linkend="GnomeKeyringItemType">GnomeKeyringItemType</link>;
21
 
typedef             <link linkend="GnomeKeyringItemInfo">GnomeKeyringItemInfo</link>;
22
 
<link linkend="void">void</link>                <link linkend="gnome-keyring-item-info-free">gnome_keyring_item_info_free</link>        (<link linkend="GnomeKeyringItemInfo">GnomeKeyringItemInfo</link> *item_info);
23
 
<link linkend="GnomeKeyringItemInfo">GnomeKeyringItemInfo</link> * <link linkend="gnome-keyring-item-info-new">gnome_keyring_item_info_new</link>      (void);
24
 
<link linkend="GnomeKeyringItemInfo">GnomeKeyringItemInfo</link> * <link linkend="gnome-keyring-item-info-copy">gnome_keyring_item_info_copy</link>     (<link linkend="GnomeKeyringItemInfo">GnomeKeyringItemInfo</link> *item_info);
25
 
<link linkend="GnomeKeyringItemType">GnomeKeyringItemType</link>  <link linkend="gnome-keyring-item-info-get-type">gnome_keyring_item_info_get_type</link>  (<link linkend="GnomeKeyringItemInfo">GnomeKeyringItemInfo</link> *item_info);
26
 
<link linkend="void">void</link>                <link linkend="gnome-keyring-item-info-set-type">gnome_keyring_item_info_set_type</link>    (<link linkend="GnomeKeyringItemInfo">GnomeKeyringItemInfo</link> *item_info,
27
 
                                                         <link linkend="GnomeKeyringItemType">GnomeKeyringItemType</link> type);
28
 
<link linkend="char">char</link> *              <link linkend="gnome-keyring-item-info-get-secret">gnome_keyring_item_info_get_secret</link>  (<link linkend="GnomeKeyringItemInfo">GnomeKeyringItemInfo</link> *item_info);
29
 
<link linkend="void">void</link>                <link linkend="gnome-keyring-item-info-set-secret">gnome_keyring_item_info_set_secret</link>  (<link linkend="GnomeKeyringItemInfo">GnomeKeyringItemInfo</link> *item_info,
30
 
                                                         const <link linkend="char">char</link> *value);
31
 
<link linkend="char">char</link> *              <link linkend="gnome-keyring-item-info-get-display-name">gnome_keyring_item_info_get_display_name</link>
32
 
                                                        (<link linkend="GnomeKeyringItemInfo">GnomeKeyringItemInfo</link> *item_info);
33
 
<link linkend="void">void</link>                <link linkend="gnome-keyring-item-info-set-display-name">gnome_keyring_item_info_set_display_name</link>
34
 
                                                        (<link linkend="GnomeKeyringItemInfo">GnomeKeyringItemInfo</link> *item_info,
35
 
                                                         const <link linkend="char">char</link> *value);
36
 
<link linkend="time-t">time_t</link>              <link linkend="gnome-keyring-item-info-get-mtime">gnome_keyring_item_info_get_mtime</link>   (<link linkend="GnomeKeyringItemInfo">GnomeKeyringItemInfo</link> *item_info);
37
 
<link linkend="time-t">time_t</link>              <link linkend="gnome-keyring-item-info-get-ctime">gnome_keyring_item_info_get_ctime</link>   (<link linkend="GnomeKeyringItemInfo">GnomeKeyringItemInfo</link> *item_info);
38
 
</synopsis>
39
 
</refsynopsisdiv>
40
 
 
41
 
 
42
 
 
43
 
 
44
 
 
45
 
 
46
 
 
47
 
 
48
 
 
49
 
<refsect1 id="gnome-keyring-gnome-keyring-item-info.description" role="desc">
50
 
<title role="desc.title">Description</title>
51
 
<para>
52
 
<link linkend="GnomeKeyringItemInfo"><type>GnomeKeyringItemInfo</type></link> represents the basic information about a keyring item.
53
 
Use <link linkend="gnome-keyring-item-get-info"><function>gnome_keyring_item_get_info()</function></link> or <link linkend="gnome-keyring-item-set-info"><function>gnome_keyring_item_set_info()</function></link>.</para>
54
 
<para>
55
 
</para>
56
 
</refsect1>
57
 
 
58
 
<refsect1 id="gnome-keyring-gnome-keyring-item-info.details" role="details">
59
 
<title role="details.title">Details</title>
60
 
<refsect2 id="GnomeKeyringItemType" role="enum">
61
 
<title>enum GnomeKeyringItemType</title>
62
 
<indexterm zone="GnomeKeyringItemType"><primary sortas="GnomeKeyringItemType">GnomeKeyringItemType</primary></indexterm><programlisting>typedef enum {
63
 
 
64
 
        /* The item types */
65
 
        GNOME_KEYRING_ITEM_GENERIC_SECRET = 0,
66
 
        GNOME_KEYRING_ITEM_NETWORK_PASSWORD,
67
 
        GNOME_KEYRING_ITEM_NOTE,
68
 
        GNOME_KEYRING_ITEM_CHAINED_KEYRING_PASSWORD,
69
 
        GNOME_KEYRING_ITEM_ENCRYPTION_KEY_PASSWORD,
70
 
        
71
 
        GNOME_KEYRING_ITEM_PK_STORAGE = 0x100,
72
 
        
73
 
        /* Not used, remains here only for compatibility */
74
 
        GNOME_KEYRING_ITEM_LAST_TYPE,
75
 
 
76
 
} GnomeKeyringItemType;
77
 
</programlisting>
78
 
<para>
79
 
</para></refsect2>
80
 
<refsect2 id="GnomeKeyringItemInfo" role="typedef">
81
 
<title>GnomeKeyringItemInfo</title>
82
 
<indexterm zone="GnomeKeyringItemInfo"><primary sortas="GnomeKeyringItemInfo">GnomeKeyringItemInfo</primary></indexterm><programlisting>typedef struct GnomeKeyringItemInfo GnomeKeyringItemInfo;
83
 
</programlisting>
84
 
<para>
85
 
</para></refsect2>
86
 
<refsect2 id="gnome-keyring-item-info-free" role="function">
87
 
<title>gnome_keyring_item_info_free ()</title>
88
 
<indexterm zone="gnome-keyring-item-info-free"><primary sortas="gnome_keyring_item_info_free">gnome_keyring_item_info_free</primary></indexterm><programlisting><link linkend="void">void</link>                gnome_keyring_item_info_free        (<link linkend="GnomeKeyringItemInfo">GnomeKeyringItemInfo</link> *item_info);</programlisting>
89
 
<para>
90
 
Free the <link linkend="GnomeKeyringItemInfo"><type>GnomeKeyringItemInfo</type></link> object. 
91
 
</para>
92
 
<para>
93
 
A <link linkend="NULL--CAPS"><literal>NULL</literal></link> pointer may be passed, in which case it will be ignored.</para>
94
 
<para>
95
 
</para><variablelist role="params">
96
 
<varlistentry><term><parameter>item_info</parameter>&#160;:</term>
97
 
<listitem><simpara> The keyring item info pointer.
98
 
</simpara></listitem></varlistentry>
99
 
</variablelist></refsect2>
100
 
<refsect2 id="gnome-keyring-item-info-new" role="function">
101
 
<title>gnome_keyring_item_info_new ()</title>
102
 
<indexterm zone="gnome-keyring-item-info-new"><primary sortas="gnome_keyring_item_info_new">gnome_keyring_item_info_new</primary></indexterm><programlisting><link linkend="GnomeKeyringItemInfo">GnomeKeyringItemInfo</link> * gnome_keyring_item_info_new      (void);</programlisting>
103
 
<para>
104
 
Create a new <link linkend="GnomeKeyringItemInfo"><type>GnomeKeyringItemInfo</type></link> object.
105
 
Free the <link linkend="GnomeKeyringItemInfo"><type>GnomeKeyringItemInfo</type></link> object.</para>
106
 
<para>
107
 
</para><variablelist role="params">
108
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A keyring item info pointer.
109
 
</simpara></listitem></varlistentry>
110
 
</variablelist></refsect2>
111
 
<refsect2 id="gnome-keyring-item-info-copy" role="function">
112
 
<title>gnome_keyring_item_info_copy ()</title>
113
 
<indexterm zone="gnome-keyring-item-info-copy"><primary sortas="gnome_keyring_item_info_copy">gnome_keyring_item_info_copy</primary></indexterm><programlisting><link linkend="GnomeKeyringItemInfo">GnomeKeyringItemInfo</link> * gnome_keyring_item_info_copy     (<link linkend="GnomeKeyringItemInfo">GnomeKeyringItemInfo</link> *item_info);</programlisting>
114
 
<para>
115
 
Copy a <link linkend="GnomeKeyringItemInfo"><type>GnomeKeyringItemInfo</type></link> object.</para>
116
 
<para>
117
 
</para><variablelist role="params">
118
 
<varlistentry><term><parameter>item_info</parameter>&#160;:</term>
119
 
<listitem><simpara> A keyring item info pointer.
120
 
</simpara></listitem></varlistentry>
121
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A keyring item info pointer.
122
 
</simpara></listitem></varlistentry>
123
 
</variablelist></refsect2>
124
 
<refsect2 id="gnome-keyring-item-info-get-type" role="function">
125
 
<title>gnome_keyring_item_info_get_type ()</title>
126
 
<indexterm zone="gnome-keyring-item-info-get-type"><primary sortas="gnome_keyring_item_info_get_type">gnome_keyring_item_info_get_type</primary></indexterm><programlisting><link linkend="GnomeKeyringItemType">GnomeKeyringItemType</link>  gnome_keyring_item_info_get_type  (<link linkend="GnomeKeyringItemInfo">GnomeKeyringItemInfo</link> *item_info);</programlisting>
127
 
<para>
128
 
Get the item type.</para>
129
 
<para>
130
 
</para><variablelist role="params">
131
 
<varlistentry><term><parameter>item_info</parameter>&#160;:</term>
132
 
<listitem><simpara> A keyring item info pointer.
133
 
</simpara></listitem></varlistentry>
134
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The item type
135
 
</simpara></listitem></varlistentry>
136
 
</variablelist></refsect2>
137
 
<refsect2 id="gnome-keyring-item-info-set-type" role="function">
138
 
<title>gnome_keyring_item_info_set_type ()</title>
139
 
<indexterm zone="gnome-keyring-item-info-set-type"><primary sortas="gnome_keyring_item_info_set_type">gnome_keyring_item_info_set_type</primary></indexterm><programlisting><link linkend="void">void</link>                gnome_keyring_item_info_set_type    (<link linkend="GnomeKeyringItemInfo">GnomeKeyringItemInfo</link> *item_info,
140
 
                                                         <link linkend="GnomeKeyringItemType">GnomeKeyringItemType</link> type);</programlisting>
141
 
<para>
142
 
Set the type on an item info.</para>
143
 
<para>
144
 
</para><variablelist role="params">
145
 
<varlistentry><term><parameter>item_info</parameter>&#160;:</term>
146
 
<listitem><simpara> A keyring item info pointer.
147
 
</simpara></listitem></varlistentry>
148
 
<varlistentry><term><parameter>type</parameter>&#160;:</term>
149
 
<listitem><simpara> The new item type
150
 
</simpara></listitem></varlistentry>
151
 
</variablelist></refsect2>
152
 
<refsect2 id="gnome-keyring-item-info-get-secret" role="function">
153
 
<title>gnome_keyring_item_info_get_secret ()</title>
154
 
<indexterm zone="gnome-keyring-item-info-get-secret"><primary sortas="gnome_keyring_item_info_get_secret">gnome_keyring_item_info_get_secret</primary></indexterm><programlisting><link linkend="char">char</link> *              gnome_keyring_item_info_get_secret  (<link linkend="GnomeKeyringItemInfo">GnomeKeyringItemInfo</link> *item_info);</programlisting>
155
 
<para>
156
 
Get the item secret.</para>
157
 
<para>
158
 
</para><variablelist role="params">
159
 
<varlistentry><term><parameter>item_info</parameter>&#160;:</term>
160
 
<listitem><simpara> A keyring item info pointer.
161
 
</simpara></listitem></varlistentry>
162
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The newly allocated string containing the item secret.
163
 
</simpara></listitem></varlistentry>
164
 
</variablelist></refsect2>
165
 
<refsect2 id="gnome-keyring-item-info-set-secret" role="function">
166
 
<title>gnome_keyring_item_info_set_secret ()</title>
167
 
<indexterm zone="gnome-keyring-item-info-set-secret"><primary sortas="gnome_keyring_item_info_set_secret">gnome_keyring_item_info_set_secret</primary></indexterm><programlisting><link linkend="void">void</link>                gnome_keyring_item_info_set_secret  (<link linkend="GnomeKeyringItemInfo">GnomeKeyringItemInfo</link> *item_info,
168
 
                                                         const <link linkend="char">char</link> *value);</programlisting>
169
 
<para>
170
 
Set the secret on an item info.</para>
171
 
<para>
172
 
</para><variablelist role="params">
173
 
<varlistentry><term><parameter>item_info</parameter>&#160;:</term>
174
 
<listitem><simpara> A keyring item info pointer.
175
 
</simpara></listitem></varlistentry>
176
 
<varlistentry><term><parameter>value</parameter>&#160;:</term>
177
 
<listitem><simpara> The new item secret
178
 
</simpara></listitem></varlistentry>
179
 
</variablelist></refsect2>
180
 
<refsect2 id="gnome-keyring-item-info-get-display-name" role="function">
181
 
<title>gnome_keyring_item_info_get_display_name ()</title>
182
 
<indexterm zone="gnome-keyring-item-info-get-display-name"><primary sortas="gnome_keyring_item_info_get_display_name">gnome_keyring_item_info_get_display_name</primary></indexterm><programlisting><link linkend="char">char</link> *              gnome_keyring_item_info_get_display_name
183
 
                                                        (<link linkend="GnomeKeyringItemInfo">GnomeKeyringItemInfo</link> *item_info);</programlisting>
184
 
<para>
185
 
Get the item display name.</para>
186
 
<para>
187
 
</para><variablelist role="params">
188
 
<varlistentry><term><parameter>item_info</parameter>&#160;:</term>
189
 
<listitem><simpara> A keyring item info pointer.
190
 
</simpara></listitem></varlistentry>
191
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The newly allocated string containing the item display name.
192
 
</simpara></listitem></varlistentry>
193
 
</variablelist></refsect2>
194
 
<refsect2 id="gnome-keyring-item-info-set-display-name" role="function">
195
 
<title>gnome_keyring_item_info_set_display_name ()</title>
196
 
<indexterm zone="gnome-keyring-item-info-set-display-name"><primary sortas="gnome_keyring_item_info_set_display_name">gnome_keyring_item_info_set_display_name</primary></indexterm><programlisting><link linkend="void">void</link>                gnome_keyring_item_info_set_display_name
197
 
                                                        (<link linkend="GnomeKeyringItemInfo">GnomeKeyringItemInfo</link> *item_info,
198
 
                                                         const <link linkend="char">char</link> *value);</programlisting>
199
 
<para>
200
 
Set the display name on an item info.</para>
201
 
<para>
202
 
</para><variablelist role="params">
203
 
<varlistentry><term><parameter>item_info</parameter>&#160;:</term>
204
 
<listitem><simpara> A keyring item info pointer.
205
 
</simpara></listitem></varlistentry>
206
 
<varlistentry><term><parameter>value</parameter>&#160;:</term>
207
 
<listitem><simpara> The new display name.
208
 
</simpara></listitem></varlistentry>
209
 
</variablelist></refsect2>
210
 
<refsect2 id="gnome-keyring-item-info-get-mtime" role="function">
211
 
<title>gnome_keyring_item_info_get_mtime ()</title>
212
 
<indexterm zone="gnome-keyring-item-info-get-mtime"><primary sortas="gnome_keyring_item_info_get_mtime">gnome_keyring_item_info_get_mtime</primary></indexterm><programlisting><link linkend="time-t">time_t</link>              gnome_keyring_item_info_get_mtime   (<link linkend="GnomeKeyringItemInfo">GnomeKeyringItemInfo</link> *item_info);</programlisting>
213
 
<para>
214
 
Get the item last modified time.</para>
215
 
<para>
216
 
</para><variablelist role="params">
217
 
<varlistentry><term><parameter>item_info</parameter>&#160;:</term>
218
 
<listitem><simpara> A keyring item info pointer.
219
 
</simpara></listitem></varlistentry>
220
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The item last modified time.
221
 
</simpara></listitem></varlistentry>
222
 
</variablelist></refsect2>
223
 
<refsect2 id="gnome-keyring-item-info-get-ctime" role="function">
224
 
<title>gnome_keyring_item_info_get_ctime ()</title>
225
 
<indexterm zone="gnome-keyring-item-info-get-ctime"><primary sortas="gnome_keyring_item_info_get_ctime">gnome_keyring_item_info_get_ctime</primary></indexterm><programlisting><link linkend="time-t">time_t</link>              gnome_keyring_item_info_get_ctime   (<link linkend="GnomeKeyringItemInfo">GnomeKeyringItemInfo</link> *item_info);</programlisting>
226
 
<para>
227
 
Get the item created time.</para>
228
 
<para>
229
 
</para><variablelist role="params">
230
 
<varlistentry><term><parameter>item_info</parameter>&#160;:</term>
231
 
<listitem><simpara> A keyring item info pointer.
232
 
</simpara></listitem></varlistentry>
233
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The item created time.
234
 
</simpara></listitem></varlistentry>
235
 
</variablelist></refsect2>
236
 
 
237
 
</refsect1>
238
 
 
239
 
 
240
 
 
241
 
 
242
 
</refentry>