/usr/share/gtk-doc/html/gnome-keyring/gnome-keyring-Network-Passwords.html is in libgnome-keyring-dev 3.12.0-1+b1.
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 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gnome-keyring Reference Manual: Network Passwords</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="gnome-keyring Reference Manual">
<link rel="up" href="ch01.html" title="gnome-keyring API Reference">
<link rel="prev" href="gnome-keyring-Search-Functionality.html" title="Search Functionality">
<link rel="next" href="gnome-keyring-Non-pageable-Memory.html" title="Non-pageable Memory">
<meta name="generator" content="GTK-Doc V1.21 (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="#gnome-keyring-Network-Passwords.description" class="shortcut">Description</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="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="gnome-keyring-Search-Functionality.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gnome-keyring-Non-pageable-Memory.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gnome-keyring-Network-Passwords"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gnome-keyring-Network-Passwords.top_of_page"></a>Network Passwords</span></h2>
<p>Network Passwords — Saving of network passwords.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="gnome-keyring-Network-Passwords.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="gnome-keyring-Network-Passwords.html#gnome-keyring-network-password-free" title="gnome_keyring_network_password_free ()">gnome_keyring_network_password_free</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="gnome-keyring-Network-Passwords.html#gnome-keyring-network-password-list-free" title="gnome_keyring_network_password_list_free ()">gnome_keyring_network_password_list_free</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a>
</td>
<td class="function_name">
<a class="link" href="gnome-keyring-Network-Passwords.html#gnome-keyring-find-network-password" title="gnome_keyring_find_network_password ()">gnome_keyring_find_network_password</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="gnome-keyring-Result-Codes.html#GnomeKeyringResult" title="enum GnomeKeyringResult"><span class="returnvalue">GnomeKeyringResult</span></a>
</td>
<td class="function_name">
<a class="link" href="gnome-keyring-Network-Passwords.html#gnome-keyring-find-network-password-sync" title="gnome_keyring_find_network_password_sync ()">gnome_keyring_find_network_password_sync</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a>
</td>
<td class="function_name">
<a class="link" href="gnome-keyring-Network-Passwords.html#gnome-keyring-set-network-password" title="gnome_keyring_set_network_password ()">gnome_keyring_set_network_password</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="gnome-keyring-Result-Codes.html#GnomeKeyringResult" title="enum GnomeKeyringResult"><span class="returnvalue">GnomeKeyringResult</span></a>
</td>
<td class="function_name">
<a class="link" href="gnome-keyring-Network-Passwords.html#gnome-keyring-set-network-password-sync" title="gnome_keyring_set_network_password_sync ()">gnome_keyring_set_network_password_sync</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gnome-keyring-Network-Passwords.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table 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="gnome-keyring-Network-Passwords.html#GnomeKeyringNetworkPasswordData" title="GnomeKeyringNetworkPasswordData">GnomeKeyringNetworkPasswordData</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gnome-keyring-Network-Passwords.description"></a><h2>Description</h2>
<div class="warning">All of these APIs are deprecated. Use
<a class="ulink" href="" target="_top">libsecret</a>
instead.</div>
<p>Networks passwords are a simple way of saving passwords associated with a
certain user/server/protocol and other fields.</p>
<p>Attributes are not stored in a secret or encrypted manner by gnome-keyring. Do
not store sensitive information in attributes.</p>
</div>
<div class="refsect1">
<a name="gnome-keyring-Network-Passwords.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gnome-keyring-network-password-free"></a><h3>gnome_keyring_network_password_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gnome_keyring_network_password_free (<em class="parameter"><code><a class="link" href="gnome-keyring-Network-Passwords.html#GnomeKeyringNetworkPasswordData" title="GnomeKeyringNetworkPasswordData"><span class="type">GnomeKeyringNetworkPasswordData</span></a> *data</code></em>);</pre>
<div class="warning">
<p><code class="literal">gnome_keyring_network_password_free</code> is deprecated and should not be used in newly-written code.</p>
<p>Not used with libsecret.</p>
</div>
<p>Free a network password data pointer. If <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> is passed in,
nothing happens.</p>
<div class="refsect3">
<a name="id-1.2.10.6.2.6"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>data</p></td>
<td class="parameter_description"><p> A <a class="link" href="gnome-keyring-Network-Passwords.html#GnomeKeyringNetworkPasswordData" title="GnomeKeyringNetworkPasswordData"><span class="type">GnomeKeyringNetworkPasswordData</span></a> pointer. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-keyring-network-password-list-free"></a><h3>gnome_keyring_network_password_list_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gnome_keyring_network_password_list_free
(<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *list</code></em>);</pre>
<div class="warning">
<p><code class="literal">gnome_keyring_network_password_list_free</code> is deprecated and should not be used in newly-written code.</p>
<p>Not used with libsecret.</p>
</div>
<p>Free a list of network password data.</p>
<div class="refsect3">
<a name="id-1.2.10.6.3.6"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>list</p></td>
<td class="parameter_description"><p> A list of
<a class="link" href="gnome-keyring-Network-Passwords.html#GnomeKeyringNetworkPasswordData" title="GnomeKeyringNetworkPasswordData"><span class="type">GnomeKeyringNetworkPasswordData</span></a> pointers. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GnomeKeyringNetworkPasswordData]</span></td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-keyring-find-network-password"></a><h3>gnome_keyring_find_network_password ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a>
gnome_keyring_find_network_password (<em class="parameter"><code>const <span class="type">char</span> *user</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *domain</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *server</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *object</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *protocol</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *authtype</code></em>,
<em class="parameter"><code><span class="type">guint32</span> port</code></em>,
<em class="parameter"><code><a class="link" href="gnome-keyring-Callbacks.html#GnomeKeyringOperationGetListCallback" title="GnomeKeyringOperationGetListCallback ()"><span class="type">GnomeKeyringOperationGetListCallback</span></a> callback</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy_data</code></em>);</pre>
<div class="warning">
<p><code class="literal">gnome_keyring_find_network_password</code> is deprecated and should not be used in newly-written code.</p>
<p>Use <code class="function">secret_password_lookup()</code> with <code class="literal">SECRET_SCHEMA_COMPAT_NETWORK</code>.</p>
</div>
<p>Find a previously stored network password. Searches all keyrings.</p>
<p>A <a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><code class="literal">GList</code></a> of <a class="link" href="gnome-keyring-Network-Passwords.html#GnomeKeyringNetworkPasswordData" title="GnomeKeyringNetworkPasswordData"><span class="type">GnomeKeyringNetworkPasswordData</span></a> structures are passed to the
<em class="parameter"><code>callback</code></em>
. The list and structures are freed after the callback returns.</p>
<p>The user may have been prompted to unlock necessary keyrings, and user will
have been prompted for access to the items if needed.</p>
<p>Network passwords are items with the item type <a class="link" href="gnome-keyring-Item-Information.html#GNOME-KEYRING-ITEM-NETWORK-PASSWORD:CAPS"><code class="literal">GNOME_KEYRING_ITEM_NETWORK_PASSWORD</code></a></p>
<div class="refsect3">
<a name="id-1.2.10.6.4.9"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>user</p></td>
<td class="parameter_description"><p> The user name or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for any user. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>domain</p></td>
<td class="parameter_description"><p> The domain name or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for any domain. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>server</p></td>
<td class="parameter_description"><p> The server or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for any server. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>object</p></td>
<td class="parameter_description"><p> The remote object or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for any object. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>protocol</p></td>
<td class="parameter_description"><p> The network protocol or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for any protocol. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>authtype</p></td>
<td class="parameter_description"><p> The authentication type or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for any type. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>port</p></td>
<td class="parameter_description"><p>The network port or zero for any port.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p>Callback which is called when the operation completes</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p> Data to be passed to callback. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>destroy_data</p></td>
<td class="parameter_description"><p>Function to be called when data is no longer needed.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.10.6.4.10"></a><h4>Returns</h4>
<p> The asynchronous request, which can be passed
to <a class="link" href="gnome-keyring-Miscellaneous-Functions.html#gnome-keyring-cancel-request" title="gnome_keyring_cancel_request ()"><code class="function">gnome_keyring_cancel_request()</code></a>. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-keyring-find-network-password-sync"></a><h3>gnome_keyring_find_network_password_sync ()</h3>
<pre class="programlisting"><a class="link" href="gnome-keyring-Result-Codes.html#GnomeKeyringResult" title="enum GnomeKeyringResult"><span class="returnvalue">GnomeKeyringResult</span></a>
gnome_keyring_find_network_password_sync
(<em class="parameter"><code>const <span class="type">char</span> *user</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *domain</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *server</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *object</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *protocol</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *authtype</code></em>,
<em class="parameter"><code><span class="type">guint32</span> port</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> **results</code></em>);</pre>
<div class="warning">
<p><code class="literal">gnome_keyring_find_network_password_sync</code> is deprecated and should not be used in newly-written code.</p>
<p>Use <code class="function">secret_password_lookup_sync()</code> with <code class="literal">SECRET_SCHEMA_COMPAT_NETWORK</code>.</p>
</div>
<p>Find a previously stored network password. Searches all keyrings.</p>
<p>A <a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><code class="literal">GList</code></a> of <a class="link" href="gnome-keyring-Network-Passwords.html#GnomeKeyringNetworkPasswordData" title="GnomeKeyringNetworkPasswordData"><span class="type">GnomeKeyringNetworkPasswordData</span></a> structures are returned in the
<em class="parameter"><code>out_list</code></em>
argument. The list should be freed with <a class="link" href="gnome-keyring-Network-Passwords.html#gnome-keyring-network-password-list-free" title="gnome_keyring_network_password_list_free ()"><code class="function">gnome_keyring_network_password_list_free()</code></a></p>
<p>The user may have been prompted to unlock necessary keyrings, and user will
have been prompted for access to the items if needed.</p>
<p>Network passwords are items with the item type <a class="link" href="gnome-keyring-Item-Information.html#GNOME-KEYRING-ITEM-NETWORK-PASSWORD:CAPS"><code class="literal">GNOME_KEYRING_ITEM_NETWORK_PASSWORD</code></a></p>
<div class="refsect3">
<a name="id-1.2.10.6.5.9"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>user</p></td>
<td class="parameter_description"><p> The user name or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>domain</p></td>
<td class="parameter_description"><p> The domain name or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>server</p></td>
<td class="parameter_description"><p> The server or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>object</p></td>
<td class="parameter_description"><p> The remote object or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>protocol</p></td>
<td class="parameter_description"><p> The network protocol or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>authtype</p></td>
<td class="parameter_description"><p> The authentication type or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>port</p></td>
<td class="parameter_description"><p>The network port or zero.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>results</p></td>
<td class="parameter_description"><p> A location
to return a <a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><code class="literal">GList</code></a> of <a class="link" href="gnome-keyring-Network-Passwords.html#GnomeKeyringNetworkPasswordData" title="GnomeKeyringNetworkPasswordData"><span class="type">GnomeKeyringNetworkPasswordData</span></a> pointers. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GnomeKeyringNetworkPasswordData]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.10.6.5.10"></a><h4>Returns</h4>
<p> <a class="link" href="gnome-keyring-Result-Codes.html#GNOME-KEYRING-RESULT-OK:CAPS"><code class="literal">GNOME_KEYRING_RESULT_OK</code></a> if the operation was succcessful or
an error result otherwise.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-keyring-set-network-password"></a><h3>gnome_keyring_set_network_password ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a>
gnome_keyring_set_network_password (<em class="parameter"><code>const <span class="type">char</span> *keyring</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *user</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *domain</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *server</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *object</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *protocol</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *authtype</code></em>,
<em class="parameter"><code><span class="type">guint32</span> port</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *password</code></em>,
<em class="parameter"><code><a class="link" href="gnome-keyring-Callbacks.html#GnomeKeyringOperationGetIntCallback" title="GnomeKeyringOperationGetIntCallback ()"><span class="type">GnomeKeyringOperationGetIntCallback</span></a> callback</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy_data</code></em>);</pre>
<div class="warning">
<p><code class="literal">gnome_keyring_set_network_password</code> is deprecated and should not be used in newly-written code.</p>
<p>Use <code class="function">secret_password_store()</code> with <code class="literal">SECRET_SCHEMA_COMPAT_NETWORK</code>.</p>
</div>
<p>Store a network password.</p>
<p>If an item already exists for with this network info (ie: user, server etc...)
then it will be updated.</p>
<p>Whether a new item is created or not, id of the item will be passed to
the <em class="parameter"><code>callback</code></em>
.</p>
<p>Network passwords are items with the item type <a class="link" href="gnome-keyring-Item-Information.html#GNOME-KEYRING-ITEM-NETWORK-PASSWORD:CAPS"><code class="literal">GNOME_KEYRING_ITEM_NETWORK_PASSWORD</code></a></p>
<div class="refsect3">
<a name="id-1.2.10.6.6.9"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>keyring</p></td>
<td class="parameter_description"><p> The keyring to store the password in, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for
the default keyring. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>user</p></td>
<td class="parameter_description"><p> The user name or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>domain</p></td>
<td class="parameter_description"><p> The domain name or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>server</p></td>
<td class="parameter_description"><p> The server or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>object</p></td>
<td class="parameter_description"><p> The remote object or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>protocol</p></td>
<td class="parameter_description"><p> The network protocol or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>authtype</p></td>
<td class="parameter_description"><p> The authentication type or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>port</p></td>
<td class="parameter_description"><p>The network port or zero.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>password</p></td>
<td class="parameter_description"><p>The password to store, must not be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p>Callback which is called when the operation completes</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p> Data to be passed to callback. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>destroy_data</p></td>
<td class="parameter_description"><p>Function to be called when data is no longer needed.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.10.6.6.10"></a><h4>Returns</h4>
<p> The asynchronous request, which can be passed
to <a class="link" href="gnome-keyring-Miscellaneous-Functions.html#gnome-keyring-cancel-request" title="gnome_keyring_cancel_request ()"><code class="function">gnome_keyring_cancel_request()</code></a>. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-keyring-set-network-password-sync"></a><h3>gnome_keyring_set_network_password_sync ()</h3>
<pre class="programlisting"><a class="link" href="gnome-keyring-Result-Codes.html#GnomeKeyringResult" title="enum GnomeKeyringResult"><span class="returnvalue">GnomeKeyringResult</span></a>
gnome_keyring_set_network_password_sync
(<em class="parameter"><code>const <span class="type">char</span> *keyring</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *user</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *domain</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *server</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *object</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *protocol</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *authtype</code></em>,
<em class="parameter"><code><span class="type">guint32</span> port</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *password</code></em>,
<em class="parameter"><code><span class="type">guint32</span> *item_id</code></em>);</pre>
<div class="warning">
<p><code class="literal">gnome_keyring_set_network_password_sync</code> is deprecated and should not be used in newly-written code.</p>
<p>Use <code class="function">secret_password_store_sync()</code> with <code class="literal">SECRET_SCHEMA_COMPAT_NETWORK</code>.</p>
</div>
<p>Store a network password.</p>
<p>If an item already exists for with this network info (ie: user, server etc...)
then it will be updated.</p>
<p>The created or updated item id will be returned in <em class="parameter"><code>item_id</code></em>
.</p>
<p>Network passwords are items with the item type <a class="link" href="gnome-keyring-Item-Information.html#GNOME-KEYRING-ITEM-NETWORK-PASSWORD:CAPS"><code class="literal">GNOME_KEYRING_ITEM_NETWORK_PASSWORD</code></a></p>
<div class="refsect3">
<a name="id-1.2.10.6.7.9"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>keyring</p></td>
<td class="parameter_description"><p> The keyring to store the password in, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for
the default keyring. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>user</p></td>
<td class="parameter_description"><p> The user name or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>domain</p></td>
<td class="parameter_description"><p> The domain name or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>server</p></td>
<td class="parameter_description"><p> The server or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>object</p></td>
<td class="parameter_description"><p> The remote object or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>protocol</p></td>
<td class="parameter_description"><p> The network protocol or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>authtype</p></td>
<td class="parameter_description"><p> The authentication type or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>port</p></td>
<td class="parameter_description"><p>The network port or zero.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>password</p></td>
<td class="parameter_description"><p>The password to store, must not be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>item_id</p></td>
<td class="parameter_description"><p> A location to store the resulting item's id. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.10.6.7.10"></a><h4>Returns</h4>
<p> <a class="link" href="gnome-keyring-Result-Codes.html#GNOME-KEYRING-RESULT-OK:CAPS"><code class="literal">GNOME_KEYRING_RESULT_OK</code></a> if the operation was succcessful or
an error result otherwise.</p>
<p></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="gnome-keyring-Network-Passwords.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GnomeKeyringNetworkPasswordData"></a><h3>GnomeKeyringNetworkPasswordData</h3>
<pre class="programlisting">typedef struct {
char *keyring;
guint32 item_id;
char *protocol;
char *server;
char *object;
char *authtype;
guint32 port;
char *user;
char *domain;
char *password;
} GnomeKeyringNetworkPasswordData;
</pre>
<div class="warning">
<p><code class="literal">GnomeKeyringNetworkPasswordData</code> is deprecated and should not be used in newly-written code.</p>
<p>Use <span class="type">SECRET_SCHEMA_COMPAT_NETWORK</span> instead.</p>
</div>
<p>Network password info.</p>
<div class="refsect3">
<a name="id-1.2.10.7.2.6"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><span class="type">char</span> *<em class="structfield"><code><a name="GnomeKeyringNetworkPasswordData.keyring"></a>keyring</code></em>;</p></td>
<td class="struct_member_description"><p>Keyring item stored in.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">guint32</span> <em class="structfield"><code><a name="GnomeKeyringNetworkPasswordData.item-id"></a>item_id</code></em>;</p></td>
<td class="struct_member_description"><p>The identifier of the item.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">char</span> *<em class="structfield"><code><a name="GnomeKeyringNetworkPasswordData.protocol"></a>protocol</code></em>;</p></td>
<td class="struct_member_description"><p>Network protocol or scheme.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">char</span> *<em class="structfield"><code><a name="GnomeKeyringNetworkPasswordData.server"></a>server</code></em>;</p></td>
<td class="struct_member_description"><p>Server or host name.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">char</span> *<em class="structfield"><code><a name="GnomeKeyringNetworkPasswordData.object"></a>object</code></em>;</p></td>
<td class="struct_member_description"><p>Share or other object on server.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">char</span> *<em class="structfield"><code><a name="GnomeKeyringNetworkPasswordData.authtype"></a>authtype</code></em>;</p></td>
<td class="struct_member_description"><p>Type of authentication.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">guint32</span> <em class="structfield"><code><a name="GnomeKeyringNetworkPasswordData.port"></a>port</code></em>;</p></td>
<td class="struct_member_description"><p>TCP port.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">char</span> *<em class="structfield"><code><a name="GnomeKeyringNetworkPasswordData.user"></a>user</code></em>;</p></td>
<td class="struct_member_description"><p>User name.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">char</span> *<em class="structfield"><code><a name="GnomeKeyringNetworkPasswordData.domain"></a>domain</code></em>;</p></td>
<td class="struct_member_description"><p>User domain</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">char</span> *<em class="structfield"><code><a name="GnomeKeyringNetworkPasswordData.password"></a>password</code></em>;</p></td>
<td class="struct_member_description"><p>The password.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.21</div>
</body>
</html>
|