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