doc/fontconfig-devel/fcfilescan.html

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