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

   1 <!-- ##### ENUM GChannelError ##### -->
   2 <para>
   3
   4 </para>
   5
   6 @G_CHANNEL_ERROR_ACCES:
   7 @G_CHANNEL_ERROR_BADF:
   8 @G_CHANNEL_ERROR_DEADLK:
   9 @G_CHANNEL_ERROR_FAULT:
  10 @G_CHANNEL_ERROR_INVAL:
  11 @G_CHANNEL_ERROR_IO:
  12 @G_CHANNEL_ERROR_ISDIR:
  13 @G_CHANNEL_ERROR_MFILE:
  14 @G_CHANNEL_ERROR_NOLCK:
  15 @G_CHANNEL_ERROR_NOSPC:
  16 @G_CHANNEL_ERROR_PERM:
  17 @G_CHANNEL_ERROR_PIPE:
  18 @G_CHANNEL_ERROR_SPIPE:
  19 @G_CHANNEL_ERROR_ENCODE_RW:
  20 @G_CHANNEL_ERROR_FAILED:
  21
  22 <!-- ##### ENUM GChannelStatus ##### -->
  23 <para>
  24
  25 </para>
  26
  27 @G_CHANNEL_STATUS_NORMAL:
  28 @G_CHANNEL_STATUS_EOF:
  29 @G_CHANNEL_STATUS_PARTIAL_CHARS:
  30 @G_CHANNEL_STATUS_AGAIN:
  31 @G_CHANNEL_STATUS_INTR:
  32 @G_CHANNEL_STATUS_ERROR:
  33 @G_CHANNEL_STATUS_BAD_INPUT:
  34
  35 <!-- ##### USER_FUNCTION GCompareFuncData ##### -->
  36 <para>
  37
  38 </para>
  39
  40 @a:
  41 @b:
  42 @user_data:
  43 @Returns:
  44
  45 <!-- ##### USER_FUNCTION GCompletionStrcmpFunc ##### -->
  46 <para>
  47
  48 </para>
  49
  50 @s1:
  51 @s2:
  52 @Returns:
  53
  54 <!-- ##### USER_FUNCTION GErrorFunc ##### -->
  55 <para>
  56 Specifies the type of function passed to g_set_error_handler().
  57 </para>
  58
  59 @str: the error message.
  60
  61 <!-- ##### USER_FUNCTION GHookFreeFunc ##### -->
  62 <para>
  63
  64 </para>
  65
  66 @hook_list:
  67 @hook:
  68
  69 <!-- ##### ENUM GIOFileMode ##### -->
  70 <para>
  71
  72 </para>
  73
  74 @G_IO_FILE_MODE_READ:
  75 @G_IO_FILE_MODE_WRITE:
  76 @G_IO_FILE_MODE_APPEND:
  77 @G_IO_FILE_MODE_READ_WRITE:
  78 @G_IO_FILE_MODE_READ_WRITE_TRUNCATE:
  79 @G_IO_FILE_MODE_READ_WRITE_APPEND:
  80
  81 <!-- ##### ENUM GMatchType ##### -->
  82 <para>
  83 Enumeration representing different kinds of patterns. This is only used
  84 internally for optimizing the match algorithm.
  85 </para>
  86
  87 @G_MATCH_ALL: a general pattern.
  88 @G_MATCH_ALL_TAIL: a general pattern which contains a fixed part matching
  89 the end of the string.
  90 @G_MATCH_HEAD: a pattern matching every string with a certain prefix.
  91 @G_MATCH_TAIL: a pattern matching every string with a certain suffix.
  92 @G_MATCH_EXACT: a pattern matching exactly one string.
  93 @G_MATCH_LAST:
  94
  95 <!-- ##### USER_FUNCTION GWarningFunc ##### -->
  96 <para>
  97 Specifies the type of function passed to g_set_warning_handler().
  98 </para>
  99
 100 @str: the warning message.
 101
 102 <!-- ##### MACRO G_CHANNEL_ERROR ##### -->
 103 <para>
 104
 105 </para>
 106
 107
 108 <!-- ##### MACRO G_HOOK_DEFERRED_DESTROY ##### -->
 109 <para>
 110
 111 </para>
 112
 113
 114 <!-- ##### MACRO G_IO_CHANNEL_DEFAULT_LINE_TERM ##### -->
 115 <para>
 116 One of %G_IO_CHANNEL_UNIX_LINE_TERM, %G_IO_CHANNEL_DOS_LINE_TERM,
 117 or %G_IO_CHANNEL_MACINTOSH_LINE_TERM (unimplemented)
 118 depending on the system type.
 119 </para>
 120
 121
 122 <!-- ##### MACRO G_IO_CHANNEL_DOS_LINE_TERM ##### -->
 123 <para>
 124
 125 </para>
 126
 127
 128 <!-- ##### MACRO G_IO_CHANNEL_ENCODE_RAW ##### -->
 129 <para>
 130 Encoding for nonbuffered IO. With this encoding, data must be
 131 read using g_io_channel_read_chars(); the other functions will
 132 not work.
 133 </para>
 134
 135
 136 <!-- ##### MACRO G_IO_CHANNEL_MACINTOSH_LINE_TERM ##### -->
 137 <para>
 138
 139 </para>
 140
 141
 142 <!-- ##### MACRO G_IO_CHANNEL_UNIX_LINE_TERM ##### -->
 143 <para>
 144
 145 </para>
 146
 147
 148 <!-- ##### MACRO NAME_MAX ##### -->
 149 <para>
 150 Provided for UNIX emulation on Windows; equivalent to UNIX macro
 151 %NAME_MAX, which is the maximum length of a single path component.
 152 i.e. just the <filename>foo</filename> in <filename>/usr/bin/foo</filename>.
 153 </para>
 154
 155
 156 <!-- ##### MACRO access ##### -->
 157 <para>
 158
 159 </para>
 160
 161
 162 <!-- ##### MACRO close ##### -->
 163 <para>
 164
 165 </para>
 166
 167
 168 <!-- ##### FUNCTION closedir ##### -->
 169 <para>
 170 Provided for UNIX emulation on Windows; see documentation for <function>closedir()</function>
 171 in any UNIX manual.
 172 </para>
 173
 174 @Param1:
 175 @Returns:
 176
 177 <!-- ##### MACRO fdopen ##### -->
 178 <para>
 179
 180 </para>
 181
 182
 183 <!-- ##### MACRO ftruncate ##### -->
 184 <para>
 185 Provided for UNIX emulation on Windows; see documentation for <function>ftruncate()</function>
 186 in any UNIX manual.
 187 </para>
 188
 189 @fd:
 190 @size:
 191
 192 <!-- ##### FUNCTION g_channel_error_from_errno ##### -->
 193 <para>
 194
 195 </para>
 196
 197 @en:
 198 @Returns:
 199
 200 <!-- ##### FUNCTION g_channel_error_quark ##### -->
 201 <para>
 202
 203 </para>
 204
 205 @Returns:
 206
 207 <!-- ##### FUNCTION g_convert_error_quark ##### -->
 208 <para>
 209
 210 </para>
 211
 212 @Returns:
 213
 214 <!-- ##### FUNCTION g_get_language_names ##### -->
 215 <para>
 216
 217 </para>
 218
 219 @Returns:
 220
 221 <!-- ##### FUNCTION g_get_system_config_dirs ##### -->
 222 <para>
 223
 224 </para>
 225
 226 @Returns:
 227
 228 <!-- ##### FUNCTION g_get_system_data_dirs ##### -->
 229 <para>
 230
 231 </para>
 232
 233 @Returns:
 234
 235 <!-- ##### FUNCTION g_io_channel_error_quark ##### -->
 236 <para>
 237
 238 </para>
 239
 240 @Returns:
 241
 242 <!-- ##### VARIABLE g_log_domain_glib ##### -->
 243 <para>
 244 The log domain used for messages logged by GLib itself.
 245 </para>
 246
 247
 248 <!-- ##### FUNCTION g_main_add_poll ##### -->
 249 <para>
 250 Adds a file descriptor to be polled.
 251 This is usually combined with g_source_add() to add an event source.
 252 The event source's check function will typically test the revents
 253 field in the #GPollFD struct and return TRUE if events need to be processed.
 254 </para>
 255
 256 @fd: a #GPollFD, which is a file descriptor together with a bitwise
 257 combination of #GIOCondition flags determining which events to poll for.
 258 @priority: the priority of the poll, which should be the same as the priority
 259 used for g_source_add() to ensure that the file descriptor is polled whenever
 260 the results may be needed.
 261 See #G_PRIORITY_DEFAULT, #G_PRIORITY_DEFAULT_IDLE, #G_PRIORITY_HIGH,
 262 #G_PRIORITY_HIGH_IDLE, and #G_PRIORITY_LOW.
 263
 264 <!-- ##### FUNCTION g_main_context_get ##### -->
 265 <para>
 266
 267 </para>
 268
 269 @thread:
 270 @Returns:
 271
 272 <!-- ##### FUNCTION g_main_loop_destroy ##### -->
 273 <para>
 274
 275 </para>
 276
 277 @loop:
 278
 279 <!-- ##### FUNCTION g_main_remove_poll ##### -->
 280 <para>
 281 Removes a file descriptor from the list being polled.
 282 </para>
 283
 284 @fd: the #GPollFD to remove.
 285
 286 <!-- ##### FUNCTION g_main_win32_get_poll_func ##### -->
 287 <para>
 288
 289 </para>
 290
 291 @Returns:
 292
 293 <!-- ##### FUNCTION g_mem_check ##### -->
 294 <para>
 295 Checks if the given memory has already been freed. If it has it outputs
 296 a warning message.
 297 To use this function you must configure glib with the flag
 298 '--enable-mem-check=yes' before compiling.
 299 </para>
 300
 301 @mem: the memory to check.
 302
 303 <!-- ##### FUNCTION g_scanner_stat_mode ##### -->
 304 <para>
 305 Gets the file attributes.
 306 This is the <structfield>st_mode</structfield> field from the
 307 <structname>stat</structname> structure. See the <function>stat()</function>
 308 documentation.
 309 </para>
 310
 311 @filename: the file name.
 312 @Returns: the file attributes.
 313
 314 <!-- ##### FUNCTION g_set_error_handler ##### -->
 315 <para>
 316 Sets the function to be called to handle error messages.
 317 This function is deprecated in favour of the new logging facilities.
 318 </para>
 319
 320 @func: the function to be called to handle error messages.
 321 @Returns: the old error handler.
 322
 323 <!-- ##### FUNCTION g_set_message_handler ##### -->
 324 <para>
 325 Sets the function to be called to handle messages.
 326 This function is deprecated in favour of the new logging facilities.
 327 </para>
 328
 329 @func: the function to be called to handle normal messages.
 330 @Returns: the old message handler.
 331
 332 <!-- ##### FUNCTION g_set_warning_handler ##### -->
 333 <para>
 334 Sets the function to be called to handle warning messages.
 335 This function is deprecated in favour of the new logging facilities.
 336 </para>
 337
 338 @func: the function to be called to handle warning messages.
 339 @Returns: the old warning handler.
 340
 341 <!-- ##### FUNCTION g_source_add ##### -->
 342 <para>
 343 </para>
 344
 345 @priority:
 346 @can_recurse:
 347 @funcs:
 348 @source_data:
 349 @user_data:
 350 @notify:
 351 @Returns:
 352 @source:
 353 @context:
 354
 355 <!-- ##### FUNCTION g_source_connect ##### -->
 356 <para>
 357
 358 </para>
 359
 360 @source:
 361 @func:
 362 @data:
 363 @notify:
 364
 365 <!-- ##### FUNCTION g_source_connect_indirect ##### -->
 366 <para>
 367
 368 </para>
 369
 370 @source:
 371 @callback_data:
 372 @callback_funcs:
 373
 374 <!-- ##### FUNCTION g_source_remove_by_source_data ##### -->
 375 <para>
 376 Removes the first event source found with the given source data.
 377 </para>
 378 <para>
 379 Event sources are sorted with the highest priority first. Sources with equal
 380 priority are stored in the order in which they were added.
 381 </para>
 382
 383 @source_data: the source data, which contains information specific to the
 384 type of source.
 385 @Returns: TRUE if an event source was found and removed.
 386
 387 <!-- ##### FUNCTION g_static_private_get_for_thread ##### -->
 388 <para>
 389
 390 </para>
 391
 392 @private_key:
 393 @thread:
 394 @Returns:
 395
 396 <!-- ##### FUNCTION g_static_private_set_for_thread ##### -->
 397 <para>
 398
 399 </para>
 400
 401 @private_key:
 402 @thread:
 403 @data:
 404 @notify:
 405
 406 <!-- ##### MACRO g_string ##### -->
 407 <para>
 408 Turns the argument into a string literal by using the '#' stringizing operator.
 409 </para>
 410
 411 @x: text to convert to a literal string.
 412
 413 <!-- ##### MACRO getcwd ##### -->
 414 <para>
 415
 416 </para>
 417
 418
 419 <!-- ##### MACRO getpid ##### -->
 420 <para>
 421
 422 </para>
 423
 424
 425 <!-- ##### MACRO lseek ##### -->
 426 <para>
 427
 428 </para>
 429
 430
 431 <!-- ##### MACRO open ##### -->
 432 <para>
 433
 434 </para>
 435
 436
 437 <!-- ##### FUNCTION opendir ##### -->
 438 <para>
 439 Provided for UNIX emulation on Windows; see documentation for <function>opendir()</function>
 440 in any UNIX manual.
 441 </para>
 442
 443 @Param1:
 444 @Returns:
 445
 446 <!-- ##### MACRO pclose ##### -->
 447 <para>
 448
 449 </para>
 450
 451
 452 <!-- ##### MACRO popen ##### -->
 453 <para>
 454
 455 </para>
 456
 457
 458 <!-- ##### MACRO read ##### -->
 459 <para>
 460
 461 </para>
 462
 463
 464 <!-- ##### MACRO readdir ##### -->
 465 <para>
 466 Provided for UNIX emulation on Windows; see documentation for <function>readdir()</function>
 467 in any UNIX manual.
 468 </para>
 469
 470
 471 <!-- ##### FUNCTION rewinddir ##### -->
 472 <para>
 473 Provided for UNIX emulation on Windows; see documentation for <function>rewinddir()</function>
 474 in any UNIX manual.
 475 </para>
 476
 477 @Param1:
 478
 479 <!-- ##### MACRO write ##### -->
 480 <para>
 481
 482 </para>
 483
 484