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