92d8f193a1a31d9ba18645bfe8cb98e1bad5bcae
[platform/upstream/fontconfig.git] / doc / fontconfig-devel / fcpatternget-type.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 >FcPatternGet-Type</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"
16 HREF="fcpatternget.html"><LINK
17 REL="NEXT"
18 TITLE="FcPatternBuild"
19 HREF="fcpatternbuild.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.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="fcpatternbuild.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="FCPATTERNGET-TYPE"
73 ></A
74 >FcPatternGet-Type</H1
75 ><DIV
76 CLASS="REFNAMEDIV"
77 ><A
78 NAME="AEN631"
79 ></A
80 ><H2
81 >Name</H2
82 >FcPatternGetInteger, FcPatternGetDouble, FcPatternGetString, FcPatternGetMatrix, FcPatternGetCharSet, FcPatternGetBool, FcPatternGetFTFace, FcPatternGetLangSet&nbsp;--&nbsp;Return a typed value from a pattern</DIV
83 ><DIV
84 CLASS="REFSYNOPSISDIV"
85 ><A
86 NAME="AEN641"
87 ></A
88 ><H2
89 >Synopsis</H2
90 ><DIV
91 CLASS="FUNCSYNOPSIS"
92 ><P
93 ></P
94 ><A
95 NAME="AEN642"
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 >FcResult <TT
115 CLASS="FUNCTION"
116 >FcPatternGetInteger</TT
117 ></CODE
118 >(FcPattern *<TT
119 CLASS="PARAMETER"
120 ><I
121 >p</I
122 ></TT
123 >, const char *<TT
124 CLASS="PARAMETER"
125 ><I
126 >object</I
127 ></TT
128 >, int <TT
129 CLASS="PARAMETER"
130 ><I
131 >n</I
132 ></TT
133 >, int *<TT
134 CLASS="PARAMETER"
135 ><I
136 >i</I
137 ></TT
138 >);</CODE
139 ></P
140 ><P
141 ><CODE
142 ><CODE
143 CLASS="FUNCDEF"
144 >FcResult <TT
145 CLASS="FUNCTION"
146 >FcPatternGetDouble</TT
147 ></CODE
148 >(FcPattern *<TT
149 CLASS="PARAMETER"
150 ><I
151 >p</I
152 ></TT
153 >, const char *<TT
154 CLASS="PARAMETER"
155 ><I
156 >object</I
157 ></TT
158 >, int <TT
159 CLASS="PARAMETER"
160 ><I
161 >n</I
162 ></TT
163 >, double *<TT
164 CLASS="PARAMETER"
165 ><I
166 >d</I
167 ></TT
168 >);</CODE
169 ></P
170 ><P
171 ><CODE
172 ><CODE
173 CLASS="FUNCDEF"
174 >FcResult <TT
175 CLASS="FUNCTION"
176 >FcPatternGetString</TT
177 ></CODE
178 >(FcPattern *<TT
179 CLASS="PARAMETER"
180 ><I
181 >p</I
182 ></TT
183 >, const char *<TT
184 CLASS="PARAMETER"
185 ><I
186 >object</I
187 ></TT
188 >, int <TT
189 CLASS="PARAMETER"
190 ><I
191 >n</I
192 ></TT
193 >, FcChar8 **<TT
194 CLASS="PARAMETER"
195 ><I
196 >s</I
197 ></TT
198 >);</CODE
199 ></P
200 ><P
201 ><CODE
202 ><CODE
203 CLASS="FUNCDEF"
204 >FcResult <TT
205 CLASS="FUNCTION"
206 >FcPatternGetMatrix</TT
207 ></CODE
208 >(FcPattern *<TT
209 CLASS="PARAMETER"
210 ><I
211 >p</I
212 ></TT
213 >, const char *<TT
214 CLASS="PARAMETER"
215 ><I
216 >object</I
217 ></TT
218 >, int <TT
219 CLASS="PARAMETER"
220 ><I
221 >n</I
222 ></TT
223 >, FcMatrix **<TT
224 CLASS="PARAMETER"
225 ><I
226 >s</I
227 ></TT
228 >);</CODE
229 ></P
230 ><P
231 ><CODE
232 ><CODE
233 CLASS="FUNCDEF"
234 >FcResult <TT
235 CLASS="FUNCTION"
236 >FcPatternGetCharSet</TT
237 ></CODE
238 >(FcPattern *<TT
239 CLASS="PARAMETER"
240 ><I
241 >p</I
242 ></TT
243 >, const char *<TT
244 CLASS="PARAMETER"
245 ><I
246 >object</I
247 ></TT
248 >, int <TT
249 CLASS="PARAMETER"
250 ><I
251 >n</I
252 ></TT
253 >, FcCharSet **<TT
254 CLASS="PARAMETER"
255 ><I
256 >c</I
257 ></TT
258 >);</CODE
259 ></P
260 ><P
261 ><CODE
262 ><CODE
263 CLASS="FUNCDEF"
264 >FcResult <TT
265 CLASS="FUNCTION"
266 >FcPatternGetBool</TT
267 ></CODE
268 >(FcPattern *<TT
269 CLASS="PARAMETER"
270 ><I
271 >p</I
272 ></TT
273 >, const char *<TT
274 CLASS="PARAMETER"
275 ><I
276 >object</I
277 ></TT
278 >, int <TT
279 CLASS="PARAMETER"
280 ><I
281 >n</I
282 ></TT
283 >, FcBool *<TT
284 CLASS="PARAMETER"
285 ><I
286 >b</I
287 ></TT
288 >);</CODE
289 ></P
290 ><P
291 ><CODE
292 ><CODE
293 CLASS="FUNCDEF"
294 >FcResult <TT
295 CLASS="FUNCTION"
296 >FcPatternGetFTFace</TT
297 ></CODE
298 >(FcPattern *<TT
299 CLASS="PARAMETER"
300 ><I
301 >p</I
302 ></TT
303 >, const char *<TT
304 CLASS="PARAMETER"
305 ><I
306 >object</I
307 ></TT
308 >, int <TT
309 CLASS="PARAMETER"
310 ><I
311 >n</I
312 ></TT
313 >);</CODE
314 ></P
315 ><P
316 ><CODE
317 ><CODE
318 CLASS="FUNCDEF"
319 >FcResult <TT
320 CLASS="FUNCTION"
321 >FcPatternGetLangSet</TT
322 ></CODE
323 >(FcPattern *<TT
324 CLASS="PARAMETER"
325 ><I
326 >p</I
327 ></TT
328 >, const char *<TT
329 CLASS="PARAMETER"
330 ><I
331 >object</I
332 ></TT
333 >, FT_Face *<TT
334 CLASS="PARAMETER"
335 ><I
336 >f</I
337 ></TT
338 >);</CODE
339 ></P
340 ><P
341 ></P
342 ></DIV
343 ></DIV
344 ><DIV
345 CLASS="REFSECT1"
346 ><A
347 NAME="AEN728"
348 ></A
349 ><H2
350 >Description</H2
351 ><P
352 >These are convenience functions that call FcPatternGet and verify that the
353 returned data is of the expected type. They return FcResultTypeMismatch if
354 this is not the case.  Note that these (like FcPatternGet) do not make a
355 copy of any data structure referenced by the return value.  Use these
356 in preference to FcPatternGet to provide compile-time typechecking.
357             </P
358 ></DIV
359 ><DIV
360 CLASS="REFSECT1"
361 ><A
362 NAME="AEN731"
363 ></A
364 ><H2
365 >Version</H2
366 ><P
367 >Fontconfig version 2.10.91
368
369             </P
370 ></DIV
371 ><DIV
372 CLASS="NAVFOOTER"
373 ><HR
374 ALIGN="LEFT"
375 WIDTH="100%"><TABLE
376 SUMMARY="Footer navigation table"
377 WIDTH="100%"
378 BORDER="0"
379 CELLPADDING="0"
380 CELLSPACING="0"
381 ><TR
382 ><TD
383 WIDTH="33%"
384 ALIGN="left"
385 VALIGN="top"
386 ><A
387 HREF="fcpatternget.html"
388 ACCESSKEY="P"
389 >&#60;&#60;&#60; Previous</A
390 ></TD
391 ><TD
392 WIDTH="34%"
393 ALIGN="center"
394 VALIGN="top"
395 ><A
396 HREF="t1.html"
397 ACCESSKEY="H"
398 >Home</A
399 ></TD
400 ><TD
401 WIDTH="33%"
402 ALIGN="right"
403 VALIGN="top"
404 ><A
405 HREF="fcpatternbuild.html"
406 ACCESSKEY="N"
407 >Next &#62;&#62;&#62;</A
408 ></TD
409 ></TR
410 ><TR
411 ><TD
412 WIDTH="33%"
413 ALIGN="left"
414 VALIGN="top"
415 >FcPatternGet</TD
416 ><TD
417 WIDTH="34%"
418 ALIGN="center"
419 VALIGN="top"
420 ><A
421 HREF="x102.html#AEN255"
422 ACCESSKEY="U"
423 >Up</A
424 ></TD
425 ><TD
426 WIDTH="33%"
427 ALIGN="right"
428 VALIGN="top"
429 >FcPatternBuild</TD
430 ></TR
431 ></TABLE
432 ></DIV
433 ></BODY
434 ></HTML
435 >