docs/reference/glib/tmpl/glib-unused.sgml

   1 <!-- ##### SECTION ./tmpl/desktop_entry.sgml:Long_Description ##### -->
   2 <para>
   3 The "GDesktopEntry" parser is intended to parse files written to
   4 the <ulink
   5 url="http://www.freedesktop.org/Standards/desktop-entry-spec">Desktop
   6 Entry Specification</ulink>.  It supports deserialization of
   7 desktop entries from files and in-memory data.  Desktop entries
   8 are used for a variety of things including menus, application
   9 MIME type registration, and launchers.
  10 </para>
  11
  12 <para>
  13 To load an existing desktop entry from a data directory (as
  14 returned by g_get_user_data_dir() and g_get_system_data_dirs())
  15 use g_desktop_entry_new_from_data_dirs().  To load an existing
  16 desktop entry from an arbitrary location on the file system use
  17 g_desktop_entry_new_from_file().  If the desktop entry is already
  18 in memory use g_desktop_entry_new_from_data().  Once the desktop
  19 entry is loaded its keys can be queried using the g_desktop_entry_get
  20 family of functions.
  21 </para>
  22
  23 <para>
  24 To create a new desktop entry first call g_desktop_entry_new().
  25 Then, call the g_desktop_entry_set family of functions.  Next,
  26 call g_desktop_entry_to_data() to output the desktop entry to
  27 a byte array, which can be written to disk or sent over a
  28 network.  Finally, call g_desktop_entry_free() to deallocate the
  29 #GDesktopEntry object returned by g_desktop_entry_new().
  30 </para>
  31
  32
  33 <!-- ##### SECTION ./tmpl/desktop_entry.sgml:See_Also ##### -->
  34 <para>
  35
  36 </para>
  37
  38
  39 <!-- ##### SECTION ./tmpl/desktop_entry.sgml:Short_Description ##### -->
  40 serializes and deserializes a desktop entry.
  41
  42
  43 <!-- ##### SECTION ./tmpl/desktop_entry.sgml:Title ##### -->
  44 Desktop Entry Parser
  45
  46
  47 <!-- ##### SECTION ./tmpl/glib-unused.sgml:Stability_Level ##### -->
  48
  49
  50
  51 <!-- ##### SECTION ./tmpl/testutils.sgml:Long_Description ##### -->
  52 <para>
  53
  54 </para>
  55
  56
  57 <!-- ##### SECTION ./tmpl/testutils.sgml:See_Also ##### -->
  58 <para>
  59
  60 </para>
  61
  62
  63 <!-- ##### SECTION ./tmpl/testutils.sgml:Short_Description ##### -->
  64
  65
  66
  67 <!-- ##### SECTION ./tmpl/testutils.sgml:Stability_Level ##### -->
  68
  69
  70
  71 <!-- ##### SECTION ./tmpl/testutils.sgml:Title ##### -->
  72 Testing
  73
  74
  75 <!-- ##### ENUM GChannelError ##### -->
  76 <para>
  77
  78 </para>
  79
  80 @G_CHANNEL_ERROR_ACCES:
  81 @G_CHANNEL_ERROR_BADF:
  82 @G_CHANNEL_ERROR_DEADLK:
  83 @G_CHANNEL_ERROR_FAULT:
  84 @G_CHANNEL_ERROR_INVAL:
  85 @G_CHANNEL_ERROR_IO:
  86 @G_CHANNEL_ERROR_ISDIR:
  87 @G_CHANNEL_ERROR_MFILE:
  88 @G_CHANNEL_ERROR_NOLCK:
  89 @G_CHANNEL_ERROR_NOSPC:
  90 @G_CHANNEL_ERROR_PERM:
  91 @G_CHANNEL_ERROR_PIPE:
  92 @G_CHANNEL_ERROR_SPIPE:
  93 @G_CHANNEL_ERROR_ENCODE_RW:
  94 @G_CHANNEL_ERROR_FAILED:
  95
  96 <!-- ##### ENUM GChannelStatus ##### -->
  97 <para>
  98
  99 </para>
 100
 101 @G_CHANNEL_STATUS_NORMAL:
 102 @G_CHANNEL_STATUS_EOF:
 103 @G_CHANNEL_STATUS_PARTIAL_CHARS:
 104 @G_CHANNEL_STATUS_AGAIN:
 105 @G_CHANNEL_STATUS_INTR:
 106 @G_CHANNEL_STATUS_ERROR:
 107 @G_CHANNEL_STATUS_BAD_INPUT:
 108
 109 <!-- ##### USER_FUNCTION GCompareFuncData ##### -->
 110 <para>
 111
 112 </para>
 113
 114 @a:
 115 @b:
 116 @user_data:
 117 @Returns:
 118
 119 <!-- ##### USER_FUNCTION GCompletionStrcmpFunc ##### -->
 120 <para>
 121
 122 </para>
 123
 124 @s1:
 125 @s2:
 126 @Returns:
 127
 128 <!-- ##### STRUCT GDesktopEntry ##### -->
 129 <para>
 130
 131 </para>
 132
 133
 134 <!-- ##### ENUM GDesktopEntryError ##### -->
 135 <para>
 136 Error codes returned by desktop entry parsing.
 137 </para>
 138
 139 @G_DESKTOP_ENTRY_ERROR_UNKNOWN_ENCODING: text being parsed is not UTF-8 and
 140 cannot be guessed.
 141 @G_DESKTOP_ENTRY_ERROR_BAD_START_GROUP: desktop entry does not start with a
 142 legal start group.
 143 @G_DESKTOP_ENTRY_ERROR_PARSE: desktop entry is empty or contains invalid
 144 data.
 145 @G_DESKTOP_ENTRY_ERROR_NOT_FOUND: valid desktop entry could not be found.
 146 @G_DESKTOP_ENTRY_ERROR_KEY_NOT_FOUND: desktop entry does not have requested
 147 key.
 148 @G_DESKTOP_ENTRY_ERROR_GROUP_NOT_FOUND: desktop entry does not have requested
 149 group
 150 @G_DESKTOP_ENTRY_ERROR_INVALID_VALUE: desktop entry contains key which has
 151 value that cannot be validated.
 152
 153 <!-- ##### ENUM GDesktopEntryFlags ##### -->
 154 <para>
 155 #GDesktopEntry supports a few flags for tweaking performance during
 156 deserialization.  #G_DESKTOP_ENTRY_DISCARD_COMMENTS and
 157 #G_DESKTOP_ENTRY_DISCARD_TRANSLATIONS will reduce memory footprint,
 158 and #G_DESKTOP_ENTRY_GENERATE_LOOKUP_MAP will increase key lookup speed.
 159 </para>
 160
 161 @G_DESKTOP_ENTRY_NONE: use parser defaults
 162 @G_DESKTOP_ENTRY_DISCARD_COMMENTS:  Discard all lines that are blank
 163 or start with "#".
 164 @G_DESKTOP_ENTRY_DISCARD_TRANSLATIONS: Only retain translations that
 165 are returned by g_get_language_names().
 166 @G_DESKTOP_ENTRY_GENERATE_LOOKUP_MAP: Generate a lookup map for key names to make lookups constant time at the cost of more memory.
 167
 168 <!-- ##### USER_FUNCTION GErrorFunc ##### -->
 169 <para>
 170 Specifies the type of function passed to g_set_error_handler().
 171 </para>
 172
 173 @str: the error message.
 174
 175 <!-- ##### USER_FUNCTION GHookFreeFunc ##### -->
 176 <para>
 177
 178 </para>
 179
 180 @hook_list:
 181 @hook:
 182
 183 <!-- ##### MACRO GINT16_TO_BE ##### -->
 184 <para>
 185 Converts a #gint16 value from host byte order to big-endian.
 186 </para>
 187
 188 @val: a #gint16 value in host byte order.
 189 @Returns: @val converted to big-endian.
 190
 191 <!-- ##### MACRO GINT16_TO_LE ##### -->
 192 <para>
 193 Converts a #gint16 value from host byte order to little-endian.
 194 </para>
 195
 196 @val: a #gint16 value in host byte order.
 197 @Returns: @val converted to little-endian.
 198
 199 <!-- ##### MACRO GINT32_TO_BE ##### -->
 200 <para>
 201 Converts a #gint32 value from host byte order to big-endian.
 202 </para>
 203
 204 @val: a #gint32 value in host byte order.
 205 @Returns: @val converted to big-endian.
 206
 207 <!-- ##### MACRO GINT32_TO_LE ##### -->
 208 <para>
 209 Converts a #gint32 value from host byte order to little-endian.
 210 </para>
 211
 212 @val: a #gint32 value in host byte order.
 213 @Returns: @val converted to little-endian.
 214
 215 <!-- ##### MACRO GINT64_TO_BE ##### -->
 216 <para>
 217 Converts a #gint64 value from host byte order to big-endian.
 218 </para>
 219
 220 @val: a #gint64 value in host byte order.
 221 @Returns: @val converted to big-endian.
 222
 223 <!-- ##### MACRO GINT64_TO_LE ##### -->
 224 <para>
 225 Converts a #gint64 value from host byte order to little-endian.
 226 </para>
 227
 228 @val: a #gint64 value in host byte order.
 229 @Returns: @val converted to little-endian.
 230
 231 <!-- ##### MACRO GINT_TO_BE ##### -->
 232 <para>
 233 Converts a #gint value from host byte order to big-endian.
 234 </para>
 235
 236 @val: a #gint value in host byte order.
 237 @Returns: @val converted to big-endian byte order.
 238
 239 <!-- ##### MACRO GINT_TO_LE ##### -->
 240 <para>
 241 Converts a #gint value from host byte order to little-endian.
 242 </para>
 243
 244 @val: a #gint value in host byte order.
 245 @Returns: @val converted to little-endian byte order.
 246
 247 <!-- ##### MACRO GINT_TO_POINTER ##### -->
 248 <para>
 249 Stuffs an integer into a pointer type.
 250 </para>
 251 <para>
 252 Remember, YOU MAY NOT STORE POINTERS IN INTEGERS. THIS IS NOT PORTABLE
 253 IN ANY WAY SHAPE OR FORM. These macros <emphasis>ONLY</emphasis> allow
 254 storing integers in pointers, and only preserve 32 bits of the
 255 integer; values outside the range of a 32-bit integer will be mangled.
 256 </para>
 257
 258 @i: integer to stuff into a pointer.
 259
 260 <!-- ##### ENUM GIOFileMode ##### -->
 261 <para>
 262
 263 </para>
 264
 265 @G_IO_FILE_MODE_READ:
 266 @G_IO_FILE_MODE_WRITE:
 267 @G_IO_FILE_MODE_APPEND:
 268 @G_IO_FILE_MODE_READ_WRITE:
 269 @G_IO_FILE_MODE_READ_WRITE_TRUNCATE:
 270 @G_IO_FILE_MODE_READ_WRITE_APPEND:
 271
 272 <!-- ##### MACRO GLIB_MAJOR_VERSION ##### -->
 273 <para>
 274 The major version number of the GLib library.
 275 Like #glib_major_version, but from the headers used at
 276 application compile time, rather than from the library linked against
 277 at application run time.
 278 </para>
 279
 280
 281 <!-- ##### MACRO GLIB_MICRO_VERSION ##### -->
 282 <para>
 283 The micro version number of the GLib library.
 284 Like #gtk_micro_version, but from the headers used at
 285 application compile time, rather than from the library linked against
 286 at application run time.
 287 </para>
 288
 289
 290 <!-- ##### MACRO GLIB_MINOR_VERSION ##### -->
 291 <para>
 292 The minor version number of the GLib library.
 293 Like #gtk_minor_version, but from the headers used at
 294 application compile time, rather than from the library linked against
 295 at application run time.
 296 </para>
 297
 298
 299 <!-- ##### MACRO GLONG_TO_BE ##### -->
 300 <para>
 301 Converts a #glong value from host byte order to big-endian.
 302 </para>
 303
 304 @val: a #glong value in host byte order.
 305 @Returns: @val converted to big-endian byte order.
 306
 307 <!-- ##### MACRO GLONG_TO_LE ##### -->
 308 <para>
 309 Converts a #glong value from host byte order to little-endian.
 310 </para>
 311
 312 @val: a #glong value in host byte order.
 313 @Returns: @val converted to little-endian.
 314
 315 <!-- ##### ENUM GMatchType ##### -->
 316 <para>
 317 Enumeration representing different kinds of patterns. This is only used
 318 internally for optimizing the match algorithm.
 319 </para>
 320
 321 @G_MATCH_ALL: a general pattern.
 322 @G_MATCH_ALL_TAIL: a general pattern which contains a fixed part matching
 323 the end of the string.
 324 @G_MATCH_HEAD: a pattern matching every string with a certain prefix.
 325 @G_MATCH_TAIL: a pattern matching every string with a certain suffix.
 326 @G_MATCH_EXACT: a pattern matching exactly one string.
 327 @G_MATCH_LAST:
 328
 329 <!-- ##### STRUCT GModule ##### -->
 330 <para>
 331 The #GModule struct is an opaque data structure to represent a
 332 <link linkend="glib-Dynamic-Loading-of-Modules">Dynamically-Loaded Module</link>.
 333 It should only be accessed via the following functions.
 334 </para>
 335
 336
 337 <!-- ##### USER_FUNCTION GModuleCheckInit ##### -->
 338 <para>
 339 Specifies the type of the module initialization function.
 340 If a module contains a function named g_module_check_init() it is called
 341 automatically when the module is loaded. It is passed the #GModule structure
 342 and should return %NULL on success or a string describing the initialization
 343 error.
 344 </para>
 345
 346 @module: the #GModule corresponding to the module which has just been loaded.
 347 @Returns: %NULL on success, or a string describing the initialization error.
 348
 349 <!-- ##### ENUM GModuleFlags ##### -->
 350 <para>
 351 Flags passed to g_module_open(). Note that these flags are
 352 not supported on all platforms.
 353 </para>
 354
 355 @G_MODULE_BIND_LAZY: specifies that symbols are only resolved when needed.
 356   The default action is to bind all symbols when the module is loaded.
 357 @G_MODULE_BIND_LOCAL: specifies that symbols in the module should
 358   not be added to the global name space.  The default action on most
 359   platforms is to place symbols in the module in the global name space,
 360   which may cause conflicts with existing symbols.
 361 @G_MODULE_BIND_MASK: mask for all flags.
 362
 363 <!-- ##### USER_FUNCTION GModuleUnload ##### -->
 364 <para>
 365 Specifies the type of the module function called when it is unloaded.
 366 If a module contains a function named g_module_unload() it is called
 367 automatically when the module is unloaded.
 368 It is passed the #GModule structure.
 369 </para>
 370
 371 @module: the #GModule about to be unloaded.
 372
 373 <!-- ##### MACRO GPOINTER_TO_INT ##### -->
 374 <para>
 375 Extracts an integer from a pointer. The integer must have
 376 been stored in the pointer with GINT_TO_POINTER().
 377 </para>
 378 <para>
 379 Remember, YOU MAY NOT STORE POINTERS IN INTEGERS. THIS IS NOT PORTABLE
 380 IN ANY WAY SHAPE OR FORM. These macros <emphasis>ONLY</emphasis> allow
 381 storing integers in pointers, and only preserve 32 bits of the
 382 integer; values outside the range of a 32-bit integer will be mangled.
 383 </para>
 384
 385 @p: pointer containing an integer.
 386
 387 <!-- ##### MACRO GPOINTER_TO_UINT ##### -->
 388 <para>
 389 Extracts an unsigned integer from a pointer. The integer must have
 390 been stored in the pointer with GUINT_TO_POINTER().
 391 </para>
 392
 393 @p: pointer to extract an unsigned integer from.
 394
 395 <!-- ##### TYPEDEF GPid ##### -->
 396 <para>
 397 A type which is used to hold a process identification.
 398 On Unix, processes are identified by a process id (an
 399 integer), while Windows uses process handles (which are
 400 pointers).
 401 </para>
 402
 403
 404 <!-- ##### MACRO GUINT16_TO_BE ##### -->
 405 <para>
 406 Converts a #guint16 value from host byte order to big-endian.
 407 </para>
 408
 409 @val: a #guint16 value in host byte order.
 410 @Returns: @val converted to big-endian.
 411
 412 <!-- ##### MACRO GUINT16_TO_LE ##### -->
 413 <para>
 414 Converts a #guint16 value from host byte order to little-endian.
 415 </para>
 416
 417 @val: a #guint16 value in host byte order.
 418 @Returns: @val converted to little-endian.
 419
 420 <!-- ##### MACRO GUINT32_TO_BE ##### -->
 421 <para>
 422 Converts a #guint32 value from host byte order to big-endian.
 423 </para>
 424
 425 @val: a #guint32 value in host byte order.
 426 @Returns: @val converted to big-endian.
 427
 428 <!-- ##### MACRO GUINT32_TO_LE ##### -->
 429 <para>
 430 Converts a #guint32 value from host byte order to little-endian.
 431 </para>
 432
 433 @val: a #guint32 value in host byte order.
 434 @Returns: @val converted to little-endian.
 435
 436 <!-- ##### MACRO GUINT64_TO_BE ##### -->
 437 <para>
 438 Converts a #guint64 value from host byte order to big-endian.
 439 </para>
 440
 441 @val: a #guint64 value in host byte order.
 442 @Returns: @val converted to big-endian.
 443
 444 <!-- ##### MACRO GUINT64_TO_LE ##### -->
 445 <para>
 446 Converts a #guint64 value from host byte order to little-endian.
 447 </para>
 448
 449 @val: a #guint64 value in host byte order.
 450 @Returns: @val converted to little-endian.
 451
 452 <!-- ##### MACRO GUINT_TO_BE ##### -->
 453 <para>
 454 Converts a #guint value from host byte order to big-endian.
 455 </para>
 456
 457 @val: a #guint value in host byte order.
 458 @Returns: @val converted to big-endian byte order.
 459
 460 <!-- ##### MACRO GUINT_TO_LE ##### -->
 461 <para>
 462 Converts a #guint value from host byte order to little-endian.
 463 </para>
 464
 465 @val: a #guint value in host byte order.
 466 @Returns: @val converted to little-endian byte order.
 467
 468 <!-- ##### MACRO GUINT_TO_POINTER ##### -->
 469 <para>
 470 Stuffs an unsigned integer into a pointer type.
 471 </para>
 472
 473 @u: unsigned integer to stuff into the pointer.
 474
 475 <!-- ##### MACRO GULONG_TO_BE ##### -->
 476 <para>
 477 Converts a #gulong value from host byte order to big-endian.
 478 </para>
 479
 480 @val: a #gulong value in host byte order.
 481 @Returns: @val converted to big-endian.
 482
 483 <!-- ##### MACRO GULONG_TO_LE ##### -->
 484 <para>
 485 Converts a #gulong value from host byte order to little-endian.
 486 </para>
 487
 488 @val: a #gulong value in host byte order.
 489 @Returns: @val converted to little-endian.
 490
 491 <!-- ##### USER_FUNCTION GWarningFunc ##### -->
 492 <para>
 493 Specifies the type of function passed to g_set_warning_handler().
 494 </para>
 495
 496 @str: the warning message.
 497
 498 <!-- ##### MACRO G_BYTE_ORDER ##### -->
 499 <para>
 500 The host byte order.
 501 This can be either #G_LITTLE_ENDIAN or #G_BIG_ENDIAN (support for
 502 #G_PDP_ENDIAN may be added in future.)
 503 </para>
 504
 505
 506 <!-- ##### MACRO G_CHANNEL_ERROR ##### -->
 507 <para>
 508
 509 </para>
 510
 511
 512 <!-- ##### MACRO G_DESKTOP_ENTRY_ERROR ##### -->
 513 <para>
 514 Error domain for desktop entry parsing. Errors in this domain will
 515 be from the #GDesktopEntryError enumeration. See #GError for information on
 516 error domains.
 517 </para>
 518
 519
 520 <!-- ##### MACRO G_GINT16_FORMAT ##### -->
 521 <para>
 522 This is the platform dependent conversion specifier for scanning and
 523 printing values of type #gint16. It is a string literal, but doesn't
 524 include the percent-sign, such that you can add precision and length
 525 modifiers between percent-sign and conversion specifier.
 526 </para>
 527
 528 <para>
 529 <informalexample>
 530 <programlisting>
 531 gint16 in;
 532 gint32 out;
 533 sscanf ("42", "%" G_GINT16_FORMAT, &amp;in)
 534 out = in * 1000;
 535 g_print ("%" G_GINT32_FORMAT, out);
 536 </programlisting>
 537 </informalexample>
 538 </para>
 539
 540
 541 <!-- ##### MACRO G_GINT16_MODIFIER ##### -->
 542 <para>
 543 The platform dependent length modifier for constructing printf() conversion
 544 specifiers for values of type #gint16 or #guint16. It is a string literal,
 545 but doesn't include the percent-sign, such that you can add precision and
 546 length modifiers between percent-sign and conversion specifier and append a
 547 conversion specifier.
 548 </para>
 549
 550 <para>
 551 The following example prints "0x7b";
 552 <informalexample>
 553 <programlisting>
 554 gint16 value = 123;
 555 g_print ("%#" G_GINT16_MODIFIER "x", value);
 556 </programlisting>
 557 </informalexample>
 558 </para>
 559
 560 @Since: 2.4
 561
 562 <!-- ##### MACRO G_GINT32_FORMAT ##### -->
 563 <para>
 564 This is the platform dependent conversion specifier for scanning and
 565 printing values of type #gint32. See also #G_GINT16_FORMAT.
 566 </para>
 567
 568
 569 <!-- ##### MACRO G_GINT32_MODIFIER ##### -->
 570 <para>
 571 The platform dependent length modifier for constructing printf() conversion
 572 specifiers for values of type #gint32 or #guint32. See also #G_GINT16_MODIFIER.
 573 </para>
 574
 575 @Since: 2.4
 576
 577 <!-- ##### MACRO G_GINT64_CONSTANT ##### -->
 578 <para>
 579 This macro is used to insert 64-bit integer literals into the source code.
 580 </para>
 581
 582 @val: a literal integer value, e.g. 0x1d636b02300a7aa7U.
 583
 584 <!-- ##### MACRO G_GINT64_FORMAT ##### -->
 585 <para>
 586 This is the platform dependent conversion specifier for scanning and
 587 printing values of type #gint64. See also #G_GINT16_FORMAT.
 588 </para>
 589
 590 <note>
 591 <para>
 592 Some platforms do not support scanning and printing 64 bit integers,
 593 even though the types are supported. On such platforms #G_GINT64_FORMAT
 594 is not defined. Note that scanf() may not support 64 bit integers, even
 595 if #G_GINT64_FORMAT is defined. Due to its weak error handling, scanf() is not
 596 recommended for parsing anyway; consider using g_strtoull() instead.
 597 </para>
 598 </note>
 599
 600
 601 <!-- ##### MACRO G_GINT64_MODIFIER ##### -->
 602 <para>
 603 The platform dependent length modifier for constructing printf() conversion
 604 specifiers for values of type #gint64 or #guint64. See also #G_GINT16_MODIFIER.
 605 </para>
 606
 607 <note>
 608 <para>
 609 Some platforms do not support printing 64 bit integers,
 610 even though the types are supported. On such platforms #G_GINT64_MODIFIER
 611 is not defined.
 612 </para>
 613 </note>
 614
 615 @Since: 2.4
 616
 617 <!-- ##### MACRO G_GNUC_INTERNAL ##### -->
 618 <para>
 619 This attribute can be used for marking library functions as being used
 620 internally to the library only, which may allow the compiler to handle
 621 function calls more efficiently.
 622 Note that static functions do not need to be marked as internal in this way.
 623 See the GNU C documentation for details.
 624 </para>
 625 <para>
 626 When using a compiler that supports the GNU C hidden visibility attribute,
 627 this macro expands to <literal>__attribute__((visibility("hidden")))</literal>.
 628 When using the Sun Studio compiler, it expands to <literal>__hidden</literal>.
 629 </para>
 630 <para>
 631 Note that for portability, the attribute should be placed before the
 632 function declaration. While GCC allows the macro after the declaration,
 633 Sun Studio does not.
 634 </para>
 635 <informalexample><programlisting>
 636 G_GNUC_INTERNAL
 637 void _g_log_fallback_handler (const gchar    *log_domain,
 638                               GLogLevelFlags  log_level,
 639                               const gchar    *message,
 640                               gpointer        unused_data);
 641 </programlisting></informalexample>
 642
 643 Since: 2.6
 644
 645
 646 <!-- ##### MACRO G_GSIZE_FORMAT ##### -->
 647 <para>
 648 This is the platform dependent conversion specifier for scanning and
 649 printing values of type #gsize. See also #G_GINT16_FORMAT.
 650 </para>
 651
 652 @Since: 2.6
 653
 654 <!-- ##### MACRO G_GSIZE_MODIFIER ##### -->
 655 <para>
 656 The platform dependent length modifier for constructing printf() conversion
 657 specifiers for values of type #gsize or #gssize. See also #G_GINT16_MODIFIER.
 658 </para>
 659
 660 @Since: 2.6
 661
 662 <!-- ##### MACRO G_GSSIZE_FORMAT ##### -->
 663 <para>
 664 This is the platform dependent conversion specifier for scanning and
 665 printing values of type #gssize. See also #G_GINT16_FORMAT.
 666 </para>
 667
 668 @Since: 2.6
 669
 670 <!-- ##### MACRO G_GUINT16_FORMAT ##### -->
 671 <para>
 672 This is the platform dependent conversion specifier for scanning and
 673 printing values of type #guint16. See also #G_GINT16_FORMAT.
 674 </para>
 675
 676
 677 <!-- ##### MACRO G_GUINT32_FORMAT ##### -->
 678 <para>
 679 This is the platform dependent conversion specifier for scanning and
 680 printing values of type #guint32. See also #G_GINT16_FORMAT.
 681 </para>
 682
 683
 684 <!-- ##### MACRO G_GUINT64_CONSTANT ##### -->
 685 <para>
 686 This macro is used to insert 64-bit unsigned integer literals into the
 687 source code.
 688 </para>
 689
 690 @val: a literal integer value, e.g. 0x1d636b02300a7aa7U.
 691 @Since: 2.10
 692
 693 <!-- ##### MACRO G_GUINT64_FORMAT ##### -->
 694 <para>
 695 This is the platform dependent conversion specifier for scanning and
 696 printing values of type #guint64. See also #G_GINT16_FORMAT.
 697 </para>
 698
 699 <note>
 700 <para>
 701 Some platforms do not support scanning and printing 64 bit integers,
 702 even though the types are supported. On such platforms #G_GUINT64_FORMAT
 703 is not defined.  Note that scanf() may not support 64 bit integers, even
 704 if #G_GINT64_FORMAT is defined. Due to its weak error handling, scanf() is not
 705 recommended for parsing anyway; consider using g_strtoull() instead.
 706 </para>
 707 </note>
 708
 709
 710 <!-- ##### MACRO G_HAVE_GINT64 ##### -->
 711 <para>
 712 This macro is defined if 64-bit signed and unsigned integers are available
 713 on the platform.
 714 </para>
 715
 716 @Deprecated: GLib requires 64-bit integer support since version 2.0, therefore
 717 %G_HAVE_GINT64 is <emphasis>always</emphasis> defined.
 718
 719 <!-- ##### MACRO G_HAVE_GNUC_VISIBILITY ##### -->
 720 <para>
 721 This macro is defined as 1 if the compiler supports ELF visibility
 722 attributes (currently only <command>gcc</command>).
 723 </para>
 724
 725 Since: 2.6
 726
 727
 728 <!-- ##### MACRO G_HOOK_DEFERRED_DESTROY ##### -->
 729 <para>
 730
 731 </para>
 732
 733
 734 <!-- ##### MACRO G_IO_CHANNEL_DEFAULT_LINE_TERM ##### -->
 735 <para>
 736 One of %G_IO_CHANNEL_UNIX_LINE_TERM, %G_IO_CHANNEL_DOS_LINE_TERM,
 737 or %G_IO_CHANNEL_MACINTOSH_LINE_TERM (unimplemented)
 738 depending on the system type.
 739 </para>
 740
 741
 742 <!-- ##### MACRO G_IO_CHANNEL_DOS_LINE_TERM ##### -->
 743 <para>
 744
 745 </para>
 746
 747
 748 <!-- ##### MACRO G_IO_CHANNEL_ENCODE_RAW ##### -->
 749 <para>
 750 Encoding for nonbuffered IO. With this encoding, data must be
 751 read using g_io_channel_read_chars(); the other functions will
 752 not work.
 753 </para>
 754
 755
 756 <!-- ##### MACRO G_IO_CHANNEL_MACINTOSH_LINE_TERM ##### -->
 757 <para>
 758
 759 </para>
 760
 761
 762 <!-- ##### MACRO G_IO_CHANNEL_UNIX_LINE_TERM ##### -->
 763 <para>
 764
 765 </para>
 766
 767
 768 <!-- ##### MACRO G_MAXDOUBLE ##### -->
 769 <para>
 770 The maximum value which can be held in a #gdouble.
 771 </para>
 772
 773
 774 <!-- ##### MACRO G_MAXFLOAT ##### -->
 775 <para>
 776 The maximum value which can be held in a #gfloat.
 777 </para>
 778
 779
 780 <!-- ##### MACRO G_MAXINT ##### -->
 781 <para>
 782 The maximum value which can be held in a #gint.
 783 </para>
 784
 785
 786 <!-- ##### MACRO G_MAXLONG ##### -->
 787 <para>
 788 The maximum value which can be held in a #glong.
 789 </para>
 790
 791
 792 <!-- ##### MACRO G_MAXOFFSET ##### -->
 793 <para>
 794 The maximum value which can be held in a #goffset.
 795 </para>
 796
 797
 798 <!-- ##### MACRO G_MAXSHORT ##### -->
 799 <para>
 800 The maximum value which can be held in a #gshort.
 801 </para>
 802
 803
 804 <!-- ##### MACRO G_MAXSIZE ##### -->
 805 <para>
 806 The maximum value which can be held in a #gsize.
 807 </para>
 808
 809 @Since: 2.4
 810
 811 <!-- ##### MACRO G_MAXSSIZE ##### -->
 812 <para>
 813 The maximum value which can be held in a #gssize.
 814 </para>
 815
 816 @Since: 2.14
 817
 818 <!-- ##### MACRO G_MAXUINT ##### -->
 819 <para>
 820 The maximum value which can be held in a #guint.
 821 </para>
 822
 823
 824 <!-- ##### MACRO G_MAXULONG ##### -->
 825 <para>
 826 The maximum value which can be held in a #gulong.
 827 </para>
 828
 829
 830 <!-- ##### MACRO G_MAXUSHORT ##### -->
 831 <para>
 832 The maximum value which can be held in a #gushort.
 833 </para>
 834
 835
 836 <!-- ##### MACRO G_MINDOUBLE ##### -->
 837 <para>
 838 The minimum positive value which can be held in a #gdouble.
 839 </para>
 840 <para>
 841 If you are interested in the smallest value which can be held in a #gdouble,
 842 use -G_MAXDOUBLE.
 843 </para>
 844
 845
 846 <!-- ##### MACRO G_MINFLOAT ##### -->
 847 <para>
 848 The minimum positive value which can be held in a #gfloat.
 849 </para>
 850 <para>
 851 If you are interested in the smallest value which can be held in a #gfloat,
 852 use -G_MAX_FLOAT.
 853 </para>
 854
 855
 856 <!-- ##### MACRO G_MININT ##### -->
 857 <para>
 858 The minimum value which can be held in a #gint.
 859 </para>
 860
 861
 862 <!-- ##### MACRO G_MINLONG ##### -->
 863 <para>
 864 The minimum value which can be held in a #glong.
 865 </para>
 866
 867
 868 <!-- ##### MACRO G_MINOFFSET ##### -->
 869 <para>
 870 The minimum value which can be held in a #goffset.
 871 </para>
 872
 873
 874 <!-- ##### MACRO G_MINSHORT ##### -->
 875 <para>
 876 The minimum value which can be held in a #gshort.
 877 </para>
 878
 879
 880 <!-- ##### MACRO G_MINSSIZE ##### -->
 881 <para>
 882 The minimum value which can be held in a #gssize.
 883 </para>
 884
 885 @Since: 2.14
 886
 887 <!-- ##### MACRO G_MODULE_EXPORT ##### -->
 888 <para>
 889 Used to declare functions exported by modules. This is a no-op on Linux and
 890 Unices, but when compiling for Windows, it marks a symbol to be exported from
 891 the library or executable being built.
 892 </para>
 893
 894
 895 <!-- ##### MACRO G_MODULE_IMPORT ##### -->
 896 <para>
 897 Used to declare functions imported from modules.
 898 </para>
 899
 900
 901 <!-- ##### MACRO G_MODULE_SUFFIX ##### -->
 902 <para>
 903 Expands to the proper shared library suffix for the current platform
 904 without the leading dot. For the most Unices and Linux this is "so",
 905 for some HP-UX versions this is "sl" and for Windows this is "dll".
 906 </para>
 907
 908
 909 <!-- ##### MACRO G_THREADS_ENABLED ##### -->
 910
 911 <para>
 912 This macro is defined if GLib was compiled with thread support. This
 913 does not necessarily mean that there is a thread implementation
 914 available, but it does mean that the infrastructure is in place and
 915 that once you provide a thread implementation to g_thread_init(), GLib
 916 will be multi-thread safe. If #G_THREADS_ENABLED is not defined, then
 917 Glib is not, and cannot be, multi-thread safe.
 918 </para>
 919
 920
 921 <!-- ##### MACRO NAME_MAX ##### -->
 922 <para>
 923 Provided for UNIX emulation on Windows; equivalent to UNIX macro
 924 %NAME_MAX, which is the maximum length of a single path component.
 925 i.e. just the <filename>foo</filename> in <filename>/usr/bin/foo</filename>.
 926 </para>
 927
 928
 929 <!-- ##### MACRO _ ##### -->
 930 <para>
 931 Marks a string for translation, gets replaced with the translated string
 932 at runtime.
 933 </para>
 934
 935 @String: the string to be translated
 936 @Since: 2.4
 937
 938 <!-- ##### MACRO access ##### -->
 939 <para>
 940
 941 </para>
 942
 943
 944 <!-- ##### MACRO close ##### -->
 945 <para>
 946
 947 </para>
 948
 949
 950 <!-- ##### FUNCTION closedir ##### -->
 951 <para>
 952 Provided for UNIX emulation on Windows; see documentation for <function>closedir()</function>
 953 in any UNIX manual.
 954 </para>
 955
 956 @Param1:
 957 @Returns:
 958
 959 <!-- ##### MACRO fdopen ##### -->
 960 <para>
 961
 962 </para>
 963
 964
 965 <!-- ##### MACRO ftruncate ##### -->
 966 <para>
 967 Provided for UNIX emulation on Windows; see documentation for ftruncate()
 968 in any UNIX manual.
 969 </para>
 970
 971 @fd:
 972 @size:
 973
 974 <!-- ##### FUNCTION g_channel_error_from_errno ##### -->
 975 <para>
 976
 977 </para>
 978
 979 @en:
 980 @Returns:
 981
 982 <!-- ##### FUNCTION g_channel_error_quark ##### -->
 983 <para>
 984
 985 </para>
 986
 987 @Returns:
 988
 989 <!-- ##### FUNCTION g_convert_error_quark ##### -->
 990 <para>
 991
 992 </para>
 993
 994 @Returns:
 995
 996 <!-- ##### FUNCTION g_desktop_entry_escape_strings ##### -->
 997 <para>
 998
 999 </para>
1000
1001 @entry:
1002 @should_escape:
1003
1004 <!-- ##### FUNCTION g_desktop_entry_free ##### -->
1005 <para>
1006
1007 </para>
1008
1009 @entry:
1010
1011 <!-- ##### FUNCTION g_desktop_entry_get_boolean ##### -->
1012 <para>
1013
1014 </para>
1015
1016 @entry:
1017 @group_name:
1018 @key:
1019 @error:
1020 @Returns:
1021
1022 <!-- ##### FUNCTION g_desktop_entry_get_boolean_list ##### -->
1023 <para>
1024
1025 </para>
1026
1027 @entry:
1028 @group_name:
1029 @key:
1030 @length:
1031 @error:
1032 @Returns:
1033
1034 <!-- ##### FUNCTION g_desktop_entry_get_groups ##### -->
1035 <para>
1036
1037 </para>
1038
1039 @entry:
1040 @length:
1041 @Returns:
1042
1043 <!-- ##### FUNCTION g_desktop_entry_get_integer ##### -->
1044 <para>
1045
1046 </para>
1047
1048 @entry:
1049 @group_name:
1050 @key:
1051 @error:
1052 @Returns:
1053
1054 <!-- ##### FUNCTION g_desktop_entry_get_integer_list ##### -->
1055 <para>
1056
1057 </para>
1058
1059 @entry:
1060 @group_name:
1061 @key:
1062 @length:
1063 @error:
1064 @Returns:
1065
1066 <!-- ##### FUNCTION g_desktop_entry_get_keys ##### -->
1067 <para>
1068
1069 </para>
1070
1071 @entry:
1072 @group_name:
1073 @length:
1074 @error:
1075 @Returns:
1076
1077 <!-- ##### FUNCTION g_desktop_entry_get_locale_string ##### -->
1078 <para>
1079
1080 </para>
1081
1082 @entry:
1083 @group_name:
1084 @key:
1085 @locale:
1086 @error:
1087 @Returns:
1088
1089 <!-- ##### FUNCTION g_desktop_entry_get_locale_string_list ##### -->
1090 <para>
1091
1092 </para>
1093
1094 @entry:
1095 @group_name:
1096 @key:
1097 @locale:
1098 @length:
1099 @error:
1100 @Returns:
1101
1102 <!-- ##### FUNCTION g_desktop_entry_get_start_group ##### -->
1103 <para>
1104
1105 </para>
1106
1107 @entry:
1108 @Returns:
1109
1110 <!-- ##### FUNCTION g_desktop_entry_get_string ##### -->
1111 <para>
1112
1113 </para>
1114
1115 @entry:
1116 @group_name:
1117 @key:
1118 @error:
1119 @Returns:
1120
1121 <!-- ##### FUNCTION g_desktop_entry_get_string_list ##### -->
1122 <para>
1123
1124 </para>
1125
1126 @entry:
1127 @group_name:
1128 @key:
1129 @length:
1130 @error:
1131 @Returns:
1132
1133 <!-- ##### FUNCTION g_desktop_entry_has_group ##### -->
1134 <para>
1135
1136 </para>
1137
1138 @entry:
1139 @group_name:
1140 @Returns:
1141
1142 <!-- ##### FUNCTION g_desktop_entry_has_key ##### -->
1143 <para>
1144
1145 </para>
1146
1147 @entry:
1148 @group_name:
1149 @key:
1150 @error:
1151 @Returns:
1152
1153 <!-- ##### FUNCTION g_desktop_entry_new ##### -->
1154 <para>
1155
1156 </para>
1157
1158 @flags:
1159 @error:
1160 @Returns:
1161
1162 <!-- ##### FUNCTION g_desktop_entry_new_from_data ##### -->
1163 <para>
1164
1165 </para>
1166
1167 @data:
1168 @length:
1169 @legal_start_groups:
1170 @flags:
1171 @error:
1172 @Returns:
1173
1174 <!-- ##### FUNCTION g_desktop_entry_new_from_data_dirs ##### -->
1175 <para>
1176
1177 </para>
1178
1179 @file:
1180 @full_path:
1181 @legal_start_groups:
1182 @flags:
1183 @error:
1184 @Returns:
1185
1186 <!-- ##### FUNCTION g_desktop_entry_new_from_file ##### -->
1187 <para>
1188
1189 </para>
1190
1191 @file:
1192 @legal_start_groups:
1193 @flags:
1194 @error:
1195 @Returns:
1196
1197 <!-- ##### FUNCTION g_desktop_entry_remove_group ##### -->
1198 <para>
1199
1200 </para>
1201
1202 @entry:
1203 @group_name:
1204 @error:
1205
1206 <!-- ##### FUNCTION g_desktop_entry_remove_key ##### -->
1207 <para>
1208
1209 </para>
1210
1211 @entry:
1212 @group_name:
1213 @key:
1214 @error:
1215
1216 <!-- ##### FUNCTION g_desktop_entry_set_boolean ##### -->
1217 <para>
1218
1219 </para>
1220
1221 @entry:
1222 @group_name:
1223 @key:
1224 @boolean:
1225 @error:
1226
1227 <!-- ##### FUNCTION g_desktop_entry_set_boolean_list ##### -->
1228 <para>
1229
1230 </para>
1231
1232 @entry:
1233 @group_name:
1234 @key:
1235 @list:
1236 @length:
1237 @error:
1238
1239 <!-- ##### FUNCTION g_desktop_entry_set_integer ##### -->
1240 <para>
1241
1242 </para>
1243
1244 @entry:
1245 @group_name:
1246 @key:
1247 @integer:
1248 @error:
1249
1250 <!-- ##### FUNCTION g_desktop_entry_set_integer_list ##### -->
1251 <para>
1252
1253 </para>
1254
1255 @entry:
1256 @group_name:
1257 @key:
1258 @list:
1259 @length:
1260 @error:
1261
1262 <!-- ##### FUNCTION g_desktop_entry_set_locale_string ##### -->
1263 <para>
1264
1265 </para>
1266
1267 @entry:
1268 @group_name:
1269 @key:
1270 @locale:
1271 @string:
1272 @error:
1273
1274 <!-- ##### FUNCTION g_desktop_entry_set_locale_string_list ##### -->
1275 <para>
1276
1277 </para>
1278
1279 @entry:
1280 @group_name:
1281 @key:
1282 @locale:
1283 @list:
1284 @length:
1285 @error:
1286
1287 <!-- ##### FUNCTION g_desktop_entry_set_string ##### -->
1288 <para>
1289
1290 </para>
1291
1292 @entry:
1293 @group_name:
1294 @key:
1295 @string:
1296 @error:
1297
1298 <!-- ##### FUNCTION g_desktop_entry_set_string_list ##### -->
1299 <para>
1300
1301 </para>
1302
1303 @entry:
1304 @group_name:
1305 @key:
1306 @list:
1307 @length:
1308 @error:
1309
1310 <!-- ##### FUNCTION g_desktop_entry_to_data ##### -->
1311 <para>
1312
1313 </para>
1314
1315 @entry:
1316 @length:
1317 @error:
1318 @Returns:
1319
1320 <!-- ##### FUNCTION g_file_replace ##### -->
1321 <para>
1322
1323 </para>
1324
1325 @filename:
1326 @contents:
1327 @length:
1328 @error:
1329 @Returns:
1330
1331 <!-- ##### FUNCTION g_format_file_size_for_display ##### -->
1332 <para>
1333
1334 </para>
1335
1336 @size:
1337 @Returns:
1338
1339 <!-- ##### FUNCTION g_io_channel_error_quark ##### -->
1340 <para>
1341
1342 </para>
1343
1344 @Returns:
1345
1346 <!-- ##### VARIABLE g_log_domain_glib ##### -->
1347 <para>
1348 The log domain used for messages logged by GLib itself.
1349 </para>
1350
1351
1352 <!-- ##### FUNCTION g_main_add_poll ##### -->
1353 <para>
1354 Adds a file descriptor to be polled.
1355 This is usually combined with g_source_add() to add an event source.
1356 The event source's check function will typically test the revents
1357 field in the #GPollFD struct and return TRUE if events need to be processed.
1358 </para>
1359
1360 @fd: a #GPollFD, which is a file descriptor together with a bitwise
1361 combination of #GIOCondition flags determining which events to poll for.
1362 @priority: the priority of the poll, which should be the same as the priority
1363 used for g_source_add() to ensure that the file descriptor is polled whenever
1364 the results may be needed.
1365 See #G_PRIORITY_DEFAULT, #G_PRIORITY_DEFAULT_IDLE, #G_PRIORITY_HIGH,
1366 #G_PRIORITY_HIGH_IDLE, and #G_PRIORITY_LOW.
1367
1368 <!-- ##### FUNCTION g_main_context_get ##### -->
1369 <para>
1370
1371 </para>
1372
1373 @thread:
1374 @Returns:
1375
1376 <!-- ##### FUNCTION g_main_loop_destroy ##### -->
1377 <para>
1378
1379 </para>
1380
1381 @loop:
1382
1383 <!-- ##### FUNCTION g_main_remove_poll ##### -->
1384 <para>
1385 Removes a file descriptor from the list being polled.
1386 </para>
1387
1388 @fd: the #GPollFD to remove.
1389
1390 <!-- ##### FUNCTION g_main_win32_get_poll_func ##### -->
1391 <para>
1392
1393 </para>
1394
1395 @Returns:
1396
1397 <!-- ##### FUNCTION g_mem_check ##### -->
1398 <para>
1399 Checks if the given memory has already been freed. If it has it outputs
1400 a warning message.
1401 To use this function you must configure glib with the flag
1402 '--enable-mem-check=yes' before compiling.
1403 </para>
1404
1405 @mem: the memory to check.
1406
1407 <!-- ##### MACRO g_memmove ##### -->
1408 <para>
1409
1410 </para>
1411
1412 @dest:
1413 @src:
1414 @len:
1415
1416 <!-- ##### FUNCTION g_module_build_path ##### -->
1417 <para>
1418 A portable way to build the filename of a module. The platform-specific
1419 prefix and suffix are added to the filename, if needed, and the result is
1420 added to the directory, using the correct separator character.
1421 </para>
1422 <para>
1423 The directory should specify the directory where the module can be found.
1424 It can be %NULL or an empty string to indicate that the module is in a standard
1425 platform-specific directory, though this is not recommended since the
1426 wrong module may be found.
1427 </para>
1428 <para>
1429 For example, calling g_module_build_path() on a Linux system with a @directory
1430 of <filename>/lib</filename> and a @module_name of "mylibrary" will return
1431 <filename>/lib/libmylibrary.so</filename>. On a Windows system, using
1432 <filename>\Windows</filename> as the directory it will return
1433 <filename>\Windows\mylibrary.dll</filename>.
1434 </para>
1435
1436 @directory: the directory where the module is. This can be %NULL or the empty
1437 string to indicate that the standard platform-specific directories will be
1438 used, though that is not recommended.
1439 @module_name: the name of the module.
1440 @Returns: the complete path of the module, including the standard library
1441 prefix and suffix. This should be freed when no longer needed.
1442
1443 <!-- ##### FUNCTION g_module_close ##### -->
1444 <para>
1445 Closes a module.
1446 </para>
1447
1448 @module: a #GModule to close.
1449 @Returns: %TRUE on success.
1450
1451 <!-- ##### FUNCTION g_module_error ##### -->
1452 <para>
1453 Gets a string describing the last module error.
1454 </para>
1455
1456 @Returns: a string describing the last module error.
1457
1458 <!-- ##### FUNCTION g_module_make_resident ##### -->
1459 <para>
1460 Ensures that a module will never be unloaded.
1461 Any future g_module_close() calls on the module will be ignored.
1462 </para>
1463
1464 @module: a #GModule to make permanently resident.
1465
1466 <!-- ##### FUNCTION g_module_name ##### -->
1467 <para>
1468 Gets the filename from a #GModule.
1469 </para>
1470
1471 @module: a #GModule.
1472 @Returns: the filename of the module, or "main" if the module is the main
1473 program itself.
1474
1475 <!-- ##### FUNCTION g_module_open ##### -->
1476 <para>
1477 Opens a module. If the module has already been opened, its reference
1478 count is incremented.
1479 </para>
1480
1481 <para>
1482 First of all g_module_open() tries to open @file_name as a module. If
1483 that fails and @file_name has the ".la"-suffix (and is a libtool archive)
1484 it tries to open the corresponding module. If that fails and it doesn't
1485 have the proper module suffix for the platform (#G_MODULE_SUFFIX), this
1486 suffix will be appended and the corresponding module will be opended. If
1487 that fails and @file_name doesn't have the ".la"-suffix, this suffix is
1488 appended and g_module_open() tries to open the corresponding module. If
1489 eventually that fails as well, %NULL is returned.
1490 </para>
1491
1492 @file_name: the name of the file containing the module, or %NULL to obtain
1493   a #GModule representing the main program itself.
1494 @flags: the flags used for opening the module. This can be the logical
1495 OR of any of the #GModuleFlags.
1496 @Returns: a #GModule on success, or %NULL on failure.
1497
1498 <!-- ##### FUNCTION g_module_supported ##### -->
1499 <para>
1500 Checks if modules are supported on the current platform.
1501 </para>
1502
1503 @Returns: %TRUE if modules are supported.
1504
1505 <!-- ##### FUNCTION g_module_symbol ##### -->
1506 <para>
1507 Gets a symbol pointer from a module, such as one exported by #G_MODULE_EXPORT.
1508 </para>
1509 <para>
1510 Note that a valid symbol can be %NULL.
1511 </para>
1512
1513 @module: a #GModule.
1514 @symbol_name: the name of the symbol to find.
1515 @symbol: returns the pointer to the symbol value.
1516 @Returns: %TRUE on success.
1517
1518 <!-- ##### FUNCTION g_regex_error_quark ##### -->
1519 <para>
1520
1521 </para>
1522
1523 @Returns:
1524
1525 <!-- ##### FUNCTION g_regex_free ##### -->
1526 <para>
1527
1528 </para>
1529
1530 @regex:
1531
1532 <!-- ##### FUNCTION g_scanner_stat_mode ##### -->
1533 <para>
1534 Gets the file attributes.
1535 This is the <structfield>st_mode</structfield> field from the
1536 <structname>stat</structname> structure. See the <function>stat()</function>
1537 documentation.
1538 </para>
1539
1540 @filename: the file name.
1541 @Returns: the file attributes.
1542
1543 <!-- ##### FUNCTION g_set_error_handler ##### -->
1544 <para>
1545 Sets the function to be called to handle error messages.
1546 This function is deprecated in favour of the new logging facilities.
1547 </para>
1548
1549 @func: the function to be called to handle error messages.
1550 @Returns: the old error handler.
1551
1552 <!-- ##### FUNCTION g_set_message_handler ##### -->
1553 <para>
1554 Sets the function to be called to handle messages.
1555 This function is deprecated in favour of the new logging facilities.
1556 </para>
1557
1558 @func: the function to be called to handle normal messages.
1559 @Returns: the old message handler.
1560
1561 <!-- ##### FUNCTION g_set_warning_handler ##### -->
1562 <para>
1563 Sets the function to be called to handle warning messages.
1564 This function is deprecated in favour of the new logging facilities.
1565 </para>
1566
1567 @func: the function to be called to handle warning messages.
1568 @Returns: the old warning handler.
1569
1570 <!-- ##### FUNCTION g_source_add ##### -->
1571 <para>
1572 </para>
1573
1574 @priority:
1575 @can_recurse:
1576 @funcs:
1577 @source_data:
1578 @user_data:
1579 @notify:
1580 @Returns:
1581 @source:
1582 @context:
1583
1584 <!-- ##### FUNCTION g_source_connect ##### -->
1585 <para>
1586
1587 </para>
1588
1589 @source:
1590 @func:
1591 @data:
1592 @notify:
1593
1594 <!-- ##### FUNCTION g_source_connect_indirect ##### -->
1595 <para>
1596
1597 </para>
1598
1599 @source:
1600 @callback_data:
1601 @callback_funcs:
1602
1603 <!-- ##### FUNCTION g_source_remove_by_source_data ##### -->
1604 <para>
1605 Removes the first event source found with the given source data.
1606 </para>
1607 <para>
1608 Event sources are sorted with the highest priority first. Sources with equal
1609 priority are stored in the order in which they were added.
1610 </para>
1611
1612 @source_data: the source data, which contains information specific to the
1613 type of source.
1614 @Returns: TRUE if an event source was found and removed.
1615
1616 <!-- ##### FUNCTION g_static_private_get_for_thread ##### -->
1617 <para>
1618
1619 </para>
1620
1621 @private_key:
1622 @thread:
1623 @Returns:
1624
1625 <!-- ##### FUNCTION g_static_private_set_for_thread ##### -->
1626 <para>
1627
1628 </para>
1629
1630 @private_key:
1631 @thread:
1632 @data:
1633 @notify:
1634
1635 <!-- ##### MACRO g_string ##### -->
1636 <para>
1637 Turns the argument into a string literal by using the '#' stringizing operator.
1638 </para>
1639
1640 @x: text to convert to a literal string.
1641
1642 <!-- ##### FUNCTION g_warn_message ##### -->
1643 <para>
1644
1645 </para>
1646
1647 @domain:
1648 @file:
1649 @line:
1650 @func:
1651 @warnexpr:
1652
1653 <!-- ##### MACRO getcwd ##### -->
1654 <para>
1655
1656 </para>
1657
1658
1659 <!-- ##### MACRO getpid ##### -->
1660 <para>
1661
1662 </para>
1663
1664
1665 <!-- ##### TYPEDEF gint16 ##### -->
1666 <para>
1667 A signed integer guaranteed to be 16 bits on all platforms.
1668 Values of this type can range from -32,768 to 32,767.
1669 </para>
1670
1671
1672 <!-- ##### TYPEDEF gint32 ##### -->
1673 <para>
1674 A signed integer guaranteed to be 32 bits on all platforms.
1675 Values of this type can range from -2,147,483,648 to 2,147,483,647.
1676 </para>
1677
1678
1679 <!-- ##### TYPEDEF gint64 ##### -->
1680 <para>
1681 A signed integer guaranteed to be 64 bits on all platforms.
1682 Values of this type can range from -9,223,372,036,854,775,808 to
1683 9,223,372,036,854,775,807.
1684 </para>
1685
1686
1687 <!-- ##### TYPEDEF gint8 ##### -->
1688 <para>
1689 A signed integer guaranteed to be 8 bits on all platforms.
1690 Values of this type can range from -128 to 127.
1691 </para>
1692
1693
1694 <!-- ##### TYPEDEF goffset ##### -->
1695 <para>
1696 A signed integer type that is used for file offsets, corresponding to the
1697 C99 type off64_t.
1698 </para>
1699
1700 Since: 2.14
1701
1702
1703 <!-- ##### TYPEDEF gsize ##### -->
1704 <para>
1705 An unsigned integer type of the result of the sizeof operator, corresponding
1706 to the size_t type defined in C99. This type is wide enough to hold the numeric
1707 value of a pointer, so it is usually 32bit wide on a 32bit platform and
1708 64bit wide on a 64bit platform.
1709 </para>
1710
1711
1712 <!-- ##### TYPEDEF gssize ##### -->
1713 <para>
1714 A signed variant of gsize, corresponding to the ssize_t defined on most platforms.
1715 </para>
1716
1717
1718 <!-- ##### TYPEDEF guint16 ##### -->
1719 <para>
1720 An unsigned integer guaranteed to be 16 bits on all platforms.
1721 Values of this type can range from 0 to 65,535.
1722 </para>
1723
1724
1725 <!-- ##### TYPEDEF guint32 ##### -->
1726 <para>
1727 An unsigned integer guaranteed to be 32 bits on all platforms.
1728 Values of this type can range from 0 to 4,294,967,295.
1729 </para>
1730
1731
1732 <!-- ##### TYPEDEF guint8 ##### -->
1733 <para>
1734 An unsigned integer guaranteed to be 8 bits on all platforms.
1735 Values of this type can range from 0 to 255.
1736 </para>
1737
1738
1739 <!-- ##### MACRO lseek ##### -->
1740 <para>
1741
1742 </para>
1743
1744
1745 <!-- ##### MACRO open ##### -->
1746 <para>
1747
1748 </para>
1749
1750
1751 <!-- ##### FUNCTION opendir ##### -->
1752 <para>
1753 Provided for UNIX emulation on Windows; see documentation for <function>opendir()</function>
1754 in any UNIX manual.
1755 </para>
1756
1757 @Param1:
1758 @Returns:
1759
1760 <!-- ##### MACRO pclose ##### -->
1761 <para>
1762
1763 </para>
1764
1765
1766 <!-- ##### MACRO pipe ##### -->
1767 <para>
1768 Provided for UNIX emulation on Windows; see documentation for pipe()
1769 in any UNIX manual.
1770 </para>
1771
1772 @phandles: file descriptors, the first one for reading, the second one for writing.
1773
1774 <!-- ##### MACRO popen ##### -->
1775 <para>
1776
1777 </para>
1778
1779
1780 <!-- ##### MACRO read ##### -->
1781 <para>
1782
1783 </para>
1784
1785
1786 <!-- ##### MACRO readdir ##### -->
1787 <para>
1788 Provided for UNIX emulation on Windows; see documentation for <function>readdir()</function>
1789 in any UNIX manual.
1790 </para>
1791
1792
1793 <!-- ##### FUNCTION rewinddir ##### -->
1794 <para>
1795 Provided for UNIX emulation on Windows; see documentation for <function>rewinddir()</function>
1796 in any UNIX manual.
1797 </para>
1798
1799 @Param1:
1800
1801 <!-- ##### MACRO write ##### -->
1802 <para>
1803
1804 </para>
1805
1806