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#AEN241"><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="AEN605"
  79 ></A
  80 ><H2
  81 >Name</H2
  82 >FcPatternGetInteger, FcPatternGetDouble, FcPatternGetString, FcPatternGetMatrix, FcPatternGetCharSet, FcPatternGetBool, FcPatternGetFTFace, FcPatternGetLangSet, FcPatternGetRange&nbsp;--&nbsp;Return a typed value from a pattern</DIV
  83 ><DIV
  84 CLASS="REFSYNOPSISDIV"
  85 ><A
  86 NAME="AEN616"
  87 ></A
  88 ><H2
  89 >Synopsis</H2
  90 ><DIV
  91 CLASS="FUNCSYNOPSIS"
  92 ><P
  93 ></P
  94 ><A
  95 NAME="AEN617"
  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 >, FT_Face *<TT
 314 CLASS="PARAMETER"
 315 ><I
 316 >f</I
 317 ></TT
 318 >);</CODE
 319 ></P
 320 ><P
 321 ><CODE
 322 ><CODE
 323 CLASS="FUNCDEF"
 324 >FcResult <TT
 325 CLASS="FUNCTION"
 326 >FcPatternGetLangSet</TT
 327 ></CODE
 328 >(FcPattern *<TT
 329 CLASS="PARAMETER"
 330 ><I
 331 >p</I
 332 ></TT
 333 >, const char *<TT
 334 CLASS="PARAMETER"
 335 ><I
 336 >object</I
 337 ></TT
 338 >, int <TT
 339 CLASS="PARAMETER"
 340 ><I
 341 >n</I
 342 ></TT
 343 >, FcLangSet **<TT
 344 CLASS="PARAMETER"
 345 ><I
 346 >l</I
 347 ></TT
 348 >);</CODE
 349 ></P
 350 ><P
 351 ><CODE
 352 ><CODE
 353 CLASS="FUNCDEF"
 354 >FcResult <TT
 355 CLASS="FUNCTION"
 356 >FcPatternGetRange</TT
 357 ></CODE
 358 >(FcPattern *<TT
 359 CLASS="PARAMETER"
 360 ><I
 361 >p</I
 362 ></TT
 363 >, const char *<TT
 364 CLASS="PARAMETER"
 365 ><I
 366 >object</I
 367 ></TT
 368 >, int <TT
 369 CLASS="PARAMETER"
 370 ><I
 371 >n</I
 372 ></TT
 373 >, FcRange **<TT
 374 CLASS="PARAMETER"
 375 ><I
 376 >r</I
 377 ></TT
 378 >);</CODE
 379 ></P
 380 ><P
 381 ></P
 382 ></DIV
 383 ></DIV
 384 ><DIV
 385 CLASS="REFSECT1"
 386 ><A
 387 NAME="AEN718"
 388 ></A
 389 ><H2
 390 >Description</H2
 391 ><P
 392 >These are convenience functions that call FcPatternGet and verify that the
 393 returned data is of the expected type. They return FcResultTypeMismatch if
 394 this is not the case.  Note that these (like FcPatternGet) do not make a
 395 copy of any data structure referenced by the return value.  Use these
 396 in preference to FcPatternGet to provide compile-time typechecking.
 397
 398 <TT
 399 CLASS="FUNCTION"
 400 >FcPatternGetRange</TT
 401 > are available since 2.11.91.
 402             </P
 403 ></DIV
 404 ><DIV
 405 CLASS="NAVFOOTER"
 406 ><HR
 407 ALIGN="LEFT"
 408 WIDTH="100%"><TABLE
 409 SUMMARY="Footer navigation table"
 410 WIDTH="100%"
 411 BORDER="0"
 412 CELLPADDING="0"
 413 CELLSPACING="0"
 414 ><TR
 415 ><TD
 416 WIDTH="33%"
 417 ALIGN="left"
 418 VALIGN="top"
 419 ><A
 420 HREF="fcpatternget.html"
 421 ACCESSKEY="P"
 422 >&#60;&#60;&#60; Previous</A
 423 ></TD
 424 ><TD
 425 WIDTH="34%"
 426 ALIGN="center"
 427 VALIGN="top"
 428 ><A
 429 HREF="t1.html"
 430 ACCESSKEY="H"
 431 >Home</A
 432 ></TD
 433 ><TD
 434 WIDTH="33%"
 435 ALIGN="right"
 436 VALIGN="top"
 437 ><A
 438 HREF="fcpatternbuild.html"
 439 ACCESSKEY="N"
 440 >Next &#62;&#62;&#62;</A
 441 ></TD
 442 ></TR
 443 ><TR
 444 ><TD
 445 WIDTH="33%"
 446 ALIGN="left"
 447 VALIGN="top"
 448 >FcPatternGet</TD
 449 ><TD
 450 WIDTH="34%"
 451 ALIGN="center"
 452 VALIGN="top"
 453 ><A
 454 HREF="x102.html#AEN241"
 455 ACCESSKEY="U"
 456 >Up</A
 457 ></TD
 458 ><TD
 459 WIDTH="33%"
 460 ALIGN="right"
 461 VALIGN="top"
 462 >FcPatternBuild</TD
 463 ></TR
 464 ></TABLE
 465 ></DIV
 466 ></BODY
 467 ></HTML
 468 >