doc/fontconfig-devel/fcdirscan.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 >FcDirScan</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#AEN4403"><LINK
  14 REL="PREVIOUS"
  15 TITLE="FcFileIsDir"
  16 HREF="fcfileisdir.html"><LINK
  17 REL="NEXT"
  18 TITLE="FcDirSave"
  19 HREF="fcdirsave.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="fcfileisdir.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="fcdirsave.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="FCDIRSCAN"
  73 ></A
  74 >FcDirScan</H1
  75 ><DIV
  76 CLASS="REFNAMEDIV"
  77 ><A
  78 NAME="AEN4465"
  79 ></A
  80 ><H2
  81 >Name</H2
  82 >FcDirScan&nbsp;--&nbsp;scan a font directory without caching it</DIV
  83 ><DIV
  84 CLASS="REFSYNOPSISDIV"
  85 ><A
  86 NAME="AEN4468"
  87 ></A
  88 ><H2
  89 >Synopsis</H2
  90 ><DIV
  91 CLASS="FUNCSYNOPSIS"
  92 ><P
  93 ></P
  94 ><A
  95 NAME="AEN4469"
  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 >FcDirScan</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 >dir</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="AEN4486"
 158 ></A
 159 ><H2
 160 >Description</H2
 161 ><P
 162 >If <TT
 163 CLASS="PARAMETER"
 164 ><I
 165 >cache</I
 166 ></TT
 167 > is not zero or if <TT
 168 CLASS="PARAMETER"
 169 ><I
 170 >force</I
 171 ></TT
 172 >
 173 is FcFalse, this function currently returns FcFalse.  Otherwise, it scans an
 174 entire directory and adds all fonts found to <TT
 175 CLASS="PARAMETER"
 176 ><I
 177 >set</I
 178 ></TT
 179 >.
 180 Any subdirectories found are added to <TT
 181 CLASS="PARAMETER"
 182 ><I
 183 >dirs</I
 184 ></TT
 185 >.  Calling
 186 this function does not create any cache files.  Use FcDirCacheRead() if
 187 caching is desired.
 188             </P
 189 ></DIV
 190 ><DIV
 191 CLASS="NAVFOOTER"
 192 ><HR
 193 ALIGN="LEFT"
 194 WIDTH="100%"><TABLE
 195 SUMMARY="Footer navigation table"
 196 WIDTH="100%"
 197 BORDER="0"
 198 CELLPADDING="0"
 199 CELLSPACING="0"
 200 ><TR
 201 ><TD
 202 WIDTH="33%"
 203 ALIGN="left"
 204 VALIGN="top"
 205 ><A
 206 HREF="fcfileisdir.html"
 207 ACCESSKEY="P"
 208 >&#60;&#60;&#60; Previous</A
 209 ></TD
 210 ><TD
 211 WIDTH="34%"
 212 ALIGN="center"
 213 VALIGN="top"
 214 ><A
 215 HREF="t1.html"
 216 ACCESSKEY="H"
 217 >Home</A
 218 ></TD
 219 ><TD
 220 WIDTH="33%"
 221 ALIGN="right"
 222 VALIGN="top"
 223 ><A
 224 HREF="fcdirsave.html"
 225 ACCESSKEY="N"
 226 >Next &#62;&#62;&#62;</A
 227 ></TD
 228 ></TR
 229 ><TR
 230 ><TD
 231 WIDTH="33%"
 232 ALIGN="left"
 233 VALIGN="top"
 234 >FcFileIsDir</TD
 235 ><TD
 236 WIDTH="34%"
 237 ALIGN="center"
 238 VALIGN="top"
 239 ><A
 240 HREF="x103.html#AEN4403"
 241 ACCESSKEY="U"
 242 >Up</A
 243 ></TD
 244 ><TD
 245 WIDTH="33%"
 246 ALIGN="right"
 247 VALIGN="top"
 248 >FcDirSave</TD
 249 ></TR
 250 ></TABLE
 251 ></DIV
 252 ></BODY
 253 ></HTML
 254 >