/usr/share/gtk-doc/html/libsoup-2.4/libsoup-2.4-XMLRPC-Support.html is in libsoup2.4-doc 2.62.1-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 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 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>XMLRPC Support: libsoup Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="libsoup Reference Manual">
<link rel="up" href="ch04.html" title="Web Services APIs">
<link rel="prev" href="libsoup-2.4-HTML-Form-Support.html" title="HTML Form Support">
<link rel="next" href="libsoup-2.4-WebSockets.html" title="WebSockets">
<meta name="generator" content="GTK-Doc V1.27 (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="#libsoup-2.4-XMLRPC-Support.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="ch04.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libsoup-2.4-HTML-Form-Support.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libsoup-2.4-WebSockets.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libsoup-2.4-XMLRPC-Support"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libsoup-2.4-XMLRPC-Support.top_of_page"></a>XMLRPC Support</span></h2>
<p>XMLRPC Support — XML-RPC support</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libsoup-2.4-XMLRPC-Support.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">
<span class="returnvalue">char</span> *
</td>
<td class="function_name">
<a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-build-request" title="soup_xmlrpc_build_request ()">soup_xmlrpc_build_request</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="SoupMessage.html" title="SoupMessage"><span class="returnvalue">SoupMessage</span></a> *
</td>
<td class="function_name">
<a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-message-new" title="soup_xmlrpc_message_new ()">soup_xmlrpc_message_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> *
</td>
<td class="function_name">
<a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-parse-response" title="soup_xmlrpc_parse_response ()">soup_xmlrpc_parse_response</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> *
</td>
<td class="function_name">
<a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-variant-new-datetime" title="soup_xmlrpc_variant_new_datetime ()">soup_xmlrpc_variant_new_datetime</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="returnvalue">SoupDate</span></a> *
</td>
<td class="function_name">
<a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-variant-get-datetime" title="soup_xmlrpc_variant_get_datetime ()">soup_xmlrpc_variant_get_datetime</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="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-params-free" title="soup_xmlrpc_params_free ()">soup_xmlrpc_params_free</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> *
</td>
<td class="function_name">
<a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-params-parse" title="soup_xmlrpc_params_parse ()">soup_xmlrpc_params_parse</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">char</span> *
</td>
<td class="function_name">
<a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-parse-request" title="soup_xmlrpc_parse_request ()">soup_xmlrpc_parse_request</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">char</span> *
</td>
<td class="function_name">
<a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-build-response" title="soup_xmlrpc_build_response ()">soup_xmlrpc_build_response</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">char</span> *
</td>
<td class="function_name">
<a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-build-fault" title="soup_xmlrpc_build_fault ()">soup_xmlrpc_build_fault</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-message-set-response" title="soup_xmlrpc_message_set_response ()">soup_xmlrpc_message_set_response</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="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-message-set-fault" title="soup_xmlrpc_message_set_fault ()">soup_xmlrpc_message_set_fault</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libsoup-2.4-XMLRPC-Support.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="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libsoup-2.4-XMLRPC-Support.html#SOUP-XMLRPC-ERROR:CAPS" title="SOUP_XMLRPC_ERROR">SOUP_XMLRPC_ERROR</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="libsoup-2.4-XMLRPC-Support.html#SoupXMLRPCError" title="enum SoupXMLRPCError">SoupXMLRPCError</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libsoup-2.4-XMLRPC-Support.html#SOUP-XMLRPC-FAULT:CAPS" title="SOUP_XMLRPC_FAULT">SOUP_XMLRPC_FAULT</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="libsoup-2.4-XMLRPC-Support.html#SoupXMLRPCFault" title="enum SoupXMLRPCFault">SoupXMLRPCFault</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="libsoup-2.4-XMLRPC-Support.html#SoupXMLRPCParams" title="SoupXMLRPCParams">SoupXMLRPCParams</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libsoup-2.4-XMLRPC-Support.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libsoup/soup.h>
</pre>
</div>
<div class="refsect1">
<a name="libsoup-2.4-XMLRPC-Support.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="libsoup-2.4-XMLRPC-Support.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="soup-xmlrpc-build-request"></a><h3>soup_xmlrpc_build_request ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> *
soup_xmlrpc_build_request (<em class="parameter"><code>const <span class="type">char</span> *method_name</code></em>,
<em class="parameter"><code><a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *params</code></em>,
<em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>This creates an XML-RPC methodCall and returns it as a string.
This is the low-level method that <a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-message-new" title="soup_xmlrpc_message_new ()"><code class="function">soup_xmlrpc_message_new()</code></a> is
built on.</p>
<p><em class="parameter"><code>params</code></em>
is a <a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> tuple representing the method parameters.</p>
<p>Serialization details:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p>"a{s*}" and "{s*}" are serialized as <struct></p></li>
<li class="listitem"><p>"ay" is serialized as <base64></p></li>
<li class="listitem"><p>Other arrays and tuples are serialized as <array></p></li>
<li class="listitem"><p>booleans are serialized as <boolean></p></li>
<li class="listitem"><p>byte, int16, uint16 and int32 are serialized as <int></p></li>
<li class="listitem"><p>uint32 and int64 are serialized as the nonstandard <i8> type</p></li>
<li class="listitem"><p>doubles are serialized as <double></p></li>
<li class="listitem"><p>Strings are serialized as <string></p></li>
<li class="listitem"><p>Variants (i.e. "v" type) are unwrapped and their child is serialized.</p></li>
<li class="listitem"><p><a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariants</span></a> created by <a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-variant-new-datetime" title="soup_xmlrpc_variant_new_datetime ()"><code class="function">soup_xmlrpc_variant_new_datetime()</code></a> are serialized as
<dateTime.iso8601></p></li>
<li class="listitem"><p>Other types are not supported and will return <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> and set <em class="parameter"><code>error</code></em>
.
This notably includes: object-paths, signatures, uint64, handles, maybes
and dictionaries with non-string keys.</p></li>
</ul></div>
<p>If <em class="parameter"><code>params</code></em>
is floating, it is consumed.</p>
<div class="refsect3">
<a name="soup-xmlrpc-build-request.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>method_name</p></td>
<td class="parameter_description"><p>the name of the XML-RPC method</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>params</p></td>
<td class="parameter_description"><p>a <a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> tuple</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="soup-xmlrpc-build-request.returns"></a><h4>Returns</h4>
<p> the text of the methodCall, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error.</p>
</div>
<p class="since">Since: 2.52</p>
</div>
<hr>
<div class="refsect2">
<a name="soup-xmlrpc-message-new"></a><h3>soup_xmlrpc_message_new ()</h3>
<pre class="programlisting"><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="returnvalue">SoupMessage</span></a> *
soup_xmlrpc_message_new (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *method_name</code></em>,
<em class="parameter"><code><a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *params</code></em>,
<em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Creates an XML-RPC methodCall and returns a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a>, ready
to send, for that method call.</p>
<p>See <a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-build-request" title="soup_xmlrpc_build_request ()"><code class="function">soup_xmlrpc_build_request()</code></a> for serialization details.</p>
<p>If <em class="parameter"><code>params</code></em>
is floating, it is consumed.</p>
<div class="refsect3">
<a name="soup-xmlrpc-message-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>uri</p></td>
<td class="parameter_description"><p>URI of the XML-RPC service</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>method_name</p></td>
<td class="parameter_description"><p>the name of the XML-RPC method to invoke at <em class="parameter"><code>uri</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>params</p></td>
<td class="parameter_description"><p>a <a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> tuple</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="soup-xmlrpc-message-new.returns"></a><h4>Returns</h4>
<p>a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> encoding the
indicated XML-RPC request, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: 2.52</p>
</div>
<hr>
<div class="refsect2">
<a name="soup-xmlrpc-parse-response"></a><h3>soup_xmlrpc_parse_response ()</h3>
<pre class="programlisting"><a href="../glib/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> *
soup_xmlrpc_parse_response (<em class="parameter"><code>const <span class="type">char</span> *method_response</code></em>,
<em class="parameter"><code><span class="type">int</span> length</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *signature</code></em>,
<em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Parses <em class="parameter"><code>method_response</code></em>
and returns the return value. If
<em class="parameter"><code>method_response</code></em>
is a fault, <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> is returned, and <em class="parameter"><code>error</code></em>
will be set to an error in the <a class="link" href="libsoup-2.4-XMLRPC-Support.html#SOUP-XMLRPC-FAULT:CAPS" title="SOUP_XMLRPC_FAULT"><code class="literal">SOUP_XMLRPC_FAULT</code></a> domain, with the error
code containing the fault code, and the error message containing
the fault string. If <em class="parameter"><code>method_response</code></em>
cannot be parsed, <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> is returned,
and <em class="parameter"><code>error</code></em>
will be set to an error in the <a class="link" href="libsoup-2.4-XMLRPC-Support.html#SOUP-XMLRPC-ERROR:CAPS" title="SOUP_XMLRPC_ERROR"><code class="literal">SOUP_XMLRPC_ERROR</code></a> domain.</p>
<p>See <a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-params-parse" title="soup_xmlrpc_params_parse ()"><code class="function">soup_xmlrpc_params_parse()</code></a> for deserialization details.</p>
<div class="refsect3">
<a name="soup-xmlrpc-parse-response.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>method_response</p></td>
<td class="parameter_description"><p>the XML-RPC methodResponse string</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 <em class="parameter"><code>method_response</code></em>
, or -1 if it is NUL-terminated</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>signature</p></td>
<td class="parameter_description"><p>A valid <a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> type string, or <a href="../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>error</p></td>
<td class="parameter_description"><p>a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="soup-xmlrpc-parse-response.returns"></a><h4>Returns</h4>
<p>a new (non-floating) <a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></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>
<p class="since">Since: 2.52</p>
</div>
<hr>
<div class="refsect2">
<a name="soup-xmlrpc-variant-new-datetime"></a><h3>soup_xmlrpc_variant_new_datetime ()</h3>
<pre class="programlisting"><a href="../glib/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> *
soup_xmlrpc_variant_new_datetime (<em class="parameter"><code><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> *date</code></em>);</pre>
<p>Construct a special <a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> used to serialize a <dateTime.iso8601>
node. See <a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-build-request" title="soup_xmlrpc_build_request ()"><code class="function">soup_xmlrpc_build_request()</code></a>.</p>
<p>The actual type of the returned <a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> is unspecified and "v" or "*"
should be used in variant format strings. For example:</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1</pre></td>
<td class="listing_code"><pre class="programlisting">args <span class="gtkdoc opt">=</span> <span class="function"><a href="../glib/glib-GVariant.html#g-variant-new">g_variant_new</a></span> <span class="gtkdoc opt">(</span><span class="string">"(v)"</span><span class="gtkdoc opt">,</span> <span class="function"><a href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-variant-new-datetime">soup_xmlrpc_variant_new_datetime</a></span> <span class="gtkdoc opt">(</span>date<span class="gtkdoc opt">));</span></pre></td>
</tr>
</tbody>
</table>
</div>
<div class="refsect3">
<a name="soup-xmlrpc-variant-new-datetime.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>date</p></td>
<td class="parameter_description"><p>a <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="soup-xmlrpc-variant-new-datetime.returns"></a><h4>Returns</h4>
<p> a floating <a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a>.</p>
</div>
<p class="since">Since: 2.52</p>
</div>
<hr>
<div class="refsect2">
<a name="soup-xmlrpc-variant-get-datetime"></a><h3>soup_xmlrpc_variant_get_datetime ()</h3>
<pre class="programlisting"><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="returnvalue">SoupDate</span></a> *
soup_xmlrpc_variant_get_datetime (<em class="parameter"><code><a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *variant</code></em>,
<em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Get the <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> from special <a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> created by
<a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-variant-new-datetime" title="soup_xmlrpc_variant_new_datetime ()"><code class="function">soup_xmlrpc_variant_new_datetime()</code></a> or by parsing a <dateTime.iso8601>
node. See <a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-params-parse" title="soup_xmlrpc_params_parse ()"><code class="function">soup_xmlrpc_params_parse()</code></a>.</p>
<p>If <em class="parameter"><code>variant</code></em>
does not contain a datetime it will return an error but it is not
considered a programmer error because it generally means parameters received
are not in the expected type.</p>
<div class="refsect3">
<a name="soup-xmlrpc-variant-get-datetime.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>variant</p></td>
<td class="parameter_description"><p>a <a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="soup-xmlrpc-variant-get-datetime.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error.</p>
</div>
<p class="since">Since: 2.52</p>
</div>
<hr>
<div class="refsect2">
<a name="soup-xmlrpc-params-free"></a><h3>soup_xmlrpc_params_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
soup_xmlrpc_params_free (<em class="parameter"><code><a class="link" href="libsoup-2.4-XMLRPC-Support.html#SoupXMLRPCParams" title="SoupXMLRPCParams"><span class="type">SoupXMLRPCParams</span></a> *self</code></em>);</pre>
<p>Free a <a class="link" href="libsoup-2.4-XMLRPC-Support.html#SoupXMLRPCParams" title="SoupXMLRPCParams"><span class="type">SoupXMLRPCParams</span></a> returned by <a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-parse-request" title="soup_xmlrpc_parse_request ()"><code class="function">soup_xmlrpc_parse_request()</code></a>.</p>
<div class="refsect3">
<a name="soup-xmlrpc-params-free.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>self</p></td>
<td class="parameter_description"><p>a SoupXMLRPCParams</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: 2.52</p>
</div>
<hr>
<div class="refsect2">
<a name="soup-xmlrpc-params-parse"></a><h3>soup_xmlrpc_params_parse ()</h3>
<pre class="programlisting"><a href="../glib/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> *
soup_xmlrpc_params_parse (<em class="parameter"><code><a class="link" href="libsoup-2.4-XMLRPC-Support.html#SoupXMLRPCParams" title="SoupXMLRPCParams"><span class="type">SoupXMLRPCParams</span></a> *self</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *signature</code></em>,
<em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Parse method parameters returned by <a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-parse-request" title="soup_xmlrpc_parse_request ()"><code class="function">soup_xmlrpc_parse_request()</code></a>.</p>
<p>Deserialization details:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p>If <em class="parameter"><code>signature</code></em>
is provided, <int> and <i4> can be deserialized
to byte, int16, uint16, int32, uint32, int64 or uint64. Otherwise
it will be deserialized to int32. If the value is out of range
for the target type it will return an error.</p></li>
<li class="listitem"><p><struct> will be deserialized to "a{sv}". <em class="parameter"><code>signature</code></em>
could define
another value type (e.g. "a{ss}").</p></li>
<li class="listitem"><p><array> will be deserialized to "av". <em class="parameter"><code>signature</code></em>
could define
another element type (e.g. "as") or could be a tuple (e.g. "(ss)").</p></li>
<li class="listitem"><p><base64> will be deserialized to "ay".</p></li>
<li class="listitem"><p><string> will be deserialized to "s".</p></li>
<li class="listitem"><p><dateTime.iso8601> will be deserialized to an unspecified variant
type. If <em class="parameter"><code>signature</code></em>
is provided it must have the generic "v" type, which
means there is no guarantee that it's actually a datetime that has been
received. <a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-variant-get-datetime" title="soup_xmlrpc_variant_get_datetime ()"><code class="function">soup_xmlrpc_variant_get_datetime()</code></a> must be used to parse and
type check this special variant.</p></li>
<li class="listitem"><p><em class="parameter"><code>signature</code></em>
must not have maybes, otherwise an error is returned.</p></li>
<li class="listitem"><p>Dictionaries must have string keys, otherwise an error is returned.</p></li>
</ul></div>
<div class="refsect3">
<a name="soup-xmlrpc-params-parse.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>self</p></td>
<td class="parameter_description"><p>A <a class="link" href="libsoup-2.4-XMLRPC-Support.html#SoupXMLRPCParams" title="SoupXMLRPCParams"><span class="type">SoupXMLRPCParams</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>signature</p></td>
<td class="parameter_description"><p>A valid <a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> type string, or <a href="../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>error</p></td>
<td class="parameter_description"><p>a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="soup-xmlrpc-params-parse.returns"></a><h4>Returns</h4>
<p>a new (non-floating) <a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></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>
<p class="since">Since: 2.52</p>
</div>
<hr>
<div class="refsect2">
<a name="soup-xmlrpc-parse-request"></a><h3>soup_xmlrpc_parse_request ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> *
soup_xmlrpc_parse_request (<em class="parameter"><code>const <span class="type">char</span> *method_call</code></em>,
<em class="parameter"><code><span class="type">int</span> length</code></em>,
<em class="parameter"><code><a class="link" href="libsoup-2.4-XMLRPC-Support.html#SoupXMLRPCParams" title="SoupXMLRPCParams"><span class="type">SoupXMLRPCParams</span></a> **params</code></em>,
<em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Parses <em class="parameter"><code>method_call</code></em>
and return the method name. Method parameters can be
parsed later using <a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-params-parse" title="soup_xmlrpc_params_parse ()"><code class="function">soup_xmlrpc_params_parse()</code></a>.</p>
<div class="refsect3">
<a name="soup-xmlrpc-parse-request.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>method_call</p></td>
<td class="parameter_description"><p>the XML-RPC methodCall string</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 <em class="parameter"><code>method_call</code></em>
, or -1 if it is NUL-terminated</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>params</p></td>
<td class="parameter_description"><p>on success, a new <a class="link" href="libsoup-2.4-XMLRPC-Support.html#SoupXMLRPCParams" title="SoupXMLRPCParams"><span class="type">SoupXMLRPCParams</span></a>. </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>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="soup-xmlrpc-parse-request.returns"></a><h4>Returns</h4>
<p>method's name, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: 2.52</p>
</div>
<hr>
<div class="refsect2">
<a name="soup-xmlrpc-build-response"></a><h3>soup_xmlrpc_build_response ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> *
soup_xmlrpc_build_response (<em class="parameter"><code><a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *value</code></em>,
<em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>This creates a (successful) XML-RPC methodResponse and returns it
as a string. To create a fault response, use <a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-build-fault" title="soup_xmlrpc_build_fault ()"><code class="function">soup_xmlrpc_build_fault()</code></a>. This
is the low-level method that <a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-message-set-response" title="soup_xmlrpc_message_set_response ()"><code class="function">soup_xmlrpc_message_set_response()</code></a> is built on.</p>
<p>See <a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-build-request" title="soup_xmlrpc_build_request ()"><code class="function">soup_xmlrpc_build_request()</code></a> for serialization details, but note
that since a method can only have a single return value, <em class="parameter"><code>value</code></em>
should not be a tuple here (unless the return value is an array).</p>
<p>If <em class="parameter"><code>value</code></em>
is floating, it is consumed.</p>
<div class="refsect3">
<a name="soup-xmlrpc-build-response.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 return value</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="soup-xmlrpc-build-response.returns"></a><h4>Returns</h4>
<p> the text of the methodResponse, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error.</p>
</div>
<p class="since">Since: 2.52</p>
</div>
<hr>
<div class="refsect2">
<a name="soup-xmlrpc-build-fault"></a><h3>soup_xmlrpc_build_fault ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> *
soup_xmlrpc_build_fault (<em class="parameter"><code><span class="type">int</span> fault_code</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *fault_format</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>This creates an XML-RPC fault response and returns it as a string.
(To create a successful response, use
<code class="function">soup_xmlrpc_build_method_response()</code>.)</p>
<div class="refsect3">
<a name="soup-xmlrpc-build-fault.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>fault_code</p></td>
<td class="parameter_description"><p>the fault code</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>fault_format</p></td>
<td class="parameter_description"><p>a <code class="function">printf()</code>-style format string</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p>the parameters to <em class="parameter"><code>fault_format</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="soup-xmlrpc-build-fault.returns"></a><h4>Returns</h4>
<p> the text of the fault</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="soup-xmlrpc-message-set-response"></a><h3>soup_xmlrpc_message_set_response ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
soup_xmlrpc_message_set_response (<em class="parameter"><code><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg</code></em>,
<em class="parameter"><code><a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *value</code></em>,
<em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Sets the status code and response body of <em class="parameter"><code>msg</code></em>
to indicate a
successful XML-RPC call, with a return value given by <em class="parameter"><code>value</code></em>
. To set a
fault response, use <a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-message-set-fault" title="soup_xmlrpc_message_set_fault ()"><code class="function">soup_xmlrpc_message_set_fault()</code></a>.</p>
<p>See <a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-build-request" title="soup_xmlrpc_build_request ()"><code class="function">soup_xmlrpc_build_request()</code></a> for serialization details.</p>
<p>If <em class="parameter"><code>value</code></em>
is floating, it is consumed.</p>
<div class="refsect3">
<a name="soup-xmlrpc-message-set-response.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>msg</p></td>
<td class="parameter_description"><p>an XML-RPC request</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p>a <a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="soup-xmlrpc-message-set-response.returns"></a><h4>Returns</h4>
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</p>
</div>
<p class="since">Since: 2.52</p>
</div>
<hr>
<div class="refsect2">
<a name="soup-xmlrpc-message-set-fault"></a><h3>soup_xmlrpc_message_set_fault ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
soup_xmlrpc_message_set_fault (<em class="parameter"><code><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg</code></em>,
<em class="parameter"><code><span class="type">int</span> fault_code</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *fault_format</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Sets the status code and response body of <em class="parameter"><code>msg</code></em>
to indicate an
unsuccessful XML-RPC call, with the error described by <em class="parameter"><code>fault_code</code></em>
and <em class="parameter"><code>fault_format</code></em>
.</p>
<div class="refsect3">
<a name="soup-xmlrpc-message-set-fault.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>msg</p></td>
<td class="parameter_description"><p>an XML-RPC request</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>fault_code</p></td>
<td class="parameter_description"><p>the fault code</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>fault_format</p></td>
<td class="parameter_description"><p>a <code class="function">printf()</code>-style format string</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p>the parameters to <em class="parameter"><code>fault_format</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 2.52</p>
</div>
</div>
<div class="refsect1">
<a name="libsoup-2.4-XMLRPC-Support.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="SOUP-XMLRPC-ERROR:CAPS"></a><h3>SOUP_XMLRPC_ERROR</h3>
<pre class="programlisting">#define SOUP_XMLRPC_ERROR soup_xmlrpc_error_quark()
</pre>
</div>
<hr>
<div class="refsect2">
<a name="SoupXMLRPCError"></a><h3>enum SoupXMLRPCError</h3>
<div class="refsect3">
<a name="SoupXMLRPCError.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="SOUP-XMLRPC-ERROR-ARGUMENTS:CAPS"></a>SOUP_XMLRPC_ERROR_ARGUMENTS</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="SOUP-XMLRPC-ERROR-RETVAL:CAPS"></a>SOUP_XMLRPC_ERROR_RETVAL</p></td>
<td> </td>
<td> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="SOUP-XMLRPC-FAULT:CAPS"></a><h3>SOUP_XMLRPC_FAULT</h3>
<pre class="programlisting">#define SOUP_XMLRPC_FAULT soup_xmlrpc_fault_quark()
</pre>
<p>A <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> domain representing an XML-RPC fault code. Used with
<a class="link" href="libsoup-2.4-XMLRPC-Support.html#SoupXMLRPCFault" title="enum SoupXMLRPCFault"><span class="type">SoupXMLRPCFault</span></a> (although servers may also return fault codes not
in that enumeration).</p>
</div>
<hr>
<div class="refsect2">
<a name="SoupXMLRPCFault"></a><h3>enum SoupXMLRPCFault</h3>
<p>Pre-defined XML-RPC fault codes from <a class="ulink" href="http://xmlrpc-epi.sourceforge.net/specs/rfc.fault_codes.php" target="_top">http://xmlrpc-epi.sourceforge.net/specs/rfc.fault_codes.php</a>.
These are an extension, not part of the XML-RPC spec; you can't
assume servers will use them.</p>
<div class="refsect3">
<a name="SoupXMLRPCFault.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="SOUP-XMLRPC-FAULT-PARSE-ERROR-NOT-WELL-FORMED:CAPS"></a>SOUP_XMLRPC_FAULT_PARSE_ERROR_NOT_WELL_FORMED</p></td>
<td class="enum_member_description">
<p>request was not
well-formed</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="SOUP-XMLRPC-FAULT-PARSE-ERROR-UNSUPPORTED-ENCODING:CAPS"></a>SOUP_XMLRPC_FAULT_PARSE_ERROR_UNSUPPORTED_ENCODING</p></td>
<td class="enum_member_description">
<p>request was in
an unsupported encoding</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="SOUP-XMLRPC-FAULT-PARSE-ERROR-INVALID-CHARACTER-FOR-ENCODING:CAPS"></a>SOUP_XMLRPC_FAULT_PARSE_ERROR_INVALID_CHARACTER_FOR_ENCODING</p></td>
<td class="enum_member_description">
<p> request contained an invalid character</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="SOUP-XMLRPC-FAULT-SERVER-ERROR-INVALID-XML-RPC:CAPS"></a>SOUP_XMLRPC_FAULT_SERVER_ERROR_INVALID_XML_RPC</p></td>
<td class="enum_member_description">
<p>request was not
valid XML-RPC</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="SOUP-XMLRPC-FAULT-SERVER-ERROR-REQUESTED-METHOD-NOT-FOUND:CAPS"></a>SOUP_XMLRPC_FAULT_SERVER_ERROR_REQUESTED_METHOD_NOT_FOUND</p></td>
<td class="enum_member_description">
<p>method
not found</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="SOUP-XMLRPC-FAULT-SERVER-ERROR-INVALID-METHOD-PARAMETERS:CAPS"></a>SOUP_XMLRPC_FAULT_SERVER_ERROR_INVALID_METHOD_PARAMETERS</p></td>
<td class="enum_member_description">
<p>invalid
parameters</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="SOUP-XMLRPC-FAULT-SERVER-ERROR-INTERNAL-XML-RPC-ERROR:CAPS"></a>SOUP_XMLRPC_FAULT_SERVER_ERROR_INTERNAL_XML_RPC_ERROR</p></td>
<td class="enum_member_description">
<p>internal
error</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="SOUP-XMLRPC-FAULT-APPLICATION-ERROR:CAPS"></a>SOUP_XMLRPC_FAULT_APPLICATION_ERROR</p></td>
<td class="enum_member_description">
<p>start of reserved range for
application error codes</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="SOUP-XMLRPC-FAULT-SYSTEM-ERROR:CAPS"></a>SOUP_XMLRPC_FAULT_SYSTEM_ERROR</p></td>
<td class="enum_member_description">
<p>start of reserved range for
system error codes</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="SOUP-XMLRPC-FAULT-TRANSPORT-ERROR:CAPS"></a>SOUP_XMLRPC_FAULT_TRANSPORT_ERROR</p></td>
<td class="enum_member_description">
<p>start of reserved range for
transport error codes</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="SoupXMLRPCParams"></a><h3>SoupXMLRPCParams</h3>
<pre class="programlisting">typedef struct _SoupXMLRPCParams SoupXMLRPCParams;</pre>
<p>Opaque structure containing XML-RPC methodCall parameter values.
Can be parsed using <a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-params-parse" title="soup_xmlrpc_params_parse ()"><code class="function">soup_xmlrpc_params_parse()</code></a> and freed with
<a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-params-free" title="soup_xmlrpc_params_free ()"><code class="function">soup_xmlrpc_params_free()</code></a>.</p>
<p class="since">Since: 2.52</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>
|