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