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