fcfilescan.html revision a6844aab 
1a6844aabSmrg<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/loose.dtd">
2a6844aabSmrg<HTML
3a6844aabSmrg><HEAD
4a6844aabSmrg><TITLE
5a6844aabSmrg>FcFileScan</TITLE
6a6844aabSmrg><META
7a6844aabSmrgNAME="GENERATOR"
8a6844aabSmrgCONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
9a6844aabSmrgREL="HOME"
10a6844aabSmrgHREF="t1.html"><LINK
11a6844aabSmrgREL="UP"
12a6844aabSmrgTITLE="File and Directory routines"
13a6844aabSmrgHREF="x102.html#AEN3706"><LINK
14a6844aabSmrgREL="PREVIOUS"
15a6844aabSmrgTITLE="FUNCTIONS"
16a6844aabSmrgHREF="x102.html"><LINK
17a6844aabSmrgREL="NEXT"
18a6844aabSmrgTITLE="FcFileIsDir"
19a6844aabSmrgHREF="fcfileisdir.html"></HEAD
20a6844aabSmrg><BODY
21a6844aabSmrgCLASS="REFENTRY"
22a6844aabSmrgBGCOLOR="#FFFFFF"
23a6844aabSmrgTEXT="#000000"
24a6844aabSmrgLINK="#0000FF"
25a6844aabSmrgVLINK="#840084"
26a6844aabSmrgALINK="#0000FF"
27a6844aabSmrg><DIV
28a6844aabSmrgCLASS="NAVHEADER"
29a6844aabSmrg><TABLE
30a6844aabSmrgSUMMARY="Header navigation table"
31a6844aabSmrgWIDTH="100%"
32a6844aabSmrgBORDER="0"
33a6844aabSmrgCELLPADDING="0"
34a6844aabSmrgCELLSPACING="0"
35a6844aabSmrg><TR
36a6844aabSmrg><TH
37a6844aabSmrgCOLSPAN="3"
38a6844aabSmrgALIGN="center"
39a6844aabSmrg></TH
40a6844aabSmrg></TR
41a6844aabSmrg><TR
42a6844aabSmrg><TD
43a6844aabSmrgWIDTH="10%"
44a6844aabSmrgALIGN="left"
45a6844aabSmrgVALIGN="bottom"
46a6844aabSmrg><A
47a6844aabSmrgHREF="x102.html"
48a6844aabSmrgACCESSKEY="P"
49a6844aabSmrg>&#60;&#60;&#60; Previous</A
50a6844aabSmrg></TD
51a6844aabSmrg><TD
52a6844aabSmrgWIDTH="80%"
53a6844aabSmrgALIGN="center"
54a6844aabSmrgVALIGN="bottom"
55a6844aabSmrg></TD
56a6844aabSmrg><TD
57a6844aabSmrgWIDTH="10%"
58a6844aabSmrgALIGN="right"
59a6844aabSmrgVALIGN="bottom"
60a6844aabSmrg><A
61a6844aabSmrgHREF="fcfileisdir.html"
62a6844aabSmrgACCESSKEY="N"
63a6844aabSmrg>Next &#62;&#62;&#62;</A
64a6844aabSmrg></TD
65a6844aabSmrg></TR
66a6844aabSmrg></TABLE
67a6844aabSmrg><HR
68a6844aabSmrgALIGN="LEFT"
69a6844aabSmrgWIDTH="100%"></DIV
70a6844aabSmrg><H1
71a6844aabSmrg><A
72a6844aabSmrgNAME="FCFILESCAN"
73a6844aabSmrg></A
74a6844aabSmrg>FcFileScan</H1
75a6844aabSmrg><DIV
76a6844aabSmrgCLASS="REFNAMEDIV"
77a6844aabSmrg><A
78a6844aabSmrgNAME="AEN3713"
79a6844aabSmrg></A
80a6844aabSmrg><H2
81a6844aabSmrg>Name</H2
82a6844aabSmrg>FcFileScan&nbsp;--&nbsp;scan a font file</DIV
83a6844aabSmrg><DIV
84a6844aabSmrgCLASS="REFSYNOPSISDIV"
85a6844aabSmrg><A
86a6844aabSmrgNAME="AEN3716"
87a6844aabSmrg></A
88a6844aabSmrg><H2
89a6844aabSmrg>Synopsis</H2
90a6844aabSmrg><DIV
91a6844aabSmrgCLASS="FUNCSYNOPSIS"
92a6844aabSmrg><P
93a6844aabSmrg></P
94a6844aabSmrg><A
95a6844aabSmrgNAME="AEN3717"
96a6844aabSmrg></A
97a6844aabSmrg><TABLE
98a6844aabSmrgBORDER="0"
99a6844aabSmrgBGCOLOR="#E0E0E0"
100a6844aabSmrgWIDTH="100%"
101a6844aabSmrg><TR
102a6844aabSmrg><TD
103a6844aabSmrg><PRE
104a6844aabSmrgCLASS="FUNCSYNOPSISINFO"
105a6844aabSmrg>#include &#60;fontconfig.h&#62;
106a6844aabSmrg	</PRE
107a6844aabSmrg></TD
108a6844aabSmrg></TR
109a6844aabSmrg></TABLE
110a6844aabSmrg><P
111a6844aabSmrg><CODE
112a6844aabSmrg><CODE
113a6844aabSmrgCLASS="FUNCDEF"
114a6844aabSmrg>FcBool <TT
115a6844aabSmrgCLASS="FUNCTION"
116a6844aabSmrg>FcFileScan</TT
117a6844aabSmrg></CODE
118a6844aabSmrg>(FcFontSet *<TT
119a6844aabSmrgCLASS="PARAMETER"
120a6844aabSmrg><I
121a6844aabSmrg>set</I
122a6844aabSmrg></TT
123a6844aabSmrg>, FcStrSet *<TT
124a6844aabSmrgCLASS="PARAMETER"
125a6844aabSmrg><I
126a6844aabSmrg>dirs</I
127a6844aabSmrg></TT
128a6844aabSmrg>, FcFileCache *<TT
129a6844aabSmrgCLASS="PARAMETER"
130a6844aabSmrg><I
131a6844aabSmrg>cache</I
132a6844aabSmrg></TT
133a6844aabSmrg>, FcBlanks *<TT
134a6844aabSmrgCLASS="PARAMETER"
135a6844aabSmrg><I
136a6844aabSmrg>blanks</I
137a6844aabSmrg></TT
138a6844aabSmrg>, const FcChar8 *<TT
139a6844aabSmrgCLASS="PARAMETER"
140a6844aabSmrg><I
141a6844aabSmrg>file</I
142a6844aabSmrg></TT
143a6844aabSmrg>, FcBool <TT
144a6844aabSmrgCLASS="PARAMETER"
145a6844aabSmrg><I
146a6844aabSmrg>force</I
147a6844aabSmrg></TT
148a6844aabSmrg>);</CODE
149a6844aabSmrg></P
150a6844aabSmrg><P
151a6844aabSmrg></P
152a6844aabSmrg></DIV
153a6844aabSmrg></DIV
154a6844aabSmrg><DIV
155a6844aabSmrgCLASS="REFSECT1"
156a6844aabSmrg><A
157a6844aabSmrgNAME="AEN3734"
158a6844aabSmrg></A
159a6844aabSmrg><H2
160a6844aabSmrg>Description</H2
161a6844aabSmrg><P
162a6844aabSmrg>Scans a single file and adds all fonts found to <TT
163a6844aabSmrgCLASS="PARAMETER"
164a6844aabSmrg><I
165a6844aabSmrg>set</I
166a6844aabSmrg></TT
167a6844aabSmrg>.
168a6844aabSmrgIf <TT
169a6844aabSmrgCLASS="PARAMETER"
170a6844aabSmrg><I
171a6844aabSmrg>force</I
172a6844aabSmrg></TT
173a6844aabSmrg> is FcTrue, then the file is scanned even if
174a6844aabSmrgassociated information is found in <TT
175a6844aabSmrgCLASS="PARAMETER"
176a6844aabSmrg><I
177a6844aabSmrg>cache</I
178a6844aabSmrg></TT
179a6844aabSmrg>.  If
180a6844aabSmrg<TT
181a6844aabSmrgCLASS="PARAMETER"
182a6844aabSmrg><I
183a6844aabSmrg>file</I
184a6844aabSmrg></TT
185a6844aabSmrg> is a directory, it is added to
186a6844aabSmrg<TT
187a6844aabSmrgCLASS="PARAMETER"
188a6844aabSmrg><I
189a6844aabSmrg>dirs</I
190a6844aabSmrg></TT
191a6844aabSmrg>. Whether fonts are found depends on fontconfig
192a6844aabSmrgpolicy as well as the current configuration. Internally, fontconfig will
193a6844aabSmrgignore BDF and PCF fonts which are not in Unicode (or the effectively
194a6844aabSmrgequivalent ISO Latin-1) encoding as those are not usable by Unicode-based
195a6844aabSmrgapplications. The configuration can ignore fonts based on filename or
196a6844aabSmrgcontents of the font file itself. Returns FcFalse if any of the fonts cannot be
197a6844aabSmrgadded (due to allocation failure). Otherwise returns FcTrue.
198a6844aabSmrg	    </P
199a6844aabSmrg></DIV
200a6844aabSmrg><DIV
201a6844aabSmrgCLASS="REFSECT1"
202a6844aabSmrg><A
203a6844aabSmrgNAME="AEN3742"
204a6844aabSmrg></A
205a6844aabSmrg><H2
206a6844aabSmrg>Version</H2
207a6844aabSmrg><P
208a6844aabSmrg>Fontconfig version 2.8.0
209a6844aabSmrg
210a6844aabSmrg	    </P
211a6844aabSmrg></DIV
212a6844aabSmrg><DIV
213a6844aabSmrgCLASS="NAVFOOTER"
214a6844aabSmrg><HR
215a6844aabSmrgALIGN="LEFT"
216a6844aabSmrgWIDTH="100%"><TABLE
217a6844aabSmrgSUMMARY="Footer navigation table"
218a6844aabSmrgWIDTH="100%"
219a6844aabSmrgBORDER="0"
220a6844aabSmrgCELLPADDING="0"
221a6844aabSmrgCELLSPACING="0"
222a6844aabSmrg><TR
223a6844aabSmrg><TD
224a6844aabSmrgWIDTH="33%"
225a6844aabSmrgALIGN="left"
226a6844aabSmrgVALIGN="top"
227a6844aabSmrg><A
228a6844aabSmrgHREF="x102.html"
229a6844aabSmrgACCESSKEY="P"
230a6844aabSmrg>&#60;&#60;&#60; Previous</A
231a6844aabSmrg></TD
232a6844aabSmrg><TD
233a6844aabSmrgWIDTH="34%"
234a6844aabSmrgALIGN="center"
235a6844aabSmrgVALIGN="top"
236a6844aabSmrg><A
237a6844aabSmrgHREF="t1.html"
238a6844aabSmrgACCESSKEY="H"
239a6844aabSmrg>Home</A
240a6844aabSmrg></TD
241a6844aabSmrg><TD
242a6844aabSmrgWIDTH="33%"
243a6844aabSmrgALIGN="right"
244a6844aabSmrgVALIGN="top"
245a6844aabSmrg><A
246a6844aabSmrgHREF="fcfileisdir.html"
247a6844aabSmrgACCESSKEY="N"
248a6844aabSmrg>Next &#62;&#62;&#62;</A
249a6844aabSmrg></TD
250a6844aabSmrg></TR
251a6844aabSmrg><TR
252a6844aabSmrg><TD
253a6844aabSmrgWIDTH="33%"
254a6844aabSmrgALIGN="left"
255a6844aabSmrgVALIGN="top"
256a6844aabSmrg>FUNCTIONS</TD
257a6844aabSmrg><TD
258a6844aabSmrgWIDTH="34%"
259a6844aabSmrgALIGN="center"
260a6844aabSmrgVALIGN="top"
261a6844aabSmrg><A
262a6844aabSmrgHREF="x102.html#AEN3706"
263a6844aabSmrgACCESSKEY="U"
264a6844aabSmrg>Up</A
265a6844aabSmrg></TD
266a6844aabSmrg><TD
267a6844aabSmrgWIDTH="33%"
268a6844aabSmrgALIGN="right"
269a6844aabSmrgVALIGN="top"
270a6844aabSmrg>FcFileIsDir</TD
271a6844aabSmrg></TR
272a6844aabSmrg></TABLE
273a6844aabSmrg></DIV
274a6844aabSmrg></BODY
275a6844aabSmrg></HTML
276a6844aabSmrg>