FcFontSort.3 revision a6844aab 
1.\\" auto-generated by docbook2man-spec $Revision: 1.1.1.2 $
2.TH "FcFontSort" "3" "18 November 2009" "" ""
3.SH NAME
4FcFontSort \- Return list of matching fonts
5.SH SYNOPSIS
6.nf
7\fB#include <fontconfig.h>
8.sp
9FcFontSet * FcFontSort(FcConfig *\fIconfig\fB);
10(FcPattern *\fIp\fB);
11(FcBool \fItrim\fB);
12(FcCharSet **\fIcsp\fB);
13(FcResult *\fIresult\fB);
14\fR.fi
15.SH "DESCRIPTION"
16.PP
17Returns the list of fonts sorted by closeness to \fIp\fR\&. If \fItrim\fR is FcTrue,
18elements in the list which don't include Unicode coverage not provided by
19earlier elements in the list are elided. The union of Unicode coverage of
20all of the fonts is returned in \fIcsp\fR, if \fIcsp\fR is not NULL. This function
21should be called only after FcConfigSubstitute and FcDefaultSubstitute have
22been called for \fIp\fR; otherwise the results will not be correct.
23.PP
24The returned FcFontSet references FcPattern structures which may be shared
25by the return value from multiple FcFontSort calls, applications must not
26modify these patterns. Instead, they should be passed, along with \fIp\fR to
27\fBFcFontRenderPrepare\fR which combines them into a complete pattern.
28.PP
29The FcFontSet returned by FcFontSort is destroyed by caling FcFontSetDestroy.
30If \fIconfig\fR is NULL, the current configuration is used.
31.SH "VERSION"
32.PP
33Fontconfig version 2.8.0
34