~ubuntu-branches/ubuntu/vivid/glib2.0/vivid-proposed

« back to all changes in this revision

Viewing changes to docs/reference/gio/html/GTlsPassword.html

  • Committer: Package Import Robot
  • Author(s): Andreas Henriksson
  • Date: 2014-03-24 20:58:34 UTC
  • mfrom: (1.66.13)
  • Revision ID: package-import@ubuntu.com-20140324205834-8hsgok8k36ftocqa
Tags: 2.40.0-1
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
50
50
</td>
51
51
</tr>
52
52
<tr>
53
 
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#guchar"><span class="returnvalue">guchar</span></a> *
 
53
<td class="function_type">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guchar"><span class="returnvalue">guchar</span></a> *
54
54
</td>
55
55
<td class="function_name">
56
56
<a class="link" href="GTlsPassword.html#g-tls-password-get-value" title="g_tls_password_get_value ()">g_tls_password_get_value</a> <span class="c_punctuation">()</span>
73
73
</td>
74
74
</tr>
75
75
<tr>
76
 
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 
76
<td class="function_type">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
77
77
</td>
78
78
<td class="function_name">
79
79
<a class="link" href="GTlsPassword.html#g-tls-password-get-description" title="g_tls_password_get_description ()">g_tls_password_get_description</a> <span class="c_punctuation">()</span>
104
104
</td>
105
105
</tr>
106
106
<tr>
107
 
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 
107
<td class="function_type">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
108
108
</td>
109
109
<td class="function_name">
110
110
<a class="link" href="GTlsPassword.html#g-tls-password-get-warning" title="g_tls_password_get_warning ()">g_tls_password_get_warning</a> <span class="c_punctuation">()</span>
132
132
<tbody>
133
133
<tr>
134
134
<td class="property_type">
135
 
<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
 
135
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
136
136
<td class="property_name"><a class="link" href="GTlsPassword.html#GTlsPassword--description" title="The “description” property">description</a></td>
137
137
<td class="property_flags">Read / Write</td>
138
138
</tr>
143
143
</tr>
144
144
<tr>
145
145
<td class="property_type">
146
 
<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
 
146
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
147
147
<td class="property_name"><a class="link" href="GTlsPassword.html#GTlsPassword--warning" title="The “warning” property">warning</a></td>
148
148
<td class="property_flags">Read / Write</td>
149
149
</tr>
175
175
</div>
176
176
<div class="refsect1">
177
177
<a name="GTlsPassword.object-hierarchy"></a><h2>Object Hierarchy</h2>
178
 
<pre class="screen">    <a href="/home/desrt/.cache/jhbuild/install/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html">GFlags</a>
 
178
<pre class="screen">    <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Enumeration-and-Flag-Types.html">GFlags</a>
179
179
    <span class="lineart">╰──</span> GTlsPasswordFlags
180
 
    <a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
180
    <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
181
181
    <span class="lineart">╰──</span> GTlsPassword
182
182
</pre>
183
183
</div>
196
196
<a name="g-tls-password-new"></a><h3>g_tls_password_new ()</h3>
197
197
<pre class="programlisting"><a class="link" href="GTlsPassword.html" title="GTlsPassword"><span class="returnvalue">GTlsPassword</span></a> *
198
198
g_tls_password_new (<em class="parameter"><code><a class="link" href="GTlsPassword.html#GTlsPasswordFlags" title="enum GTlsPasswordFlags"><span class="type">GTlsPasswordFlags</span></a> flags</code></em>,
199
 
                    <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *description</code></em>);</pre>
 
199
                    <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *description</code></em>);</pre>
200
200
<p>Create a new <a class="link" href="GTlsPassword.html" title="GTlsPassword"><span class="type">GTlsPassword</span></a> object.</p>
201
201
<div class="refsect3">
202
202
<a name="id-1.4.15.11.9.2.5"></a><h4>Parameters</h4>
229
229
<hr>
230
230
<div class="refsect2">
231
231
<a name="g-tls-password-get-value"></a><h3>g_tls_password_get_value ()</h3>
232
 
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#guchar"><span class="returnvalue">guchar</span></a> *
 
232
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guchar"><span class="returnvalue">guchar</span></a> *
233
233
g_tls_password_get_value (<em class="parameter"><code><a class="link" href="GTlsPassword.html" title="GTlsPassword"><span class="type">GTlsPassword</span></a> *password</code></em>,
234
 
                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gsize"><span class="type">gsize</span></a> *length</code></em>);</pre>
 
234
                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gsize"><span class="type">gsize</span></a> *length</code></em>);</pre>
235
235
<p>Get the password value. If <em class="parameter"><code>length</code></em>
236
 
 is not <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> then it will be
 
236
 is not <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> then it will be
237
237
filled in with the length of the password value. (Note that the
238
 
password value is not nul-terminated, so you can only pass <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
238
password value is not nul-terminated, so you can only pass <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
239
239
for <em class="parameter"><code>length</code></em>
240
240
 in contexts where you know the password will have a
241
241
certain fixed length.)</p>
273
273
<a name="g-tls-password-set-value"></a><h3>g_tls_password_set_value ()</h3>
274
274
<pre class="programlisting"><span class="returnvalue">void</span>
275
275
g_tls_password_set_value (<em class="parameter"><code><a class="link" href="GTlsPassword.html" title="GTlsPassword"><span class="type">GTlsPassword</span></a> *password</code></em>,
276
 
                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> *value</code></em>,
277
 
                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gssize"><span class="type">gssize</span></a> length</code></em>);</pre>
 
276
                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> *value</code></em>,
 
277
                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gssize"><span class="type">gssize</span></a> length</code></em>);</pre>
278
278
<p>Set the value for this password. The <em class="parameter"><code>value</code></em>
279
279
 will be copied by the password
280
280
object.</p>
319
319
<a name="g-tls-password-set-value-full"></a><h3>g_tls_password_set_value_full ()</h3>
320
320
<pre class="programlisting"><span class="returnvalue">void</span>
321
321
g_tls_password_set_value_full (<em class="parameter"><code><a class="link" href="GTlsPassword.html" title="GTlsPassword"><span class="type">GTlsPassword</span></a> *password</code></em>,
322
 
                               <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> *value</code></em>,
323
 
                               <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gssize"><span class="type">gssize</span></a> length</code></em>,
324
 
                               <em class="parameter"><code><a href="../glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy</code></em>);</pre>
 
322
                               <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> *value</code></em>,
 
323
                               <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gssize"><span class="type">gssize</span></a> length</code></em>,
 
324
                               <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy</code></em>);</pre>
325
325
<p>Provide the value for this password.</p>
326
326
<p>The <em class="parameter"><code>value</code></em>
327
327
 will be owned by the password object, and later freed using
372
372
<hr>
373
373
<div class="refsect2">
374
374
<a name="g-tls-password-get-description"></a><h3>g_tls_password_get_description ()</h3>
375
 
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 
375
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
376
376
g_tls_password_get_description (<em class="parameter"><code><a class="link" href="GTlsPassword.html" title="GTlsPassword"><span class="type">GTlsPassword</span></a> *password</code></em>);</pre>
377
377
<p>Get a description string about what the password will be used for.</p>
378
378
<div class="refsect3">
402
402
<a name="g-tls-password-set-description"></a><h3>g_tls_password_set_description ()</h3>
403
403
<pre class="programlisting"><span class="returnvalue">void</span>
404
404
g_tls_password_set_description (<em class="parameter"><code><a class="link" href="GTlsPassword.html" title="GTlsPassword"><span class="type">GTlsPassword</span></a> *password</code></em>,
405
 
                                <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *description</code></em>);</pre>
 
405
                                <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *description</code></em>);</pre>
406
406
<p>Set a description string about what the password will be used for.</p>
407
407
<div class="refsect3">
408
408
<a name="id-1.4.15.11.9.7.5"></a><h4>Parameters</h4>
490
490
<hr>
491
491
<div class="refsect2">
492
492
<a name="g-tls-password-get-warning"></a><h3>g_tls_password_get_warning ()</h3>
493
 
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 
493
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
494
494
g_tls_password_get_warning (<em class="parameter"><code><a class="link" href="GTlsPassword.html" title="GTlsPassword"><span class="type">GTlsPassword</span></a> *password</code></em>);</pre>
495
495
<p>Get a user readable translated warning. Usually this warning is a
496
496
representation of the password flags returned from
522
522
<a name="g-tls-password-set-warning"></a><h3>g_tls_password_set_warning ()</h3>
523
523
<pre class="programlisting"><span class="returnvalue">void</span>
524
524
g_tls_password_set_warning (<em class="parameter"><code><a class="link" href="GTlsPassword.html" title="GTlsPassword"><span class="type">GTlsPassword</span></a> *password</code></em>,
525
 
                            <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *warning</code></em>);</pre>
 
525
                            <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *warning</code></em>);</pre>
526
526
<p>Set a user readable translated warning. Usually this warning is a
527
527
representation of the password flags returned from
528
528
<a class="link" href="GTlsPassword.html#g-tls-password-get-flags" title="g_tls_password_get_flags ()"><code class="function">g_tls_password_get_flags()</code></a>.</p>
633
633
<a name="GTlsPassword.property-details"></a><h2>Property Details</h2>
634
634
<div class="refsect2">
635
635
<a name="GTlsPassword--description"></a><h3>The <code class="literal">“description”</code> property</h3>
636
 
<pre class="programlisting">  “description”              <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
 
636
<pre class="programlisting">  “description”              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
637
637
<p>Description of what the password is for.</p>
638
638
<p>Flags: Read / Write</p>
639
639
<p>Default value: NULL</p>
648
648
<hr>
649
649
<div class="refsect2">
650
650
<a name="GTlsPassword--warning"></a><h3>The <code class="literal">“warning”</code> property</h3>
651
 
<pre class="programlisting">  “warning”                  <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
 
651
<pre class="programlisting">  “warning”                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
652
652
<p>Warning about the password.</p>
653
653
<p>Flags: Read / Write</p>
654
654
<p>Default value: NULL</p>