Imported Upstream version 2.13.1
[platform/upstream/fontconfig.git] / doc / fcstrset.sgml
1 <!--
2    fontconfig/doc/func.sgml
3   
4    Copyright © 2003 Keith Packard
5   
6    Permission to use, copy, modify, distribute, and sell this software and its
7    documentation for any purpose is hereby granted without fee, provided that
8    the above copyright notice appear in all copies and that both that
9    copyright notice and this permission notice appear in supporting
10    documentation, and that the name of the author(s) not be used in
11    advertising or publicity pertaining to distribution of the software without
12    specific, written prior permission.  The authors make no
13    representations about the suitability of this software for any purpose.  It
14    is provided "as is" without express or implied warranty.
15   
16    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
17    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
18    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
19    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
20    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
21    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
22    PERFORMANCE OF THIS SOFTWARE.
23  -->
24     <refentry id="FcStrSetCreate">
25         <refmeta>
26             <refentrytitle>FcStrSetCreate</refentrytitle>
27             <manvolnum>3</manvolnum>
28             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
29         </refmeta>
30         <refnamediv>
31             <refname>FcStrSetCreate</refname>
32             <refpurpose>create a string set</refpurpose>
33         </refnamediv>
34         <refsynopsisdiv>
35         <funcsynopsis>
36         <funcsynopsisinfo>
37 #include &lt;fontconfig/fontconfig.h&gt;
38         </funcsynopsisinfo>
39         <funcprototype>
40             <funcdef>FcStrSet * <function>FcStrSetCreate</function></funcdef>
41                 <paramdef>void<parameter></parameter></paramdef>
42         </funcprototype>
43         </funcsynopsis>
44         </refsynopsisdiv>
45         <refsect1><title>Description</title>
46             <para>
47 Create an empty set.
48             </para>
49         </refsect1>
50     </refentry>
51 <!--
52    fontconfig/doc/func.sgml
53   
54    Copyright © 2003 Keith Packard
55   
56    Permission to use, copy, modify, distribute, and sell this software and its
57    documentation for any purpose is hereby granted without fee, provided that
58    the above copyright notice appear in all copies and that both that
59    copyright notice and this permission notice appear in supporting
60    documentation, and that the name of the author(s) not be used in
61    advertising or publicity pertaining to distribution of the software without
62    specific, written prior permission.  The authors make no
63    representations about the suitability of this software for any purpose.  It
64    is provided "as is" without express or implied warranty.
65   
66    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
67    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
68    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
69    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
70    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
71    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
72    PERFORMANCE OF THIS SOFTWARE.
73  -->
74     <refentry id="FcStrSetMember">
75         <refmeta>
76             <refentrytitle>FcStrSetMember</refentrytitle>
77             <manvolnum>3</manvolnum>
78             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
79         </refmeta>
80         <refnamediv>
81             <refname>FcStrSetMember</refname>
82             <refpurpose>check set for membership</refpurpose>
83         </refnamediv>
84         <refsynopsisdiv>
85         <funcsynopsis>
86         <funcsynopsisinfo>
87 #include &lt;fontconfig/fontconfig.h&gt;
88         </funcsynopsisinfo>
89         <funcprototype>
90             <funcdef>FcBool <function>FcStrSetMember</function></funcdef>
91                 <paramdef>FcStrSet *<parameter>set</parameter></paramdef>
92                 <paramdef>const FcChar8 *<parameter>s</parameter></paramdef>
93         </funcprototype>
94         </funcsynopsis>
95         </refsynopsisdiv>
96         <refsect1><title>Description</title>
97             <para>
98 Returns whether <parameter>s</parameter> is a member of
99 <parameter>set</parameter>.
100             </para>
101         </refsect1>
102     </refentry>
103 <!--
104    fontconfig/doc/func.sgml
105   
106    Copyright © 2003 Keith Packard
107   
108    Permission to use, copy, modify, distribute, and sell this software and its
109    documentation for any purpose is hereby granted without fee, provided that
110    the above copyright notice appear in all copies and that both that
111    copyright notice and this permission notice appear in supporting
112    documentation, and that the name of the author(s) not be used in
113    advertising or publicity pertaining to distribution of the software without
114    specific, written prior permission.  The authors make no
115    representations about the suitability of this software for any purpose.  It
116    is provided "as is" without express or implied warranty.
117   
118    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
119    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
120    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
121    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
122    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
123    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
124    PERFORMANCE OF THIS SOFTWARE.
125  -->
126     <refentry id="FcStrSetEqual">
127         <refmeta>
128             <refentrytitle>FcStrSetEqual</refentrytitle>
129             <manvolnum>3</manvolnum>
130             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
131         </refmeta>
132         <refnamediv>
133             <refname>FcStrSetEqual</refname>
134             <refpurpose>check sets for equality</refpurpose>
135         </refnamediv>
136         <refsynopsisdiv>
137         <funcsynopsis>
138         <funcsynopsisinfo>
139 #include &lt;fontconfig/fontconfig.h&gt;
140         </funcsynopsisinfo>
141         <funcprototype>
142             <funcdef>FcBool <function>FcStrSetEqual</function></funcdef>
143                 <paramdef>FcStrSet *<parameter>set_a</parameter></paramdef>
144                 <paramdef>FcStrSet *<parameter>set_b</parameter></paramdef>
145         </funcprototype>
146         </funcsynopsis>
147         </refsynopsisdiv>
148         <refsect1><title>Description</title>
149             <para>
150 Returns whether <parameter>set_a</parameter> contains precisely the same
151 strings as <parameter>set_b</parameter>. Ordering of strings within the two
152 sets is not considered.
153             </para>
154         </refsect1>
155     </refentry>
156 <!--
157    fontconfig/doc/func.sgml
158   
159    Copyright © 2003 Keith Packard
160   
161    Permission to use, copy, modify, distribute, and sell this software and its
162    documentation for any purpose is hereby granted without fee, provided that
163    the above copyright notice appear in all copies and that both that
164    copyright notice and this permission notice appear in supporting
165    documentation, and that the name of the author(s) not be used in
166    advertising or publicity pertaining to distribution of the software without
167    specific, written prior permission.  The authors make no
168    representations about the suitability of this software for any purpose.  It
169    is provided "as is" without express or implied warranty.
170   
171    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
172    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
173    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
174    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
175    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
176    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
177    PERFORMANCE OF THIS SOFTWARE.
178  -->
179     <refentry id="FcStrSetAdd">
180         <refmeta>
181             <refentrytitle>FcStrSetAdd</refentrytitle>
182             <manvolnum>3</manvolnum>
183             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
184         </refmeta>
185         <refnamediv>
186             <refname>FcStrSetAdd</refname>
187             <refpurpose>add to a string set</refpurpose>
188         </refnamediv>
189         <refsynopsisdiv>
190         <funcsynopsis>
191         <funcsynopsisinfo>
192 #include &lt;fontconfig/fontconfig.h&gt;
193         </funcsynopsisinfo>
194         <funcprototype>
195             <funcdef>FcBool <function>FcStrSetAdd</function></funcdef>
196                 <paramdef>FcStrSet *<parameter>set</parameter></paramdef>
197                 <paramdef>const FcChar8 *<parameter>s</parameter></paramdef>
198         </funcprototype>
199         </funcsynopsis>
200         </refsynopsisdiv>
201         <refsect1><title>Description</title>
202             <para>
203 Adds a copy of <parameter>s</parameter> to <parameter>set</parameter>.
204             </para>
205         </refsect1>
206     </refentry>
207 <!--
208    fontconfig/doc/func.sgml
209   
210    Copyright © 2003 Keith Packard
211   
212    Permission to use, copy, modify, distribute, and sell this software and its
213    documentation for any purpose is hereby granted without fee, provided that
214    the above copyright notice appear in all copies and that both that
215    copyright notice and this permission notice appear in supporting
216    documentation, and that the name of the author(s) not be used in
217    advertising or publicity pertaining to distribution of the software without
218    specific, written prior permission.  The authors make no
219    representations about the suitability of this software for any purpose.  It
220    is provided "as is" without express or implied warranty.
221   
222    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
223    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
224    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
225    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
226    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
227    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
228    PERFORMANCE OF THIS SOFTWARE.
229  -->
230     <refentry id="FcStrSetAddFilename">
231         <refmeta>
232             <refentrytitle>FcStrSetAddFilename</refentrytitle>
233             <manvolnum>3</manvolnum>
234             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
235         </refmeta>
236         <refnamediv>
237             <refname>FcStrSetAddFilename</refname>
238             <refpurpose>add a filename to a string set</refpurpose>
239         </refnamediv>
240         <refsynopsisdiv>
241         <funcsynopsis>
242         <funcsynopsisinfo>
243 #include &lt;fontconfig/fontconfig.h&gt;
244         </funcsynopsisinfo>
245         <funcprototype>
246             <funcdef>FcBool <function>FcStrSetAddFilename</function></funcdef>
247                 <paramdef>FcStrSet *<parameter>set</parameter></paramdef>
248                 <paramdef>const FcChar8 *<parameter>s</parameter></paramdef>
249         </funcprototype>
250         </funcsynopsis>
251         </refsynopsisdiv>
252         <refsect1><title>Description</title>
253             <para>
254 Adds a copy <parameter>s</parameter> to <parameter>set</parameter>, The copy
255 is created with FcStrCopyFilename so that leading '~' values are replaced
256 with the value of the HOME environment variable.
257             </para>
258         </refsect1>
259     </refentry>
260 <!--
261    fontconfig/doc/func.sgml
262   
263    Copyright © 2003 Keith Packard
264   
265    Permission to use, copy, modify, distribute, and sell this software and its
266    documentation for any purpose is hereby granted without fee, provided that
267    the above copyright notice appear in all copies and that both that
268    copyright notice and this permission notice appear in supporting
269    documentation, and that the name of the author(s) not be used in
270    advertising or publicity pertaining to distribution of the software without
271    specific, written prior permission.  The authors make no
272    representations about the suitability of this software for any purpose.  It
273    is provided "as is" without express or implied warranty.
274   
275    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
276    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
277    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
278    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
279    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
280    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
281    PERFORMANCE OF THIS SOFTWARE.
282  -->
283     <refentry id="FcStrSetDel">
284         <refmeta>
285             <refentrytitle>FcStrSetDel</refentrytitle>
286             <manvolnum>3</manvolnum>
287             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
288         </refmeta>
289         <refnamediv>
290             <refname>FcStrSetDel</refname>
291             <refpurpose>delete from a string set</refpurpose>
292         </refnamediv>
293         <refsynopsisdiv>
294         <funcsynopsis>
295         <funcsynopsisinfo>
296 #include &lt;fontconfig/fontconfig.h&gt;
297         </funcsynopsisinfo>
298         <funcprototype>
299             <funcdef>FcBool <function>FcStrSetDel</function></funcdef>
300                 <paramdef>FcStrSet *<parameter>set</parameter></paramdef>
301                 <paramdef>const FcChar8 *<parameter>s</parameter></paramdef>
302         </funcprototype>
303         </funcsynopsis>
304         </refsynopsisdiv>
305         <refsect1><title>Description</title>
306             <para>
307 Removes <parameter>s</parameter> from <parameter>set</parameter>, returning
308 FcTrue if <parameter>s</parameter> was a member else FcFalse.
309             </para>
310         </refsect1>
311     </refentry>
312 <!--
313    fontconfig/doc/func.sgml
314   
315    Copyright © 2003 Keith Packard
316   
317    Permission to use, copy, modify, distribute, and sell this software and its
318    documentation for any purpose is hereby granted without fee, provided that
319    the above copyright notice appear in all copies and that both that
320    copyright notice and this permission notice appear in supporting
321    documentation, and that the name of the author(s) not be used in
322    advertising or publicity pertaining to distribution of the software without
323    specific, written prior permission.  The authors make no
324    representations about the suitability of this software for any purpose.  It
325    is provided "as is" without express or implied warranty.
326   
327    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
328    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
329    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
330    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
331    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
332    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
333    PERFORMANCE OF THIS SOFTWARE.
334  -->
335     <refentry id="FcStrSetDestroy">
336         <refmeta>
337             <refentrytitle>FcStrSetDestroy</refentrytitle>
338             <manvolnum>3</manvolnum>
339             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
340         </refmeta>
341         <refnamediv>
342             <refname>FcStrSetDestroy</refname>
343             <refpurpose>destroy a string set</refpurpose>
344         </refnamediv>
345         <refsynopsisdiv>
346         <funcsynopsis>
347         <funcsynopsisinfo>
348 #include &lt;fontconfig/fontconfig.h&gt;
349         </funcsynopsisinfo>
350         <funcprototype>
351             <funcdef>void <function>FcStrSetDestroy</function></funcdef>
352                 <paramdef>FcStrSet *<parameter>set</parameter></paramdef>
353         </funcprototype>
354         </funcsynopsis>
355         </refsynopsisdiv>
356         <refsect1><title>Description</title>
357             <para>
358 Destroys <parameter>set</parameter>.
359             </para>
360         </refsect1>
361     </refentry>
362 <!--
363    fontconfig/doc/func.sgml
364   
365    Copyright © 2003 Keith Packard
366   
367    Permission to use, copy, modify, distribute, and sell this software and its
368    documentation for any purpose is hereby granted without fee, provided that
369    the above copyright notice appear in all copies and that both that
370    copyright notice and this permission notice appear in supporting
371    documentation, and that the name of the author(s) not be used in
372    advertising or publicity pertaining to distribution of the software without
373    specific, written prior permission.  The authors make no
374    representations about the suitability of this software for any purpose.  It
375    is provided "as is" without express or implied warranty.
376   
377    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
378    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
379    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
380    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
381    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
382    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
383    PERFORMANCE OF THIS SOFTWARE.
384  -->
385     <refentry id="FcStrListCreate">
386         <refmeta>
387             <refentrytitle>FcStrListCreate</refentrytitle>
388             <manvolnum>3</manvolnum>
389             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
390         </refmeta>
391         <refnamediv>
392             <refname>FcStrListCreate</refname>
393             <refpurpose>create a string iterator</refpurpose>
394         </refnamediv>
395         <refsynopsisdiv>
396         <funcsynopsis>
397         <funcsynopsisinfo>
398 #include &lt;fontconfig/fontconfig.h&gt;
399         </funcsynopsisinfo>
400         <funcprototype>
401             <funcdef>FcStrList * <function>FcStrListCreate</function></funcdef>
402                 <paramdef>FcStrSet *<parameter>set</parameter></paramdef>
403         </funcprototype>
404         </funcsynopsis>
405         </refsynopsisdiv>
406         <refsect1><title>Description</title>
407             <para>
408 Creates an iterator to list the strings in <parameter>set</parameter>.
409             </para>
410         </refsect1>
411     </refentry>
412 <!--
413    fontconfig/doc/func.sgml
414   
415    Copyright © 2003 Keith Packard
416   
417    Permission to use, copy, modify, distribute, and sell this software and its
418    documentation for any purpose is hereby granted without fee, provided that
419    the above copyright notice appear in all copies and that both that
420    copyright notice and this permission notice appear in supporting
421    documentation, and that the name of the author(s) not be used in
422    advertising or publicity pertaining to distribution of the software without
423    specific, written prior permission.  The authors make no
424    representations about the suitability of this software for any purpose.  It
425    is provided "as is" without express or implied warranty.
426   
427    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
428    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
429    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
430    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
431    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
432    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
433    PERFORMANCE OF THIS SOFTWARE.
434  -->
435     <refentry id="FcStrListFirst">
436         <refmeta>
437             <refentrytitle>FcStrListFirst</refentrytitle>
438             <manvolnum>3</manvolnum>
439             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
440         </refmeta>
441         <refnamediv>
442             <refname>FcStrListFirst</refname>
443             <refpurpose>get first string in iteration</refpurpose>
444         </refnamediv>
445         <refsynopsisdiv>
446         <funcsynopsis>
447         <funcsynopsisinfo>
448 #include &lt;fontconfig/fontconfig.h&gt;
449         </funcsynopsisinfo>
450         <funcprototype>
451             <funcdef>void <function>FcStrListFirst</function></funcdef>
452                 <paramdef>FcStrList *<parameter>list</parameter></paramdef>
453         </funcprototype>
454         </funcsynopsis>
455         </refsynopsisdiv>
456         <refsect1><title>Description</title>
457             <para>
458 Returns the first string in <parameter>list</parameter>.
459             </para>
460         </refsect1>
461         <refsect1><title>Since</title>
462             <para>version 2.11.0</para>
463         </refsect1>
464     </refentry>
465 <!--
466    fontconfig/doc/func.sgml
467   
468    Copyright © 2003 Keith Packard
469   
470    Permission to use, copy, modify, distribute, and sell this software and its
471    documentation for any purpose is hereby granted without fee, provided that
472    the above copyright notice appear in all copies and that both that
473    copyright notice and this permission notice appear in supporting
474    documentation, and that the name of the author(s) not be used in
475    advertising or publicity pertaining to distribution of the software without
476    specific, written prior permission.  The authors make no
477    representations about the suitability of this software for any purpose.  It
478    is provided "as is" without express or implied warranty.
479   
480    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
481    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
482    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
483    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
484    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
485    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
486    PERFORMANCE OF THIS SOFTWARE.
487  -->
488     <refentry id="FcStrListNext">
489         <refmeta>
490             <refentrytitle>FcStrListNext</refentrytitle>
491             <manvolnum>3</manvolnum>
492             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
493         </refmeta>
494         <refnamediv>
495             <refname>FcStrListNext</refname>
496             <refpurpose>get next string in iteration</refpurpose>
497         </refnamediv>
498         <refsynopsisdiv>
499         <funcsynopsis>
500         <funcsynopsisinfo>
501 #include &lt;fontconfig/fontconfig.h&gt;
502         </funcsynopsisinfo>
503         <funcprototype>
504             <funcdef>FcChar8 * <function>FcStrListNext</function></funcdef>
505                 <paramdef>FcStrList *<parameter>list</parameter></paramdef>
506         </funcprototype>
507         </funcsynopsis>
508         </refsynopsisdiv>
509         <refsect1><title>Description</title>
510             <para>
511 Returns the next string in <parameter>list</parameter>.
512             </para>
513         </refsect1>
514     </refentry>
515 <!--
516    fontconfig/doc/func.sgml
517   
518    Copyright © 2003 Keith Packard
519   
520    Permission to use, copy, modify, distribute, and sell this software and its
521    documentation for any purpose is hereby granted without fee, provided that
522    the above copyright notice appear in all copies and that both that
523    copyright notice and this permission notice appear in supporting
524    documentation, and that the name of the author(s) not be used in
525    advertising or publicity pertaining to distribution of the software without
526    specific, written prior permission.  The authors make no
527    representations about the suitability of this software for any purpose.  It
528    is provided "as is" without express or implied warranty.
529   
530    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
531    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
532    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
533    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
534    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
535    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
536    PERFORMANCE OF THIS SOFTWARE.
537  -->
538     <refentry id="FcStrListDone">
539         <refmeta>
540             <refentrytitle>FcStrListDone</refentrytitle>
541             <manvolnum>3</manvolnum>
542             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
543         </refmeta>
544         <refnamediv>
545             <refname>FcStrListDone</refname>
546             <refpurpose>destroy a string iterator</refpurpose>
547         </refnamediv>
548         <refsynopsisdiv>
549         <funcsynopsis>
550         <funcsynopsisinfo>
551 #include &lt;fontconfig/fontconfig.h&gt;
552         </funcsynopsisinfo>
553         <funcprototype>
554             <funcdef>void <function>FcStrListDone</function></funcdef>
555                 <paramdef>FcStrList *<parameter>list</parameter></paramdef>
556         </funcprototype>
557         </funcsynopsis>
558         </refsynopsisdiv>
559         <refsect1><title>Description</title>
560             <para>
561 Destroys the enumerator <parameter>list</parameter>.
562             </para>
563         </refsect1>
564     </refentry>