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