fixed dealing with collection/lcopy of NULL values.
[platform/upstream/glib.git] / docs / reference / glib / tmpl / glib-unused.sgml
1 <!-- ##### FUNCTION g_markup_parse_context_parse ##### -->
2 <para>
3
4 </para>
5
6 @context: 
7 @text: 
8 @text_len: 
9 @error: 
10 @Returns: 
11
12 <!-- ##### STRUCT GSource ##### -->
13 <para>
14
15 </para>
16
17
18 <!-- ##### FUNCTION g_source_connect_indirect ##### -->
19 <para>
20
21 </para>
22
23 @source: 
24 @callback_data: 
25 @callback_funcs: 
26
27 <!-- ##### FUNCTION g_locale_to_utf8 ##### -->
28 <para>
29
30 </para>
31
32 @opsysstring: 
33 @error: 
34 @Returns: 
35
36 <!-- ##### FUNCTION g_iconv_close ##### -->
37 <para>
38
39 </para>
40
41 @converter: 
42 @Returns: 
43
44 <!-- ##### MACRO popen ##### -->
45 <para>
46
47 </para>
48
49
50 <!-- ##### FUNCTION g_source_set_can_recurse ##### -->
51 <para>
52
53 </para>
54
55 @source: 
56 @can_recurse: 
57
58 <!-- ##### MACRO pclose ##### -->
59 <para>
60
61 </para>
62
63
64 <!-- ##### FUNCTION g_main_add_poll ##### -->
65 <para>
66 Adds a file descriptor to be polled.
67 This is usually combined with g_source_add() to add an event source.
68 The event source's check function will typically test the revents
69 field in the #GPollFD struct and return TRUE if events need to be processed.
70 </para>
71
72 @fd: a #GPollFD, which is a file descriptor together with a bitwise
73 combination of #GIOCondition flags determining which events to poll for.
74 @priority: the priority of the poll, which should be the same as the priority
75 used for g_source_add() to ensure that the file descriptor is polled whenever
76 the results may be needed.
77 See #G_PRIORITY_DEFAULT, #G_PRIORITY_DEFAULT_IDLE, #G_PRIORITY_HIGH,
78 #G_PRIORITY_HIGH_IDLE, and #G_PRIORITY_LOW.
79
80 <!-- ##### ENUM GMarkupError ##### -->
81 <para>
82
83 </para>
84
85 @G_MARKUP_ERROR_BAD_UTF8: text being parsed was not valid UTF-8
86 @G_MARKUP_ERROR_EMPTY: document contained nothing, or only whitespace
87 @G_MARKUP_ERROR_PARSE: document was ill-formed
88 @G_MARKUP_ERROR_UNKNOWN_ELEMENT: error should be set by #GMarkupParser functions; element wasn't known
89 @G_MARKUP_ERROR_UNKNOWN_ATTRIBUTE: error should be set by #GMarkupParser functions; attribute wasn't known
90 @G_MARKUP_ERROR_INVALID_CONTENT: error should be set by #GMarkupParser functions; something was wrong with contents of the document, e.g. invalid attribute value
91
92 <!-- ##### FUNCTION g_main_context_add_poll ##### -->
93 <para>
94
95 </para>
96
97 @context: 
98 @fd: 
99 @priority: 
100
101 <!-- ##### MACRO lseek ##### -->
102 <para>
103
104 </para>
105
106
107 <!-- ##### FUNCTION g_string_new_len ##### -->
108 <para>
109
110 </para>
111
112 @init: 
113 @len: 
114 @Returns: 
115
116 <!-- ##### STRUCT GSourceCallbackFuncs ##### -->
117 <para>
118
119 </para>
120
121 @ref: 
122 @unref: 
123 @get: 
124
125 <!-- ##### FUNCTION g_array_sort ##### -->
126 <para>
127
128 </para>
129
130 @array: 
131 @compare_func: 
132
133 <!-- ##### FUNCTION g_main_context_find_source_by_funcs_user_data ##### -->
134 <para>
135
136 </para>
137
138 @context: 
139 @funcs: 
140 @user_data: 
141 @Returns: 
142 @source_data: 
143
144 <!-- ##### FUNCTION g_markup_parse_context_free ##### -->
145 <para>
146
147 </para>
148
149 @context: 
150
151 <!-- ##### STRUCT GMarkupParseContext ##### -->
152 <para>
153
154 </para>
155
156
157 <!-- ##### FUNCTION g_ptr_array_sort ##### -->
158 <para>
159
160 </para>
161
162 @array: 
163 @compare_func: 
164
165 <!-- ##### FUNCTION g_main_context_query ##### -->
166 <para>
167
168 </para>
169
170 @context: 
171 @max_priority: 
172 @timeout: 
173 @fds: 
174 @n_fds: 
175 @Returns: 
176
177 <!-- ##### FUNCTION g_iconv_open ##### -->
178 <para>
179
180 </para>
181
182 @to_codeset: 
183 @from_codeset: 
184 @Returns: 
185
186 <!-- ##### FUNCTION g_source_new ##### -->
187 <para>
188
189 </para>
190
191 @source_funcs: 
192 @struct_size: 
193 @Returns: 
194
195 <!-- ##### MACRO getpid ##### -->
196 <para>
197
198 </para>
199
200
201 <!-- ##### FUNCTION g_source_remove_by_source_data ##### -->
202 <para>
203 Removes the first event source found with the given source data.
204 </para>
205 <para>
206 Event sources are sorted with the highest priority first. Sources with equal
207 priority are stored in the order in which they were added.
208 </para>
209
210 @source_data: the source data, which contains information specific to the
211 type of source.
212 @Returns: TRUE if an event source was found and removed.
213
214 <!-- ##### MACRO close ##### -->
215 <para>
216
217 </para>
218
219
220 <!-- ##### FUNCTION g_source_get_id ##### -->
221 <para>
222
223 </para>
224
225 @source: 
226 @Returns: 
227
228 <!-- ##### FUNCTION g_mkstemp ##### -->
229 <para>
230
231 </para>
232
233 @tmpl: 
234 @Returns: 
235
236 <!-- ##### FUNCTION g_main_context_get_poll_func ##### -->
237 <para>
238
239 </para>
240
241 @context: 
242 @Returns: 
243
244 <!-- ##### FUNCTION g_source_add_poll ##### -->
245 <para>
246
247 </para>
248
249 @source: 
250 @fd: 
251
252 <!-- ##### MACRO fdopen ##### -->
253 <para>
254
255 </para>
256
257
258 <!-- ##### FUNCTION g_source_get_current_time ##### -->
259 <para>
260
261 </para>
262
263 @source: 
264 @timeval: 
265
266 <!-- ##### USER_FUNCTION GCompletionStrcmpFunc ##### -->
267 <para>
268
269 </para>
270
271 @s1: 
272 @s2: 
273 @Returns: 
274
275 <!-- ##### FUNCTION g_main_loop_new ##### -->
276 <para>
277
278 </para>
279
280 @context: 
281 @is_running: 
282 @Returns: 
283
284 <!-- ##### FUNCTION g_iconv ##### -->
285 <para>
286
287 </para>
288
289 @converter: 
290 @inbuf: 
291 @inbytes_left: 
292 @outbuf: 
293 @outbytes_left: 
294 @Returns: 
295
296 <!-- ##### FUNCTION g_source_ref ##### -->
297 <para>
298
299 </para>
300
301 @source: 
302 @Returns: 
303
304 <!-- ##### FUNCTION g_byte_array_sort ##### -->
305 <para>
306
307 </para>
308
309 @array: 
310 @compare_func: 
311
312 <!-- ##### FUNCTION g_markup_parse_context_get_position ##### -->
313 <para>
314
315 </para>
316
317 @context: 
318 @line_number: 
319 @char_number: 
320
321 <!-- ##### FUNCTION g_locale_from_utf8 ##### -->
322 <para>
323
324 </para>
325
326 @utf8string: 
327 @error: 
328 @Returns: 
329
330 <!-- ##### FUNCTION g_main_loop_is_running ##### -->
331 <para>
332
333 </para>
334
335 @loop: 
336 @Returns: 
337
338 <!-- ##### FUNCTION g_main_context_remove_poll ##### -->
339 <para>
340
341 </para>
342
343 @context: 
344 @fd: 
345
346 <!-- ##### FUNCTION g_byte_array_sort_with_data ##### -->
347 <para>
348
349 </para>
350
351 @array: 
352 @compare_func: 
353 @user_data: 
354
355 <!-- ##### FUNCTION g_markup_parse_context_new ##### -->
356 <para>
357
358 </para>
359
360 @parser: 
361 @flags: 
362 @user_data: 
363 @user_data_dnotify: 
364 @Returns: 
365
366 <!-- ##### FUNCTION g_source_get_can_recurse ##### -->
367 <para>
368
369 </para>
370
371 @source: 
372 @Returns: 
373
374 <!-- ##### FUNCTION g_main_context_get ##### -->
375 <para>
376
377 </para>
378
379 @thread: 
380 @Returns: 
381
382 <!-- ##### FUNCTION g_source_remove_poll ##### -->
383 <para>
384
385 </para>
386
387 @source: 
388 @fd: 
389
390 <!-- ##### FUNCTION g_tree_new_with_data ##### -->
391 <para>
392
393 </para>
394
395 @key_compare_func: 
396 @user_data: 
397 @Returns: 
398
399 <!-- ##### FUNCTION g_source_get_priority ##### -->
400 <para>
401
402 </para>
403
404 @source: 
405 @Returns: 
406
407 <!-- ##### FUNCTION g_source_connect ##### -->
408 <para>
409
410 </para>
411
412 @source: 
413 @func: 
414 @data: 
415 @notify: 
416
417 <!-- ##### FUNCTION g_main_context_iteration ##### -->
418 <para>
419
420 </para>
421
422 @context: 
423 @may_block: 
424 @Returns: 
425
426 <!-- ##### FUNCTION g_main_context_dispatch ##### -->
427 <para>
428
429 </para>
430
431 @context: 
432
433 <!-- ##### FUNCTION g_main_loop_quit ##### -->
434 <para>
435
436 </para>
437
438 @loop: 
439
440 <!-- ##### FUNCTION g_main_context_prepare ##### -->
441 <para>
442
443 </para>
444
445 @context: 
446 @priority: 
447 @Returns: 
448
449 <!-- ##### FUNCTION g_source_set_priority ##### -->
450 <para>
451
452 </para>
453
454 @source: 
455 @priority: 
456
457 <!-- ##### FUNCTION g_ptr_array_sort_with_data ##### -->
458 <para>
459
460 </para>
461
462 @array: 
463 @compare_func: 
464 @user_data: 
465
466 <!-- ##### FUNCTION g_list_sort_with_data ##### -->
467 <para>
468
469 </para>
470
471 @list: 
472 @compare_func: 
473 @user_data: 
474 @Returns: 
475
476 <!-- ##### FUNCTION g_main_context_find_source_by_user_data ##### -->
477 <para>
478
479 </para>
480
481 @context: 
482 @user_data: 
483 @Returns: 
484
485 <!-- ##### FUNCTION g_main_context_set_poll_func ##### -->
486 <para>
487
488 </para>
489
490 @context: 
491 @func: 
492
493 <!-- ##### MACRO getcwd ##### -->
494 <para>
495
496 </para>
497
498
499 <!-- ##### FUNCTION g_io_create_watch ##### -->
500 <para>
501
502 </para>
503
504 @channel: 
505 @condition: 
506 @Returns: 
507
508 <!-- ##### FUNCTION g_source_unref ##### -->
509 <para>
510
511 </para>
512
513 @source: 
514
515 <!-- ##### MACRO write ##### -->
516 <para>
517
518 </para>
519
520
521 <!-- ##### FUNCTION g_main_context_find_source_by_id ##### -->
522 <para>
523
524 </para>
525
526 @context: 
527 @id: 
528 @Returns: 
529
530 <!-- ##### FUNCTION g_main_remove_poll ##### -->
531 <para>
532 Removes a file descriptor from the list being polled.
533 </para>
534
535 @fd: the #GPollFD to remove.
536
537 <!-- ##### MACRO access ##### -->
538 <para>
539
540 </para>
541
542
543 <!-- ##### MACRO g_string ##### -->
544 <para>
545 Turns the argument into a string literal by using the '#' stringizing operator.
546 </para>
547
548 @x: text to convert to a literal string.
549
550 <!-- ##### FUNCTION g_idle_source_new ##### -->
551 <para>
552
553 </para>
554
555 @Returns: 
556
557 <!-- ##### FUNCTION g_main_context_pending ##### -->
558 <para>
559
560 </para>
561
562 @context: 
563 @Returns: 
564
565 <!-- ##### FUNCTION g_main_win32_get_poll_func ##### -->
566 <para>
567
568 </para>
569
570 @Returns: 
571
572 <!-- ##### FUNCTION g_main_loop_run ##### -->
573 <para>
574
575 </para>
576
577 @loop: 
578
579 <!-- ##### MACRO read ##### -->
580 <para>
581
582 </para>
583
584
585 <!-- ##### FUNCTION g_array_sort_with_data ##### -->
586 <para>
587
588 </para>
589
590 @array: 
591 @compare_func: 
592 @user_data: 
593
594 <!-- ##### MACRO G_MARKUP_ERROR ##### -->
595 <para>
596
597 </para>
598
599
600 <!-- ##### FUNCTION g_main_context_default ##### -->
601 <para>
602
603 </para>
604
605 @Returns: 
606
607 <!-- ##### ENUM GMarkupParseFlags ##### -->
608 <para>
609 There are no flags right now
610 </para>
611
612 @G_MARKUP_DO_NOT_USE_THIS_UNSUPPORTED_FLAG: 
613
614 <!-- ##### FUNCTION g_slist_sort_with_data ##### -->
615 <para>
616
617 </para>
618
619 @list: 
620 @compare_func: 
621 @user_data: 
622 @Returns: 
623
624 <!-- ##### FUNCTION g_markup_parse_context_end_parse ##### -->
625 <para>
626
627 </para>
628
629 @context: 
630 @error: 
631 @Returns: 
632
633 <!-- ##### FUNCTION g_source_get_context ##### -->
634 <para>
635
636 </para>
637
638 @source: 
639 @Returns: 
640
641 <!-- ##### FUNCTION g_timeout_source_new ##### -->
642 <para>
643
644 </para>
645
646 @interval: 
647 @Returns: 
648
649 <!-- ##### STRUCT GMarkupParser ##### -->
650 <para>
651 Any of the fields in #GMarkupParser can be %NULL, in which case they
652 will be ignored. Except for the @error function, any of these
653 callbacks can set an error; in particular the
654 %G_MARKUP_ERROR_UNKNOWN_ELEMENT, %G_MARKUP_ERROR_UNKNOWN_ATTRIBUTE,
655 and %G_MARKUP_ERROR_INVALID_CONTENT errors are intended to be set 
656 from these callbacks. If you set an error from a callback,
657 g_markup_parse_context_parse() will report that error back to its caller.
658 </para>
659
660 @start_element: Callback to invoke when the opening tag of an element
661 is seen.
662 @end_element: Callback to invoke when the closing tag of an element is seen
663 @text: Callback to invoke when some text is seen (text is always
664 inside an element)
665 @passthrough: Callback to invoke for comments and processing
666 instructions; if you're re-writing the parsed document, write the
667 passthrough text back out in the same position
668 @error: Callback to invoke when an error occurs
669
670 <!-- ##### USER_FUNCTION GEqualFunc ##### -->
671 <para>
672 Specifies the type of a function used to test two values for
673 equality. The function should return TRUE if both values are equal and
674 FALSE otherwise.
675 </para>
676
677 @a: a value.
678 @b: a value to compare with.
679 @Returns: TRUE if @a = @b; FALSE otherwise.
680
681 <!-- ##### FUNCTION g_main_loop_destroy ##### -->
682 <para>
683
684 </para>
685
686 @loop: 
687
688 <!-- ##### FUNCTION g_file_open_tmp ##### -->
689 <para>
690
691 </para>
692
693 @tmpl: 
694 @name_used: 
695 @error: 
696 @Returns: 
697
698 <!-- ##### STRUCT GMainContext ##### -->
699 <para>
700
701 </para>
702
703
704 <!-- ##### FUNCTION g_main_context_check ##### -->
705 <para>
706
707 </para>
708
709 @context: 
710 @max_priority: 
711 @fds: 
712 @n_fds: 
713 @Returns: 
714
715 <!-- ##### FUNCTION g_convert_error_quark ##### -->
716 <para>
717
718 </para>
719
720 @Returns: 
721
722 <!-- ##### FUNCTION g_source_destroy ##### -->
723 <para>
724
725 </para>
726
727 @source: 
728
729 <!-- ##### FUNCTION g_markup_escape_text ##### -->
730 <para>
731
732 </para>
733
734 @text: 
735 @length: 
736 @Returns: 
737
738 <!-- ##### MACRO open ##### -->
739 <para>
740
741 </para>
742
743