095c602ceb08f43e4d62226d3f06943a69a36798
[platform/upstream/fontconfig.git] / doc / fontconfig-devel / fcpatternbuild.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <HTML
3 ><HEAD
4 ><TITLE
5 >FcPatternBuild</TITLE
6 ><META
7 NAME="GENERATOR"
8 CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
9 REL="HOME"
10 HREF="t1.html"><LINK
11 REL="UP"
12 TITLE="FcPattern"
13 HREF="x102.html#AEN255"><LINK
14 REL="PREVIOUS"
15 TITLE="FcPatternGet-Type"
16 HREF="fcpatternget-type.html"><LINK
17 REL="NEXT"
18 TITLE="FcPatternDel"
19 HREF="fcpatterndel.html"></HEAD
20 ><BODY
21 CLASS="REFENTRY"
22 BGCOLOR="#FFFFFF"
23 TEXT="#000000"
24 LINK="#0000FF"
25 VLINK="#840084"
26 ALINK="#0000FF"
27 ><DIV
28 CLASS="NAVHEADER"
29 ><TABLE
30 SUMMARY="Header navigation table"
31 WIDTH="100%"
32 BORDER="0"
33 CELLPADDING="0"
34 CELLSPACING="0"
35 ><TR
36 ><TH
37 COLSPAN="3"
38 ALIGN="center"
39 ></TH
40 ></TR
41 ><TR
42 ><TD
43 WIDTH="10%"
44 ALIGN="left"
45 VALIGN="bottom"
46 ><A
47 HREF="fcpatternget-type.html"
48 ACCESSKEY="P"
49 >&#60;&#60;&#60; Previous</A
50 ></TD
51 ><TD
52 WIDTH="80%"
53 ALIGN="center"
54 VALIGN="bottom"
55 ></TD
56 ><TD
57 WIDTH="10%"
58 ALIGN="right"
59 VALIGN="bottom"
60 ><A
61 HREF="fcpatterndel.html"
62 ACCESSKEY="N"
63 >Next &#62;&#62;&#62;</A
64 ></TD
65 ></TR
66 ></TABLE
67 ><HR
68 ALIGN="LEFT"
69 WIDTH="100%"></DIV
70 ><H1
71 ><A
72 NAME="FCPATTERNBUILD"
73 ></A
74 >FcPatternBuild</H1
75 ><DIV
76 CLASS="REFNAMEDIV"
77 ><A
78 NAME="AEN738"
79 ></A
80 ><H2
81 >Name</H2
82 >FcPatternBuild, FcPatternVaBuild, FcPatternVapBuild&nbsp;--&nbsp;Create patterns from arguments</DIV
83 ><DIV
84 CLASS="REFSYNOPSISDIV"
85 ><A
86 NAME="AEN743"
87 ></A
88 ><H2
89 >Synopsis</H2
90 ><DIV
91 CLASS="FUNCSYNOPSIS"
92 ><P
93 ></P
94 ><A
95 NAME="AEN744"
96 ></A
97 ><TABLE
98 BORDER="0"
99 BGCOLOR="#E0E0E0"
100 WIDTH="100%"
101 ><TR
102 ><TD
103 ><PRE
104 CLASS="FUNCSYNOPSISINFO"
105 >#include &#60;fontconfig/fontconfig.h&#62;
106         </PRE
107 ></TD
108 ></TR
109 ></TABLE
110 ><P
111 ><CODE
112 ><CODE
113 CLASS="FUNCDEF"
114 >FcPattern * <TT
115 CLASS="FUNCTION"
116 >FcPatternBuild</TT
117 ></CODE
118 >(FcPattern *<TT
119 CLASS="PARAMETER"
120 ><I
121 >pattern</I
122 ></TT
123 >, ...<TT
124 CLASS="PARAMETER"
125 ><I
126 ></I
127 ></TT
128 >);</CODE
129 ></P
130 ><P
131 ><CODE
132 ><CODE
133 CLASS="FUNCDEF"
134 >FcPattern * <TT
135 CLASS="FUNCTION"
136 >FcPatternVaBuild</TT
137 ></CODE
138 >(FcPattern *<TT
139 CLASS="PARAMETER"
140 ><I
141 >pattern</I
142 ></TT
143 >, va_list <TT
144 CLASS="PARAMETER"
145 ><I
146 >va</I
147 ></TT
148 >);</CODE
149 ></P
150 ><P
151 ><CODE
152 ><CODE
153 CLASS="FUNCDEF"
154 >void <TT
155 CLASS="FUNCTION"
156 >FcPatternVapBuild</TT
157 ></CODE
158 >(FcPattern *<TT
159 CLASS="PARAMETER"
160 ><I
161 >result</I
162 ></TT
163 >, FcPattern *<TT
164 CLASS="PARAMETER"
165 ><I
166 >pattern</I
167 ></TT
168 >, va_list <TT
169 CLASS="PARAMETER"
170 ><I
171 >va</I
172 ></TT
173 >);</CODE
174 ></P
175 ><P
176 ></P
177 ></DIV
178 ></DIV
179 ><DIV
180 CLASS="REFSECT1"
181 ><A
182 NAME="AEN769"
183 ></A
184 ><H2
185 >Description</H2
186 ><P
187 >Builds a pattern using a list of objects, types and values.  Each
188 value to be entered in the pattern is specified with three arguments:</P
189 ><P
190 ></P
191 ><OL
192 TYPE="1"
193 ><LI
194 ><P
195 >Object name, a string describing the property to be added.</P
196 ></LI
197 ><LI
198 ><P
199 >Object type, one of the FcType enumerated values</P
200 ></LI
201 ><LI
202 ><P
203 >Value, not an FcValue, but the raw type as passed to any of the
204 FcPatternAdd&#60;type&#62; functions.  Must match the type of the second
205 argument.</P
206 ></LI
207 ></OL
208 ><P
209 >The argument list is terminated by a null object name, no object type nor
210 value need be passed for this.  The values are added to `pattern', if
211 `pattern' is null, a new pattern is created.  In either case, the pattern is
212 returned. Example</P
213 ><TABLE
214 BORDER="0"
215 BGCOLOR="#E0E0E0"
216 WIDTH="100%"
217 ><TR
218 ><TD
219 ><PRE
220 CLASS="PROGRAMLISTING"
221 >pattern = FcPatternBuild (0, FC_FAMILY, FcTypeString, "Times", (char *) 0);</PRE
222 ></TD
223 ></TR
224 ></TABLE
225 ><P
226 >FcPatternVaBuild is used when the arguments are already in the form of a
227 varargs value. FcPatternVapBuild is a macro version of FcPatternVaBuild
228 which returns its result directly in the <TT
229 CLASS="PARAMETER"
230 ><I
231 >result</I
232 ></TT
233 >
234 variable.
235             </P
236 ></DIV
237 ><DIV
238 CLASS="REFSECT1"
239 ><A
240 NAME="AEN783"
241 ></A
242 ><H2
243 >Version</H2
244 ><P
245 >Fontconfig version 2.10.91
246
247             </P
248 ></DIV
249 ><DIV
250 CLASS="NAVFOOTER"
251 ><HR
252 ALIGN="LEFT"
253 WIDTH="100%"><TABLE
254 SUMMARY="Footer navigation table"
255 WIDTH="100%"
256 BORDER="0"
257 CELLPADDING="0"
258 CELLSPACING="0"
259 ><TR
260 ><TD
261 WIDTH="33%"
262 ALIGN="left"
263 VALIGN="top"
264 ><A
265 HREF="fcpatternget-type.html"
266 ACCESSKEY="P"
267 >&#60;&#60;&#60; Previous</A
268 ></TD
269 ><TD
270 WIDTH="34%"
271 ALIGN="center"
272 VALIGN="top"
273 ><A
274 HREF="t1.html"
275 ACCESSKEY="H"
276 >Home</A
277 ></TD
278 ><TD
279 WIDTH="33%"
280 ALIGN="right"
281 VALIGN="top"
282 ><A
283 HREF="fcpatterndel.html"
284 ACCESSKEY="N"
285 >Next &#62;&#62;&#62;</A
286 ></TD
287 ></TR
288 ><TR
289 ><TD
290 WIDTH="33%"
291 ALIGN="left"
292 VALIGN="top"
293 >FcPatternGet-Type</TD
294 ><TD
295 WIDTH="34%"
296 ALIGN="center"
297 VALIGN="top"
298 ><A
299 HREF="x102.html#AEN255"
300 ACCESSKEY="U"
301 >Up</A
302 ></TD
303 ><TD
304 WIDTH="33%"
305 ALIGN="right"
306 VALIGN="top"
307 >FcPatternDel</TD
308 ></TR
309 ></TABLE
310 ></DIV
311 ></BODY
312 ></HTML
313 >