docs/reference/glib/tmpl/gvariant.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GVariant
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9
  10 </para>
  11
  12
  13 <!-- ##### SECTION See_Also ##### -->
  14 <para>
  15
  16 </para>
  17
  18
  19 <!-- ##### SECTION Stability_Level ##### -->
  20
  21
  22 <!-- ##### STRUCT GVariant ##### -->
  23 <para>
  24
  25 </para>
  26
  27
  28 <!-- ##### FUNCTION g_variant_unref ##### -->
  29 <para>
  30
  31 </para>
  32
  33 @value:
  34
  35
  36 <!-- ##### FUNCTION g_variant_ref ##### -->
  37 <para>
  38
  39 </para>
  40
  41 @value:
  42 @Returns:
  43
  44
  45 <!-- ##### FUNCTION g_variant_ref_sink ##### -->
  46 <para>
  47
  48 </para>
  49
  50 @value:
  51 @Returns:
  52
  53
  54 <!-- ##### FUNCTION g_variant_get_type ##### -->
  55 <para>
  56
  57 </para>
  58
  59 @value:
  60 @Returns:
  61
  62
  63 <!-- ##### FUNCTION g_variant_get_type_string ##### -->
  64 <para>
  65
  66 </para>
  67
  68 @value:
  69 @Returns:
  70
  71
  72 <!-- ##### FUNCTION g_variant_is_of_type ##### -->
  73 <para>
  74
  75 </para>
  76
  77 @value:
  78 @type:
  79 @Returns:
  80
  81
  82 <!-- ##### FUNCTION g_variant_is_container ##### -->
  83 <para>
  84
  85 </para>
  86
  87 @value:
  88 @Returns:
  89
  90
  91 <!-- ##### FUNCTION g_variant_classify ##### -->
  92 <para>
  93
  94 </para>
  95
  96 @value:
  97 @Returns:
  98
  99
 100 <!-- ##### ENUM GVariantClass ##### -->
 101 <para>
 102
 103 </para>
 104
 105 @G_VARIANT_CLASS_BOOLEAN:
 106 @G_VARIANT_CLASS_BYTE:
 107 @G_VARIANT_CLASS_INT16:
 108 @G_VARIANT_CLASS_UINT16:
 109 @G_VARIANT_CLASS_INT32:
 110 @G_VARIANT_CLASS_UINT32:
 111 @G_VARIANT_CLASS_INT64:
 112 @G_VARIANT_CLASS_UINT64:
 113 @G_VARIANT_CLASS_HANDLE:
 114 @G_VARIANT_CLASS_DOUBLE:
 115 @G_VARIANT_CLASS_STRING:
 116 @G_VARIANT_CLASS_OBJECT_PATH:
 117 @G_VARIANT_CLASS_SIGNATURE:
 118 @G_VARIANT_CLASS_VARIANT:
 119 @G_VARIANT_CLASS_MAYBE:
 120 @G_VARIANT_CLASS_ARRAY:
 121 @G_VARIANT_CLASS_TUPLE:
 122 @G_VARIANT_CLASS_DICT_ENTRY:
 123
 124 <!-- ##### FUNCTION g_variant_get ##### -->
 125 <para>
 126
 127 </para>
 128
 129 @value:
 130 @format_string:
 131 @Varargs:
 132
 133
 134 <!-- ##### FUNCTION g_variant_get_va ##### -->
 135 <para>
 136
 137 </para>
 138
 139 @value:
 140 @format_string:
 141 @endptr:
 142 @app:
 143
 144
 145 <!-- ##### FUNCTION g_variant_new ##### -->
 146 <para>
 147
 148 </para>
 149
 150 @format_string:
 151 @Varargs:
 152 @Returns:
 153
 154
 155 <!-- ##### FUNCTION g_variant_new_va ##### -->
 156 <para>
 157
 158 </para>
 159
 160 @format_string:
 161 @endptr:
 162 @app:
 163 @Returns:
 164
 165
 166 <!-- ##### FUNCTION g_variant_new_boolean ##### -->
 167 <para>
 168
 169 </para>
 170
 171 @boolean:
 172 @Returns:
 173
 174
 175 <!-- ##### FUNCTION g_variant_new_byte ##### -->
 176 <para>
 177
 178 </para>
 179
 180 @byte:
 181 @Returns:
 182
 183
 184 <!-- ##### FUNCTION g_variant_new_int16 ##### -->
 185 <para>
 186
 187 </para>
 188
 189 @int16:
 190 @Returns:
 191
 192
 193 <!-- ##### FUNCTION g_variant_new_uint16 ##### -->
 194 <para>
 195
 196 </para>
 197
 198 @uint16:
 199 @Returns:
 200
 201
 202 <!-- ##### FUNCTION g_variant_new_int32 ##### -->
 203 <para>
 204
 205 </para>
 206
 207 @int32:
 208 @Returns:
 209
 210
 211 <!-- ##### FUNCTION g_variant_new_uint32 ##### -->
 212 <para>
 213
 214 </para>
 215
 216 @uint32:
 217 @Returns:
 218
 219
 220 <!-- ##### FUNCTION g_variant_new_int64 ##### -->
 221 <para>
 222
 223 </para>
 224
 225 @int64:
 226 @Returns:
 227
 228
 229 <!-- ##### FUNCTION g_variant_new_uint64 ##### -->
 230 <para>
 231
 232 </para>
 233
 234 @uint64:
 235 @Returns:
 236
 237
 238 <!-- ##### FUNCTION g_variant_new_handle ##### -->
 239 <para>
 240
 241 </para>
 242
 243 @handle:
 244 @Returns:
 245
 246
 247 <!-- ##### FUNCTION g_variant_new_double ##### -->
 248 <para>
 249
 250 </para>
 251
 252 @floating:
 253 @Returns:
 254
 255
 256 <!-- ##### FUNCTION g_variant_new_string ##### -->
 257 <para>
 258
 259 </para>
 260
 261 @string:
 262 @Returns:
 263
 264
 265 <!-- ##### FUNCTION g_variant_new_object_path ##### -->
 266 <para>
 267
 268 </para>
 269
 270 @object_path:
 271 @Returns:
 272
 273
 274 <!-- ##### FUNCTION g_variant_is_object_path ##### -->
 275 <para>
 276
 277 </para>
 278
 279 @string:
 280 @Returns:
 281
 282
 283 <!-- ##### FUNCTION g_variant_new_signature ##### -->
 284 <para>
 285
 286 </para>
 287
 288 @signature:
 289 @Returns:
 290
 291
 292 <!-- ##### FUNCTION g_variant_is_signature ##### -->
 293 <para>
 294
 295 </para>
 296
 297 @string:
 298 @Returns:
 299
 300
 301 <!-- ##### FUNCTION g_variant_new_variant ##### -->
 302 <para>
 303
 304 </para>
 305
 306 @value:
 307 @Returns:
 308
 309
 310 <!-- ##### FUNCTION g_variant_new_strv ##### -->
 311 <para>
 312
 313 </para>
 314
 315 @strv:
 316 @length:
 317 @Returns:
 318
 319
 320 <!-- ##### FUNCTION g_variant_get_boolean ##### -->
 321 <para>
 322
 323 </para>
 324
 325 @value:
 326 @Returns:
 327
 328
 329 <!-- ##### FUNCTION g_variant_get_byte ##### -->
 330 <para>
 331
 332 </para>
 333
 334 @value:
 335 @Returns:
 336
 337
 338 <!-- ##### FUNCTION g_variant_get_int16 ##### -->
 339 <para>
 340
 341 </para>
 342
 343 @value:
 344 @Returns:
 345
 346
 347 <!-- ##### FUNCTION g_variant_get_uint16 ##### -->
 348 <para>
 349
 350 </para>
 351
 352 @value:
 353 @Returns:
 354
 355
 356 <!-- ##### FUNCTION g_variant_get_int32 ##### -->
 357 <para>
 358
 359 </para>
 360
 361 @value:
 362 @Returns:
 363
 364
 365 <!-- ##### FUNCTION g_variant_get_uint32 ##### -->
 366 <para>
 367
 368 </para>
 369
 370 @value:
 371 @Returns:
 372
 373
 374 <!-- ##### FUNCTION g_variant_get_int64 ##### -->
 375 <para>
 376
 377 </para>
 378
 379 @value:
 380 @Returns:
 381
 382
 383 <!-- ##### FUNCTION g_variant_get_uint64 ##### -->
 384 <para>
 385
 386 </para>
 387
 388 @value:
 389 @Returns:
 390
 391
 392 <!-- ##### FUNCTION g_variant_get_handle ##### -->
 393 <para>
 394
 395 </para>
 396
 397 @value:
 398 @Returns:
 399
 400
 401 <!-- ##### FUNCTION g_variant_get_double ##### -->
 402 <para>
 403
 404 </para>
 405
 406 @value:
 407 @Returns:
 408
 409
 410 <!-- ##### FUNCTION g_variant_get_string ##### -->
 411 <para>
 412
 413 </para>
 414
 415 @value:
 416 @length:
 417 @Returns:
 418
 419
 420 <!-- ##### FUNCTION g_variant_dup_string ##### -->
 421 <para>
 422
 423 </para>
 424
 425 @value:
 426 @length:
 427 @Returns:
 428
 429
 430 <!-- ##### FUNCTION g_variant_get_variant ##### -->
 431 <para>
 432
 433 </para>
 434
 435 @value:
 436 @Returns:
 437
 438
 439 <!-- ##### FUNCTION g_variant_get_strv ##### -->
 440 <para>
 441
 442 </para>
 443
 444 @value:
 445 @length:
 446 @Returns:
 447
 448
 449 <!-- ##### FUNCTION g_variant_dup_strv ##### -->
 450 <para>
 451
 452 </para>
 453
 454 @value:
 455 @length:
 456 @Returns:
 457
 458
 459 <!-- ##### FUNCTION g_variant_new_maybe ##### -->
 460 <para>
 461
 462 </para>
 463
 464 @child_type:
 465 @child:
 466 @Returns:
 467
 468
 469 <!-- ##### FUNCTION g_variant_new_array ##### -->
 470 <para>
 471
 472 </para>
 473
 474 @child_type:
 475 @children:
 476 @n_children:
 477 @Returns:
 478
 479
 480 <!-- ##### FUNCTION g_variant_new_tuple ##### -->
 481 <para>
 482
 483 </para>
 484
 485 @children:
 486 @n_children:
 487 @Returns:
 488
 489
 490 <!-- ##### FUNCTION g_variant_new_dict_entry ##### -->
 491 <para>
 492
 493 </para>
 494
 495 @key:
 496 @value:
 497 @Returns:
 498
 499
 500 <!-- ##### FUNCTION g_variant_get_maybe ##### -->
 501 <para>
 502
 503 </para>
 504
 505 @value:
 506 @Returns:
 507
 508
 509 <!-- ##### FUNCTION g_variant_n_children ##### -->
 510 <para>
 511
 512 </para>
 513
 514 @value:
 515 @Returns:
 516
 517
 518 <!-- ##### FUNCTION g_variant_get_child_value ##### -->
 519 <para>
 520
 521 </para>
 522
 523 @value:
 524 @index_:
 525 @Returns:
 526
 527
 528 <!-- ##### FUNCTION g_variant_get_child ##### -->
 529 <para>
 530
 531 </para>
 532
 533 @value:
 534 @index_:
 535 @format_string:
 536 @Varargs:
 537
 538
 539 <!-- ##### FUNCTION g_variant_get_fixed_array ##### -->
 540 <para>
 541
 542 </para>
 543
 544 @value:
 545 @n_elements:
 546 @element_size:
 547 @Returns:
 548
 549
 550 <!-- ##### FUNCTION g_variant_get_size ##### -->
 551 <para>
 552
 553 </para>
 554
 555 @value:
 556 @Returns:
 557
 558
 559 <!-- ##### FUNCTION g_variant_get_data ##### -->
 560 <para>
 561
 562 </para>
 563
 564 @value:
 565 @Returns:
 566
 567
 568 <!-- ##### FUNCTION g_variant_store ##### -->
 569 <para>
 570
 571 </para>
 572
 573 @value:
 574 @data:
 575
 576
 577 <!-- ##### FUNCTION g_variant_new_from_data ##### -->
 578 <para>
 579
 580 </para>
 581
 582 @type:
 583 @data:
 584 @size:
 585 @trusted:
 586 @notify:
 587 @user_data:
 588 @Returns:
 589
 590
 591 <!-- ##### FUNCTION g_variant_byteswap ##### -->
 592 <para>
 593
 594 </para>
 595
 596 @value:
 597 @Returns:
 598
 599
 600 <!-- ##### FUNCTION g_variant_get_normal_form ##### -->
 601 <para>
 602
 603 </para>
 604
 605 @value:
 606 @Returns:
 607
 608
 609 <!-- ##### FUNCTION g_variant_is_normal_form ##### -->
 610 <para>
 611
 612 </para>
 613
 614 @value:
 615 @Returns:
 616
 617
 618 <!-- ##### FUNCTION g_variant_hash ##### -->
 619 <para>
 620
 621 </para>
 622
 623 @value:
 624 @Returns:
 625
 626
 627 <!-- ##### FUNCTION g_variant_equal ##### -->
 628 <para>
 629
 630 </para>
 631
 632 @one:
 633 @two:
 634 @Returns:
 635
 636
 637 <!-- ##### FUNCTION g_variant_print ##### -->
 638 <para>
 639
 640 </para>
 641
 642 @value:
 643 @type_annotate:
 644 @Returns:
 645
 646
 647 <!-- ##### FUNCTION g_variant_print_string ##### -->
 648 <para>
 649
 650 </para>
 651
 652 @value:
 653 @string:
 654 @type_annotate:
 655 @Returns:
 656
 657
 658 <!-- ##### STRUCT GVariantIter ##### -->
 659 <para>
 660
 661 </para>
 662
 663
 664 <!-- ##### FUNCTION g_variant_iter_copy ##### -->
 665 <para>
 666
 667 </para>
 668
 669 @iter:
 670 @Returns:
 671
 672
 673 <!-- ##### FUNCTION g_variant_iter_free ##### -->
 674 <para>
 675
 676 </para>
 677
 678 @iter:
 679
 680
 681 <!-- ##### FUNCTION g_variant_iter_init ##### -->
 682 <para>
 683
 684 </para>
 685
 686 @iter:
 687 @value:
 688 @Returns:
 689
 690
 691 <!-- ##### FUNCTION g_variant_iter_n_children ##### -->
 692 <para>
 693
 694 </para>
 695
 696 @iter:
 697 @Returns:
 698
 699
 700 <!-- ##### FUNCTION g_variant_iter_new ##### -->
 701 <para>
 702
 703 </para>
 704
 705 @value:
 706 @Returns:
 707
 708
 709 <!-- ##### FUNCTION g_variant_iter_next_value ##### -->
 710 <para>
 711
 712 </para>
 713
 714 @iter:
 715 @Returns:
 716
 717
 718 <!-- ##### FUNCTION g_variant_iter_next ##### -->
 719 <para>
 720
 721 </para>
 722
 723 @iter:
 724 @format_string:
 725 @Varargs:
 726 @Returns:
 727
 728
 729 <!-- ##### FUNCTION g_variant_iter_loop ##### -->
 730 <para>
 731
 732 </para>
 733
 734 @iter:
 735 @format_string:
 736 @Varargs:
 737 @Returns:
 738
 739
 740 <!-- ##### STRUCT GVariantBuilder ##### -->
 741 <para>
 742
 743 </para>
 744
 745
 746 <!-- ##### FUNCTION g_variant_builder_unref ##### -->
 747 <para>
 748
 749 </para>
 750
 751 @builder:
 752
 753
 754 <!-- ##### FUNCTION g_variant_builder_ref ##### -->
 755 <para>
 756
 757 </para>
 758
 759 @builder:
 760 @Returns:
 761
 762
 763 <!-- ##### FUNCTION g_variant_builder_new ##### -->
 764 <para>
 765
 766 </para>
 767
 768 @type:
 769 @Returns:
 770
 771
 772 <!-- ##### FUNCTION g_variant_builder_init ##### -->
 773 <para>
 774
 775 </para>
 776
 777 @builder:
 778 @type:
 779
 780
 781 <!-- ##### FUNCTION g_variant_builder_clear ##### -->
 782 <para>
 783
 784 </para>
 785
 786 @builder:
 787
 788
 789 <!-- ##### FUNCTION g_variant_builder_add_value ##### -->
 790 <para>
 791
 792 </para>
 793
 794 @builder:
 795 @value:
 796
 797
 798 <!-- ##### FUNCTION g_variant_builder_add ##### -->
 799 <para>
 800
 801 </para>
 802
 803 @builder:
 804 @format_string:
 805 @Varargs:
 806
 807
 808 <!-- ##### FUNCTION g_variant_builder_end ##### -->
 809 <para>
 810
 811 </para>
 812
 813 @builder:
 814 @Returns:
 815
 816
 817 <!-- ##### FUNCTION g_variant_builder_open ##### -->
 818 <para>
 819
 820 </para>
 821
 822 @builder:
 823 @type:
 824
 825
 826 <!-- ##### FUNCTION g_variant_builder_close ##### -->
 827 <para>
 828
 829 </para>
 830
 831 @builder:
 832
 833
 834 <!-- ##### MACRO G_VARIANT_PARSE_ERROR ##### -->
 835 <para>
 836
 837 </para>
 838
 839
 840
 841 <!-- ##### FUNCTION g_variant_parse ##### -->
 842 <para>
 843
 844 </para>
 845
 846 @type:
 847 @text:
 848 @limit:
 849 @endptr:
 850 @error:
 851 @Returns:
 852
 853
 854 <!-- ##### FUNCTION g_variant_new_parsed_va ##### -->
 855 <para>
 856
 857 </para>
 858
 859 @format:
 860 @app:
 861 @Returns:
 862
 863
 864 <!-- ##### FUNCTION g_variant_new_parsed ##### -->
 865 <para>
 866
 867 </para>
 868
 869 @format:
 870 @Varargs:
 871 @Returns:
 872
 873