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

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