/usr/share/gtk-doc/html/libsecret-1/SecretValue.html is in libsecret-1-dev 0.18.6-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SecretValue: Libsecret Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="Libsecret Library Reference Manual">
<link rel="up" href="complete.html" title="Part III. Complete API">
<link rel="prev" href="SecretItem.html" title="SecretItem">
<link rel="next" href="libsecret-Secret-Attributes.html" title="Secret Attributes">
<meta name="generator" content="GTK-Doc V1.27.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#SecretValue.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#SecretValue.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="complete.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="SecretItem.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libsecret-Secret-Attributes.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="SecretValue"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="SecretValue.top_of_page"></a>SecretValue</span></h2>
<p>SecretValue — a value containing a secret</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="SecretValue.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="SecretValue.html" title="SecretValue"><span class="returnvalue">SecretValue</span></a> *
</td>
<td class="function_name">
<a class="link" href="SecretValue.html#secret-value-new" title="secret_value_new ()">secret_value_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="SecretValue.html" title="SecretValue"><span class="returnvalue">SecretValue</span></a> *
</td>
<td class="function_name">
<a class="link" href="SecretValue.html#secret-value-new-full" title="secret_value_new_full ()">secret_value_new_full</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="SecretValue.html#secret-value-get" title="secret_value_get ()">secret_value_get</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="SecretValue.html#secret-value-get-text" title="secret_value_get_text ()">secret_value_get_text</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="SecretValue.html#secret-value-get-content-type" title="secret_value_get_content_type ()">secret_value_get_content_type</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="SecretValue.html" title="SecretValue"><span class="returnvalue">SecretValue</span></a> *
</td>
<td class="function_name">
<a class="link" href="SecretValue.html#secret-value-ref" title="secret_value_ref ()">secret_value_ref</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="SecretValue.html#secret-value-unref" title="secret_value_unref ()">secret_value_unref</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="SecretValue.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="SecretValue.html#SecretValue-struct" title="SecretValue">SecretValue</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="SecretValue.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/home/dueno/jhbuild/install/share/gtk-doc/html/gobject/gobject-Boxed-Types.html">GBoxed</a>
<span class="lineart">╰──</span> SecretValue
</pre>
</div>
<div class="refsect1">
<a name="SecretValue.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libsecret/secret.h>
</pre>
</div>
<div class="refsect1">
<a name="SecretValue.description"></a><h2>Description</h2>
<p>A <a class="link" href="SecretValue.html" title="SecretValue"><span class="type">SecretValue</span></a> contains a password or other secret value.</p>
<p>Use <a class="link" href="SecretValue.html#secret-value-get" title="secret_value_get ()"><code class="function">secret_value_get()</code></a> to get the actual secret data, such as a password.
The secret data is not necessarily null-terminated, unless the content type
is "text/plain".</p>
<p>Each <a class="link" href="SecretValue.html" title="SecretValue"><span class="type">SecretValue</span></a> has a content type. For passwords, this is "text/plain".
Use <a class="link" href="SecretValue.html#secret-value-get-content-type" title="secret_value_get_content_type ()"><code class="function">secret_value_get_content_type()</code></a> to look at the content type.</p>
<p><a class="link" href="SecretValue.html" title="SecretValue"><span class="type">SecretValue</span></a> is reference counted and immutable. The secret data is only
freed when all references have been released via <a class="link" href="SecretValue.html#secret-value-unref" title="secret_value_unref ()"><code class="function">secret_value_unref()</code></a>.</p>
</div>
<div class="refsect1">
<a name="SecretValue.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="secret-value-new"></a><h3>secret_value_new ()</h3>
<pre class="programlisting"><a class="link" href="SecretValue.html" title="SecretValue"><span class="returnvalue">SecretValue</span></a> *
secret_value_new (<em class="parameter"><code>const <span class="type">gchar</span> *secret</code></em>,
<em class="parameter"><code><span class="type">gssize</span> length</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *content_type</code></em>);</pre>
<p>Create a <a class="link" href="SecretValue.html" title="SecretValue"><span class="type">SecretValue</span></a> for the secret data passed in. The secret data is
copied into non-pageable 'secure' memory.</p>
<p>If the length is less than zero, then <em class="parameter"><code>secret</code></em>
is assumed to be
null-terminated.</p>
<div class="refsect3">
<a name="secret-value-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>secret</p></td>
<td class="parameter_description"><p>the secret data</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>length</p></td>
<td class="parameter_description"><p>the length of the data</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>content_type</p></td>
<td class="parameter_description"><p>the content type of the data</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="secret-value-new.returns"></a><h4>Returns</h4>
<p>the new <a class="link" href="SecretValue.html" title="SecretValue"><span class="type">SecretValue</span></a>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="secret-value-new-full"></a><h3>secret_value_new_full ()</h3>
<pre class="programlisting"><a class="link" href="SecretValue.html" title="SecretValue"><span class="returnvalue">SecretValue</span></a> *
secret_value_new_full (<em class="parameter"><code><span class="type">gchar</span> *secret</code></em>,
<em class="parameter"><code><span class="type">gssize</span> length</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *content_type</code></em>,
<em class="parameter"><code><span class="type">GDestroyNotify</span> destroy</code></em>);</pre>
<p>Create a <a class="link" href="SecretValue.html" title="SecretValue"><span class="type">SecretValue</span></a> for the secret data passed in. The secret data is
not copied, and will later be freed with the <em class="parameter"><code>destroy</code></em>
function.</p>
<p>If the length is less than zero, then <em class="parameter"><code>secret</code></em>
is assumed to be
null-terminated.</p>
<div class="refsect3">
<a name="secret-value-new-full.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>secret</p></td>
<td class="parameter_description"><p>the secret data</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>length</p></td>
<td class="parameter_description"><p>the length of the data</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>content_type</p></td>
<td class="parameter_description"><p>the content type of the data</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>destroy</p></td>
<td class="parameter_description"><p>function to call to free the secret data</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="secret-value-new-full.returns"></a><h4>Returns</h4>
<p>the new <a class="link" href="SecretValue.html" title="SecretValue"><span class="type">SecretValue</span></a>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="secret-value-get"></a><h3>secret_value_get ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
secret_value_get (<em class="parameter"><code><a class="link" href="SecretValue.html" title="SecretValue"><span class="type">SecretValue</span></a> *value</code></em>,
<em class="parameter"><code><span class="type">gsize</span> *length</code></em>);</pre>
<p>Get the secret data in the <a class="link" href="SecretValue.html" title="SecretValue"><span class="type">SecretValue</span></a>. The value is not necessarily
null-terminated unless it was created with <a class="link" href="SecretValue.html#secret-value-new" title="secret_value_new ()"><code class="function">secret_value_new()</code></a> or a
null-terminated string was passed to <a class="link" href="SecretValue.html#secret-value-new-full" title="secret_value_new_full ()"><code class="function">secret_value_new_full()</code></a>.</p>
<div class="refsect3">
<a name="secret-value-get.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p>the value</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>length</p></td>
<td class="parameter_description"><p>the length of the secret</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="secret-value-get.returns"></a><h4>Returns</h4>
<p>the secret data. </p>
<p><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=length][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> guint8]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="secret-value-get-text"></a><h3>secret_value_get_text ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
secret_value_get_text (<em class="parameter"><code><a class="link" href="SecretValue.html" title="SecretValue"><span class="type">SecretValue</span></a> *value</code></em>);</pre>
<p>Get the secret data in the <a class="link" href="SecretValue.html" title="SecretValue"><span class="type">SecretValue</span></a> if it contains a textual
value. The content type must be <code class="literal">text/plain</code>.</p>
<div class="refsect3">
<a name="secret-value-get-text.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p>the value</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="secret-value-get-text.returns"></a><h4>Returns</h4>
<p>the content type. </p>
<p><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="secret-value-get-content-type"></a><h3>secret_value_get_content_type ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
secret_value_get_content_type (<em class="parameter"><code><a class="link" href="SecretValue.html" title="SecretValue"><span class="type">SecretValue</span></a> *value</code></em>);</pre>
<p>Get the content type of the secret value, such as
<code class="literal">text/plain</code>.</p>
<div class="refsect3">
<a name="secret-value-get-content-type.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p>the value</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="secret-value-get-content-type.returns"></a><h4>Returns</h4>
<p> the content type</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="secret-value-ref"></a><h3>secret_value_ref ()</h3>
<pre class="programlisting"><a class="link" href="SecretValue.html" title="SecretValue"><span class="returnvalue">SecretValue</span></a> *
secret_value_ref (<em class="parameter"><code><a class="link" href="SecretValue.html" title="SecretValue"><span class="type">SecretValue</span></a> *value</code></em>);</pre>
<p>Add another reference to the <a class="link" href="SecretValue.html" title="SecretValue"><span class="type">SecretValue</span></a>. For each reference
<a class="link" href="SecretValue.html#secret-value-unref" title="secret_value_unref ()"><code class="function">secret_value_unref()</code></a> should be called to unreference the value.</p>
<div class="refsect3">
<a name="secret-value-ref.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p>value to reference</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="secret-value-ref.returns"></a><h4>Returns</h4>
<p>the value. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="secret-value-unref"></a><h3>secret_value_unref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
secret_value_unref (<em class="parameter"><code><span class="type">gpointer</span> value</code></em>);</pre>
<p>Unreference a <a class="link" href="SecretValue.html" title="SecretValue"><span class="type">SecretValue</span></a>. When the last reference is gone, then
the value will be freed.</p>
<div class="refsect3">
<a name="secret-value-unref.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p>value to unreference. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> Secret.Value]</span></td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="SecretValue.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="SecretValue-struct"></a><h3>SecretValue</h3>
<pre class="programlisting">typedef struct _SecretValue SecretValue;</pre>
<p>A secret value, like a password or other binary secret.</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27.1</div>
</body>
</html>
|