doc/fontconfig-devel/fcfilescan.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>FcFileScan</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REL="HOME"
HREF="t1.html"><LINK
REL="UP"
TITLE="File and Directory routines"
HREF="x102.html#AEN3871"><LINK
REL="PREVIOUS"
TITLE="FUNCTIONS"
HREF="x102.html"><LINK
REL="NEXT"
TITLE="FcFileIsDir"
HREF="fcfileisdir.html"></HEAD
><BODY
CLASS="REFENTRY"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
></TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="x102.html"
ACCESSKEY="P"
>&#60;&#60;&#60; Previous</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="fcfileisdir.html"
ACCESSKEY="N"
>Next &#62;&#62;&#62;</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="FCFILESCAN"
></A
>FcFileScan</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN3878"
></A
><H2
>Name</H2
>FcFileScan&nbsp;--&nbsp;scan a font file</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN3881"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN3882"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
	</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcFileScan</TT
></CODE
>(FcFontSet *<TT
CLASS="PARAMETER"
><I
>set</I
></TT
>, FcStrSet *<TT
CLASS="PARAMETER"
><I
>dirs</I
></TT
>, FcFileCache *<TT
CLASS="PARAMETER"
><I
>cache</I
></TT
>, FcBlanks *<TT
CLASS="PARAMETER"
><I
>blanks</I
></TT
>, const FcChar8 *<TT
CLASS="PARAMETER"
><I
>file</I
></TT
>, FcBool <TT
CLASS="PARAMETER"
><I
>force</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3899"
></A
><H2
>Description</H2
><P
>Scans a single file and adds all fonts found to <TT
CLASS="PARAMETER"
><I
>set</I
></TT
>.
If <TT
CLASS="PARAMETER"
><I
>force</I
></TT
> is FcTrue, then the file is scanned even if
associated information is found in <TT
CLASS="PARAMETER"
><I
>cache</I
></TT
>.  If
<TT
CLASS="PARAMETER"
><I
>file</I
></TT
> is a directory, it is added to
<TT
CLASS="PARAMETER"
><I
>dirs</I
></TT
>. Whether fonts are found depends on fontconfig
policy as well as the current configuration. Internally, fontconfig will
ignore BDF and PCF fonts which are not in Unicode (or the effectively
equivalent ISO Latin-1) encoding as those are not usable by Unicode-based
applications. The configuration can ignore fonts based on filename or
contents of the font file itself. Returns FcFalse if any of the fonts cannot be
added (due to allocation failure). Otherwise returns FcTrue.
	    </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3907"
></A
><H2
>Version</H2
><P
>Fontconfig version 2.10.93

	    </P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="x102.html"
ACCESSKEY="P"
>&#60;&#60;&#60; Previous</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="t1.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="fcfileisdir.html"
ACCESSKEY="N"
>Next &#62;&#62;&#62;</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>FUNCTIONS</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="x102.html#AEN3871"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>FcFileIsDir</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>