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_io_channel_error_quark ##### -->
 215 <para>
 216
 217 </para>
 218
 219 @Returns:
 220
 221 <!-- ##### VARIABLE g_log_domain_glib ##### -->
 222 <para>
 223 The log domain used for messages logged by GLib itself.
 224 </para>
 225
 226
 227 <!-- ##### FUNCTION g_main_add_poll ##### -->
 228 <para>
 229 Adds a file descriptor to be polled.
 230 This is usually combined with g_source_add() to add an event source.
 231 The event source's check function will typically test the revents
 232 field in the #GPollFD struct and return TRUE if events need to be processed.
 233 </para>
 234
 235 @fd: a #GPollFD, which is a file descriptor together with a bitwise
 236 combination of #GIOCondition flags determining which events to poll for.
 237 @priority: the priority of the poll, which should be the same as the priority
 238 used for g_source_add() to ensure that the file descriptor is polled whenever
 239 the results may be needed.
 240 See #G_PRIORITY_DEFAULT, #G_PRIORITY_DEFAULT_IDLE, #G_PRIORITY_HIGH,
 241 #G_PRIORITY_HIGH_IDLE, and #G_PRIORITY_LOW.
 242
 243 <!-- ##### FUNCTION g_main_context_get ##### -->
 244 <para>
 245
 246 </para>
 247
 248 @thread:
 249 @Returns:
 250
 251 <!-- ##### FUNCTION g_main_loop_destroy ##### -->
 252 <para>
 253
 254 </para>
 255
 256 @loop:
 257
 258 <!-- ##### FUNCTION g_main_remove_poll ##### -->
 259 <para>
 260 Removes a file descriptor from the list being polled.
 261 </para>
 262
 263 @fd: the #GPollFD to remove.
 264
 265 <!-- ##### FUNCTION g_main_win32_get_poll_func ##### -->
 266 <para>
 267
 268 </para>
 269
 270 @Returns:
 271
 272 <!-- ##### FUNCTION g_mem_check ##### -->
 273 <para>
 274 Checks if the given memory has already been freed. If it has it outputs
 275 a warning message.
 276 To use this function you must configure glib with the flag
 277 '--enable-mem-check=yes' before compiling.
 278 </para>
 279
 280 @mem: the memory to check.
 281
 282 <!-- ##### FUNCTION g_scanner_stat_mode ##### -->
 283 <para>
 284 Gets the file attributes.
 285 This is the <structfield>st_mode</structfield> field from the
 286 <structname>stat</structname> structure. See the <function>stat()</function>
 287 documentation.
 288 </para>
 289
 290 @filename: the file name.
 291 @Returns: the file attributes.
 292
 293 <!-- ##### FUNCTION g_set_error_handler ##### -->
 294 <para>
 295 Sets the function to be called to handle error messages.
 296 This function is deprecated in favour of the new logging facilities.
 297 </para>
 298
 299 @func: the function to be called to handle error messages.
 300 @Returns: the old error handler.
 301
 302 <!-- ##### FUNCTION g_set_message_handler ##### -->
 303 <para>
 304 Sets the function to be called to handle messages.
 305 This function is deprecated in favour of the new logging facilities.
 306 </para>
 307
 308 @func: the function to be called to handle normal messages.
 309 @Returns: the old message handler.
 310
 311 <!-- ##### FUNCTION g_set_warning_handler ##### -->
 312 <para>
 313 Sets the function to be called to handle warning messages.
 314 This function is deprecated in favour of the new logging facilities.
 315 </para>
 316
 317 @func: the function to be called to handle warning messages.
 318 @Returns: the old warning handler.
 319
 320 <!-- ##### FUNCTION g_source_add ##### -->
 321 <para>
 322 </para>
 323
 324 @priority:
 325 @can_recurse:
 326 @funcs:
 327 @source_data:
 328 @user_data:
 329 @notify:
 330 @Returns:
 331 @source:
 332 @context:
 333
 334 <!-- ##### FUNCTION g_source_connect ##### -->
 335 <para>
 336
 337 </para>
 338
 339 @source:
 340 @func:
 341 @data:
 342 @notify:
 343
 344 <!-- ##### FUNCTION g_source_connect_indirect ##### -->
 345 <para>
 346
 347 </para>
 348
 349 @source:
 350 @callback_data:
 351 @callback_funcs:
 352
 353 <!-- ##### FUNCTION g_source_remove_by_source_data ##### -->
 354 <para>
 355 Removes the first event source found with the given source data.
 356 </para>
 357 <para>
 358 Event sources are sorted with the highest priority first. Sources with equal
 359 priority are stored in the order in which they were added.
 360 </para>
 361
 362 @source_data: the source data, which contains information specific to the
 363 type of source.
 364 @Returns: TRUE if an event source was found and removed.
 365
 366 <!-- ##### FUNCTION g_static_private_get_for_thread ##### -->
 367 <para>
 368
 369 </para>
 370
 371 @private_key:
 372 @thread:
 373 @Returns:
 374
 375 <!-- ##### FUNCTION g_static_private_set_for_thread ##### -->
 376 <para>
 377
 378 </para>
 379
 380 @private_key:
 381 @thread:
 382 @data:
 383 @notify:
 384
 385 <!-- ##### MACRO g_string ##### -->
 386 <para>
 387 Turns the argument into a string literal by using the '#' stringizing operator.
 388 </para>
 389
 390 @x: text to convert to a literal string.
 391
 392 <!-- ##### MACRO getcwd ##### -->
 393 <para>
 394
 395 </para>
 396
 397
 398 <!-- ##### MACRO getpid ##### -->
 399 <para>
 400
 401 </para>
 402
 403
 404 <!-- ##### MACRO lseek ##### -->
 405 <para>
 406
 407 </para>
 408
 409
 410 <!-- ##### MACRO open ##### -->
 411 <para>
 412
 413 </para>
 414
 415
 416 <!-- ##### FUNCTION opendir ##### -->
 417 <para>
 418 Provided for UNIX emulation on Windows; see documentation for <function>opendir()</function>
 419 in any UNIX manual.
 420 </para>
 421
 422 @Param1:
 423 @Returns:
 424
 425 <!-- ##### MACRO pclose ##### -->
 426 <para>
 427
 428 </para>
 429
 430
 431 <!-- ##### MACRO popen ##### -->
 432 <para>
 433
 434 </para>
 435
 436
 437 <!-- ##### MACRO read ##### -->
 438 <para>
 439
 440 </para>
 441
 442
 443 <!-- ##### MACRO readdir ##### -->
 444 <para>
 445 Provided for UNIX emulation on Windows; see documentation for <function>readdir()</function>
 446 in any UNIX manual.
 447 </para>
 448
 449
 450 <!-- ##### FUNCTION rewinddir ##### -->
 451 <para>
 452 Provided for UNIX emulation on Windows; see documentation for <function>rewinddir()</function>
 453 in any UNIX manual.
 454 </para>
 455
 456 @Param1:
 457
 458 <!-- ##### MACRO write ##### -->
 459 <para>
 460
 461 </para>
 462
 463