docs/reference/gio/html/GTlsPassword.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>GTlsPassword</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GIO Reference Manual">
   8 <link rel="up" href="tls.html" title="TLS (SSL) support">
   9 <link rel="prev" href="GTlsInteraction.html" title="GTlsInteraction">
  10 <link rel="next" href="resolver.html" title="DNS resolution">
  11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="GTlsInteraction.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="tls.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">GIO Reference Manual</th>
  21 <td><a accesskey="n" href="resolver.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#GTlsPassword.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#GTlsPassword.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#GTlsPassword.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#GTlsPassword.properties" class="shortcut">Properties</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="GTlsPassword"></a><div class="titlepage"></div>
  35 <div class="refnamediv"><table width="100%"><tr>
  36 <td valign="top">
  37 <h2><span class="refentrytitle"><a name="GTlsPassword.top_of_page"></a>GTlsPassword</span></h2>
  38 <p>GTlsPassword — TLS Passwords for prompting</p>
  39 </td>
  40 <td valign="top" align="right"></td>
  41 </tr></table></div>
  42 <div class="refsynopsisdiv">
  43 <a name="GTlsPassword.synopsis"></a><h2>Synopsis</h2>
  44 <pre class="synopsis">
  45 #include &lt;gio/gio.h&gt;
  46
  47                     <a class="link" href="GTlsPassword.html#GTlsPassword-struct" title="GTlsPassword">GTlsPassword</a>;
  48 struct              <a class="link" href="GTlsPassword.html#GTlsPasswordClass" title="struct GTlsPasswordClass">GTlsPasswordClass</a>;
  49 enum                <a class="link" href="GTlsPassword.html#GTlsPasswordFlags" title="enum GTlsPasswordFlags">GTlsPasswordFlags</a>;
  50 <a class="link" href="GTlsPassword.html" title="GTlsPassword"><span class="returnvalue">GTlsPassword</span></a> *      <a class="link" href="GTlsPassword.html#g-tls-password-new" title="g_tls_password_new ()">g_tls_password_new</a>                  (<em class="parameter"><code><a class="link" href="GTlsPassword.html#GTlsPasswordFlags" title="enum GTlsPasswordFlags"><span class="type">GTlsPasswordFlags</span></a> flags</code></em>,
  51                                                          <em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *description</code></em>);
  52 const <a href="./../glib/glib/glib-Basic-Types.html#guchar"><span class="returnvalue">guchar</span></a> *      <a class="link" href="GTlsPassword.html#g-tls-password-get-value" title="g_tls_password_get_value ()">g_tls_password_get_value</a>            (<em class="parameter"><code><a class="link" href="GTlsPassword.html" title="GTlsPassword"><span class="type">GTlsPassword</span></a> *password</code></em>,
  53                                                          <em class="parameter"><code><a href="./../glib/glib/glib-Basic-Types.html#gsize"><span class="type">gsize</span></a> *length</code></em>);
  54 <span class="returnvalue">void</span>                <a class="link" href="GTlsPassword.html#g-tls-password-set-value" title="g_tls_password_set_value ()">g_tls_password_set_value</a>            (<em class="parameter"><code><a class="link" href="GTlsPassword.html" title="GTlsPassword"><span class="type">GTlsPassword</span></a> *password</code></em>,
  55                                                          <em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> *value</code></em>,
  56                                                          <em class="parameter"><code><a href="./../glib/glib/glib-Basic-Types.html#gssize"><span class="type">gssize</span></a> length</code></em>);
  57 <span class="returnvalue">void</span>                <a class="link" href="GTlsPassword.html#g-tls-password-set-value-full" title="g_tls_password_set_value_full ()">g_tls_password_set_value_full</a>       (<em class="parameter"><code><a class="link" href="GTlsPassword.html" title="GTlsPassword"><span class="type">GTlsPassword</span></a> *password</code></em>,
  58                                                          <em class="parameter"><code><a href="./../glib/glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> *value</code></em>,
  59                                                          <em class="parameter"><code><a href="./../glib/glib/glib-Basic-Types.html#gssize"><span class="type">gssize</span></a> length</code></em>,
  60                                                          <em class="parameter"><code><a href="./../glib/glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy</code></em>);
  61 const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="GTlsPassword.html#g-tls-password-get-description" title="g_tls_password_get_description ()">g_tls_password_get_description</a>      (<em class="parameter"><code><a class="link" href="GTlsPassword.html" title="GTlsPassword"><span class="type">GTlsPassword</span></a> *password</code></em>);
  62 <span class="returnvalue">void</span>                <a class="link" href="GTlsPassword.html#g-tls-password-set-description" title="g_tls_password_set_description ()">g_tls_password_set_description</a>      (<em class="parameter"><code><a class="link" href="GTlsPassword.html" title="GTlsPassword"><span class="type">GTlsPassword</span></a> *password</code></em>,
  63                                                          <em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *description</code></em>);
  64 <a class="link" href="GTlsPassword.html#GTlsPasswordFlags" title="enum GTlsPasswordFlags"><span class="returnvalue">GTlsPasswordFlags</span></a>   <a class="link" href="GTlsPassword.html#g-tls-password-get-flags" title="g_tls_password_get_flags ()">g_tls_password_get_flags</a>            (<em class="parameter"><code><a class="link" href="GTlsPassword.html" title="GTlsPassword"><span class="type">GTlsPassword</span></a> *password</code></em>);
  65 <span class="returnvalue">void</span>                <a class="link" href="GTlsPassword.html#g-tls-password-set-flags" title="g_tls_password_set_flags ()">g_tls_password_set_flags</a>            (<em class="parameter"><code><a class="link" href="GTlsPassword.html" title="GTlsPassword"><span class="type">GTlsPassword</span></a> *password</code></em>,
  66                                                          <em class="parameter"><code><a class="link" href="GTlsPassword.html#GTlsPasswordFlags" title="enum GTlsPasswordFlags"><span class="type">GTlsPasswordFlags</span></a> flags</code></em>);
  67 const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="GTlsPassword.html#g-tls-password-get-warning" title="g_tls_password_get_warning ()">g_tls_password_get_warning</a>          (<em class="parameter"><code><a class="link" href="GTlsPassword.html" title="GTlsPassword"><span class="type">GTlsPassword</span></a> *password</code></em>);
  68 <span class="returnvalue">void</span>                <a class="link" href="GTlsPassword.html#g-tls-password-set-warning" title="g_tls_password_set_warning ()">g_tls_password_set_warning</a>          (<em class="parameter"><code><a class="link" href="GTlsPassword.html" title="GTlsPassword"><span class="type">GTlsPassword</span></a> *password</code></em>,
  69                                                          <em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *warning</code></em>);
  70 </pre>
  71 </div>
  72 <div class="refsect1">
  73 <a name="GTlsPassword.object-hierarchy"></a><h2>Object Hierarchy</h2>
  74 <pre class="synopsis">
  75   <a href="./../gobject/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  76    +----GTlsPassword
  77 </pre>
  78 </div>
  79 <div class="refsect1">
  80 <a name="GTlsPassword.properties"></a><h2>Properties</h2>
  81 <pre class="synopsis">
  82   "<a class="link" href="GTlsPassword.html#GTlsPassword--description" title='The "description" property'>description</a>"              <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
  83   "<a class="link" href="GTlsPassword.html#GTlsPassword--flags" title='The "flags" property'>flags</a>"                    <a class="link" href="GTlsPassword.html#GTlsPasswordFlags" title="enum GTlsPasswordFlags"><span class="type">GTlsPasswordFlags</span></a>     : Read / Write
  84   "<a class="link" href="GTlsPassword.html#GTlsPassword--warning" title='The "warning" property'>warning</a>"                  <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
  85 </pre>
  86 </div>
  87 <div class="refsect1">
  88 <a name="GTlsPassword.description"></a><h2>Description</h2>
  89 <p>
  90 Holds a password used in TLS.
  91 </p>
  92 </div>
  93 <div class="refsect1">
  94 <a name="GTlsPassword.details"></a><h2>Details</h2>
  95 <div class="refsect2">
  96 <a name="GTlsPassword-struct"></a><h3>GTlsPassword</h3>
  97 <pre class="programlisting">typedef struct _GTlsPassword GTlsPassword;</pre>
  98 <p>
  99 An abstract interface representing a password used in TLS. Often used in
 100 user interaction such as unlocking a key storage token.
 101 </p>
 102 <p class="since">Since 2.30</p>
 103 </div>
 104 <hr>
 105 <div class="refsect2">
 106 <a name="GTlsPasswordClass"></a><h3>struct GTlsPasswordClass</h3>
 107 <pre class="programlisting">struct GTlsPasswordClass {
 108   GObjectClass parent_class;
 109
 110   /* methods */
 111
 112   const guchar *    ( *get_value)            (GTlsPassword  *password,
 113                                               gsize         *length);
 114
 115   void              ( *set_value)            (GTlsPassword  *password,
 116                                               guchar        *value,
 117                                               gssize         length,
 118                                               GDestroyNotify destroy);
 119
 120   const gchar*      ( *get_default_warning)  (GTlsPassword  *password);
 121 };
 122 </pre>
 123 </div>
 124 <hr>
 125 <div class="refsect2">
 126 <a name="GTlsPasswordFlags"></a><h3>enum GTlsPasswordFlags</h3>
 127 <pre class="programlisting">typedef enum {
 128   G_TLS_PASSWORD_NONE = 0,
 129   G_TLS_PASSWORD_RETRY = 1 &lt;&lt; 1,
 130   G_TLS_PASSWORD_MANY_TRIES = 1 &lt;&lt; 2,
 131   G_TLS_PASSWORD_FINAL_TRY = 1 &lt;&lt; 3
 132 } GTlsPasswordFlags;
 133 </pre>
 134 <p>
 135 Various flags for the password.
 136 </p>
 137 <div class="variablelist"><table border="0">
 138 <col align="left" valign="top">
 139 <tbody>
 140 <tr>
 141 <td><p><a name="G-TLS-PASSWORD-NONE:CAPS"></a><span class="term"><code class="literal">G_TLS_PASSWORD_NONE</code></span></p></td>
 142 <td>No flags
 143 </td>
 144 </tr>
 145 <tr>
 146 <td><p><a name="G-TLS-PASSWORD-RETRY:CAPS"></a><span class="term"><code class="literal">G_TLS_PASSWORD_RETRY</code></span></p></td>
 147 <td>The password was wrong, and the user should retry.
 148 </td>
 149 </tr>
 150 <tr>
 151 <td><p><a name="G-TLS-PASSWORD-MANY-TRIES:CAPS"></a><span class="term"><code class="literal">G_TLS_PASSWORD_MANY_TRIES</code></span></p></td>
 152 <td>Hint to the user that the password has been
 153    wrong many times, and the user may not have many chances left.
 154 </td>
 155 </tr>
 156 <tr>
 157 <td><p><a name="G-TLS-PASSWORD-FINAL-TRY:CAPS"></a><span class="term"><code class="literal">G_TLS_PASSWORD_FINAL_TRY</code></span></p></td>
 158 <td>Hint to the user that this is the last try to get
 159    this password right.
 160 </td>
 161 </tr>
 162 </tbody>
 163 </table></div>
 164 <p class="since">Since 2.30</p>
 165 </div>
 166 <hr>
 167 <div class="refsect2">
 168 <a name="g-tls-password-new"></a><h3>g_tls_password_new ()</h3>
 169 <pre class="programlisting"><a class="link" href="GTlsPassword.html" title="GTlsPassword"><span class="returnvalue">GTlsPassword</span></a> *      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>,
 170                                                          <em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *description</code></em>);</pre>
 171 <p>
 172 Create a new <a class="link" href="GTlsPassword.html" title="GTlsPassword"><span class="type">GTlsPassword</span></a> object.
 173 </p>
 174 <div class="variablelist"><table border="0">
 175 <col align="left" valign="top">
 176 <tbody>
 177 <tr>
 178 <td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
 179 <td>the password flags</td>
 180 </tr>
 181 <tr>
 182 <td><p><span class="term"><em class="parameter"><code>description</code></em> :</span></p></td>
 183 <td>description of what the password is for</td>
 184 </tr>
 185 <tr>
 186 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 187 <td>The newly allocated password object. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 188 </td>
 189 </tr>
 190 </tbody>
 191 </table></div>
 192 </div>
 193 <hr>
 194 <div class="refsect2">
 195 <a name="g-tls-password-get-value"></a><h3>g_tls_password_get_value ()</h3>
 196 <pre class="programlisting">const <a href="./../glib/glib/glib-Basic-Types.html#guchar"><span class="returnvalue">guchar</span></a> *      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>,
 197                                                          <em class="parameter"><code><a href="./../glib/glib/glib-Basic-Types.html#gsize"><span class="type">gsize</span></a> *length</code></em>);</pre>
 198 <p>
 199 Get the password value. If <em class="parameter"><code>length</code></em> is not <a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> then it will be
 200 filled in with the length of the password value. (Note that the
 201 password value is not nul-terminated, so you can only pass <a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 202 for <em class="parameter"><code>length</code></em> in contexts where you know the password will have a
 203 certain fixed length.)
 204 </p>
 205 <div class="variablelist"><table border="0">
 206 <col align="left" valign="top">
 207 <tbody>
 208 <tr>
 209 <td><p><span class="term"><em class="parameter"><code>password</code></em> :</span></p></td>
 210 <td>a <a class="link" href="GTlsPassword.html" title="GTlsPassword"><span class="type">GTlsPassword</span></a> object</td>
 211 </tr>
 212 <tr>
 213 <td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
 214 <td>location to place the length of the password. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 215 </td>
 216 </tr>
 217 <tr>
 218 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 219 <td>The password value (owned by the password object).</td>
 220 </tr>
 221 </tbody>
 222 </table></div>
 223 <p class="since">Since 2.30</p>
 224 </div>
 225 <hr>
 226 <div class="refsect2">
 227 <a name="g-tls-password-set-value"></a><h3>g_tls_password_set_value ()</h3>
 228 <pre class="programlisting"><span class="returnvalue">void</span>                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>,
 229                                                          <em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> *value</code></em>,
 230                                                          <em class="parameter"><code><a href="./../glib/glib/glib-Basic-Types.html#gssize"><span class="type">gssize</span></a> length</code></em>);</pre>
 231 <p>
 232 Set the value for this password. The <em class="parameter"><code>value</code></em> will be copied by the password
 233 object.
 234 </p>
 235 <p>
 236 Specify the <em class="parameter"><code>length</code></em>, for a non-nul-terminated password. Pass -1 as
 237 <em class="parameter"><code>length</code></em> if using a nul-terminated password, and <em class="parameter"><code>length</code></em> will be
 238 calculated automatically. (Note that the terminating nul is not
 239 considered part of the password in this case.)
 240 </p>
 241 <div class="variablelist"><table border="0">
 242 <col align="left" valign="top">
 243 <tbody>
 244 <tr>
 245 <td><p><span class="term"><em class="parameter"><code>password</code></em> :</span></p></td>
 246 <td>a <a class="link" href="GTlsPassword.html" title="GTlsPassword"><span class="type">GTlsPassword</span></a> object</td>
 247 </tr>
 248 <tr>
 249 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 250 <td>the new password value</td>
 251 </tr>
 252 <tr>
 253 <td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
 254 <td>the length of the password, or -1</td>
 255 </tr>
 256 </tbody>
 257 </table></div>
 258 <p class="since">Since 2.30</p>
 259 </div>
 260 <hr>
 261 <div class="refsect2">
 262 <a name="g-tls-password-set-value-full"></a><h3>g_tls_password_set_value_full ()</h3>
 263 <pre class="programlisting"><span class="returnvalue">void</span>                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>,
 264                                                          <em class="parameter"><code><a href="./../glib/glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> *value</code></em>,
 265                                                          <em class="parameter"><code><a href="./../glib/glib/glib-Basic-Types.html#gssize"><span class="type">gssize</span></a> length</code></em>,
 266                                                          <em class="parameter"><code><a href="./../glib/glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy</code></em>);</pre>
 267 <p>
 268 Provide the value for this password.
 269 </p>
 270 <p>
 271 The <em class="parameter"><code>value</code></em> will be owned by the password object, and later freed using
 272 the <em class="parameter"><code>destroy</code></em> function callback.
 273 </p>
 274 <p>
 275 Specify the <em class="parameter"><code>length</code></em>, for a non-nul-terminated password. Pass -1 as
 276 <em class="parameter"><code>length</code></em> if using a nul-terminated password, and <em class="parameter"><code>length</code></em> will be
 277 calculated automatically. (Note that the terminating nul is not
 278 considered part of the password in this case.)
 279 </p>
 280 <p>
 281 Virtual: set_value
 282 </p>
 283 <div class="variablelist"><table border="0">
 284 <col align="left" valign="top">
 285 <tbody>
 286 <tr>
 287 <td><p><span class="term"><em class="parameter"><code>password</code></em> :</span></p></td>
 288 <td>a <a class="link" href="GTlsPassword.html" title="GTlsPassword"><span class="type">GTlsPassword</span></a> object</td>
 289 </tr>
 290 <tr>
 291 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 292 <td>the value for the password</td>
 293 </tr>
 294 <tr>
 295 <td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
 296 <td>the length of the password, or -1</td>
 297 </tr>
 298 <tr>
 299 <td><p><span class="term"><em class="parameter"><code>destroy</code></em> :</span></p></td>
 300 <td>a function to use to free the password. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 301 </td>
 302 </tr>
 303 </tbody>
 304 </table></div>
 305 <p class="since">Since 2.30</p>
 306 </div>
 307 <hr>
 308 <div class="refsect2">
 309 <a name="g-tls-password-get-description"></a><h3>g_tls_password_get_description ()</h3>
 310 <pre class="programlisting">const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       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>
 311 <p>
 312 Get a description string about what the password will be used for.
 313 </p>
 314 <div class="variablelist"><table border="0">
 315 <col align="left" valign="top">
 316 <tbody>
 317 <tr>
 318 <td><p><span class="term"><em class="parameter"><code>password</code></em> :</span></p></td>
 319 <td>a <a class="link" href="GTlsPassword.html" title="GTlsPassword"><span class="type">GTlsPassword</span></a> object</td>
 320 </tr>
 321 <tr>
 322 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 323 <td>The description of the password.</td>
 324 </tr>
 325 </tbody>
 326 </table></div>
 327 <p class="since">Since 2.30</p>
 328 </div>
 329 <hr>
 330 <div class="refsect2">
 331 <a name="g-tls-password-set-description"></a><h3>g_tls_password_set_description ()</h3>
 332 <pre class="programlisting"><span class="returnvalue">void</span>                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>,
 333                                                          <em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *description</code></em>);</pre>
 334 <p>
 335 Set a description string about what the password will be used for.
 336 </p>
 337 <div class="variablelist"><table border="0">
 338 <col align="left" valign="top">
 339 <tbody>
 340 <tr>
 341 <td><p><span class="term"><em class="parameter"><code>password</code></em> :</span></p></td>
 342 <td>a <a class="link" href="GTlsPassword.html" title="GTlsPassword"><span class="type">GTlsPassword</span></a> object</td>
 343 </tr>
 344 <tr>
 345 <td><p><span class="term"><em class="parameter"><code>description</code></em> :</span></p></td>
 346 <td>The description of the password</td>
 347 </tr>
 348 </tbody>
 349 </table></div>
 350 <p class="since">Since 2.30</p>
 351 </div>
 352 <hr>
 353 <div class="refsect2">
 354 <a name="g-tls-password-get-flags"></a><h3>g_tls_password_get_flags ()</h3>
 355 <pre class="programlisting"><a class="link" href="GTlsPassword.html#GTlsPasswordFlags" title="enum GTlsPasswordFlags"><span class="returnvalue">GTlsPasswordFlags</span></a>   g_tls_password_get_flags            (<em class="parameter"><code><a class="link" href="GTlsPassword.html" title="GTlsPassword"><span class="type">GTlsPassword</span></a> *password</code></em>);</pre>
 356 <p>
 357 Get flags about the password.
 358 </p>
 359 <div class="variablelist"><table border="0">
 360 <col align="left" valign="top">
 361 <tbody>
 362 <tr>
 363 <td><p><span class="term"><em class="parameter"><code>password</code></em> :</span></p></td>
 364 <td>a <a class="link" href="GTlsPassword.html" title="GTlsPassword"><span class="type">GTlsPassword</span></a> object</td>
 365 </tr>
 366 <tr>
 367 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 368 <td>The flags about the password.</td>
 369 </tr>
 370 </tbody>
 371 </table></div>
 372 <p class="since">Since 2.30</p>
 373 </div>
 374 <hr>
 375 <div class="refsect2">
 376 <a name="g-tls-password-set-flags"></a><h3>g_tls_password_set_flags ()</h3>
 377 <pre class="programlisting"><span class="returnvalue">void</span>                g_tls_password_set_flags            (<em class="parameter"><code><a class="link" href="GTlsPassword.html" title="GTlsPassword"><span class="type">GTlsPassword</span></a> *password</code></em>,
 378                                                          <em class="parameter"><code><a class="link" href="GTlsPassword.html#GTlsPasswordFlags" title="enum GTlsPasswordFlags"><span class="type">GTlsPasswordFlags</span></a> flags</code></em>);</pre>
 379 <p>
 380 Set flags about the password.
 381 </p>
 382 <div class="variablelist"><table border="0">
 383 <col align="left" valign="top">
 384 <tbody>
 385 <tr>
 386 <td><p><span class="term"><em class="parameter"><code>password</code></em> :</span></p></td>
 387 <td>a <a class="link" href="GTlsPassword.html" title="GTlsPassword"><span class="type">GTlsPassword</span></a> object</td>
 388 </tr>
 389 <tr>
 390 <td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
 391 <td>The flags about the password</td>
 392 </tr>
 393 </tbody>
 394 </table></div>
 395 <p class="since">Since 2.30</p>
 396 </div>
 397 <hr>
 398 <div class="refsect2">
 399 <a name="g-tls-password-get-warning"></a><h3>g_tls_password_get_warning ()</h3>
 400 <pre class="programlisting">const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       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>
 401 <p>
 402 Get a user readable translated warning. Usually this warning is a
 403 representation of the password flags returned from
 404 <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>.
 405 </p>
 406 <div class="variablelist"><table border="0">
 407 <col align="left" valign="top">
 408 <tbody>
 409 <tr>
 410 <td><p><span class="term"><em class="parameter"><code>password</code></em> :</span></p></td>
 411 <td>a <a class="link" href="GTlsPassword.html" title="GTlsPassword"><span class="type">GTlsPassword</span></a> object</td>
 412 </tr>
 413 <tr>
 414 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 415 <td>The warning.</td>
 416 </tr>
 417 </tbody>
 418 </table></div>
 419 <p class="since">Since 2.30</p>
 420 </div>
 421 <hr>
 422 <div class="refsect2">
 423 <a name="g-tls-password-set-warning"></a><h3>g_tls_password_set_warning ()</h3>
 424 <pre class="programlisting"><span class="returnvalue">void</span>                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>,
 425                                                          <em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *warning</code></em>);</pre>
 426 <p>
 427 Set a user readable translated warning. Usually this warning is a
 428 representation of the password flags returned from
 429 <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>.
 430 </p>
 431 <div class="variablelist"><table border="0">
 432 <col align="left" valign="top">
 433 <tbody>
 434 <tr>
 435 <td><p><span class="term"><em class="parameter"><code>password</code></em> :</span></p></td>
 436 <td>a <a class="link" href="GTlsPassword.html" title="GTlsPassword"><span class="type">GTlsPassword</span></a> object</td>
 437 </tr>
 438 <tr>
 439 <td><p><span class="term"><em class="parameter"><code>warning</code></em> :</span></p></td>
 440 <td>The user readable warning</td>
 441 </tr>
 442 </tbody>
 443 </table></div>
 444 <p class="since">Since 2.30</p>
 445 </div>
 446 </div>
 447 <div class="refsect1">
 448 <a name="GTlsPassword.property-details"></a><h2>Property Details</h2>
 449 <div class="refsect2">
 450 <a name="GTlsPassword--description"></a><h3>The <code class="literal">"description"</code> property</h3>
 451 <pre class="programlisting">  "description"              <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
 452 <p>Description of what the password is for.</p>
 453 <p>Default value: ""</p>
 454 </div>
 455 <hr>
 456 <div class="refsect2">
 457 <a name="GTlsPassword--flags"></a><h3>The <code class="literal">"flags"</code> property</h3>
 458 <pre class="programlisting">  "flags"                    <a class="link" href="GTlsPassword.html#GTlsPasswordFlags" title="enum GTlsPasswordFlags"><span class="type">GTlsPasswordFlags</span></a>     : Read / Write</pre>
 459 <p>Flags about the password.</p>
 460 </div>
 461 <hr>
 462 <div class="refsect2">
 463 <a name="GTlsPassword--warning"></a><h3>The <code class="literal">"warning"</code> property</h3>
 464 <pre class="programlisting">  "warning"                  <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
 465 <p>Warning about the password.</p>
 466 <p>Default value: ""</p>
 467 </div>
 468 </div>
 469 </div>
 470 <div class="footer">
 471 <hr>
 472           Generated by GTK-Doc V1.18</div>
 473 </body>
 474 </html>