Imported Upstream version 2.14.2
[platform/upstream/fontconfig.git] / doc / FcFileScan.3
1 .\" auto-generated by docbook2man-spec from docbook-utils package
2 .TH "FcFileScan" "3" "27 1月 2023" "Fontconfig 2.14.2" ""
3 .SH NAME
4 FcFileScan \- scan a font file
5 .SH SYNOPSIS
6 .nf
7 \fB#include <fontconfig/fontconfig.h>
8 .sp
9 FcBool FcFileScan (FcFontSet *\fIset\fB, FcStrSet *\fIdirs\fB, FcFileCache *\fIcache\fB, FcBlanks *\fIblanks\fB, const FcChar8 *\fIfile\fB, FcBool \fIforce\fB);
10 .fi\fR
11 .SH "DESCRIPTION"
12 .PP
13 Scans a single file and adds all fonts found to \fIset\fR\&.
14 If \fIforce\fR is FcTrue, then the file is scanned even if
15 associated information is found in \fIcache\fR\&. If
16 \fIfile\fR is a directory, it is added to
17 \fIdirs\fR\&. Whether fonts are found depends on fontconfig
18 policy as well as the current configuration. Internally, fontconfig will
19 ignore BDF and PCF fonts which are not in Unicode (or the effectively
20 equivalent ISO Latin-1) encoding as those are not usable by Unicode-based
21 applications. The configuration can ignore fonts based on filename or
22 contents of the font file itself. Returns FcFalse if any of the fonts cannot be
23 added (due to allocation failure). Otherwise returns FcTrue.