1 2<!doctype html> 3<html lang="en" class="no-js"> 4 <head> 5 6 <meta charset="utf-8"> 7 <meta name="viewport" content="width=device-width,initial-scale=1"> 8 9 <meta name="description" content="API Reference Documentation for FreeType-2.12.1"> 10 11 12 13 <meta name="author" content="FreeType Contributors"> 14 15 16 <link rel="icon" href="images/favico.ico"> 17 <meta name="generator" content="mkdocs-1.2.1, mkdocs-material-7.1.9"> 18 19 20 21 <title>Error Enumerations - FreeType-2.12.1 API Reference</title> 22 23 24 25 <link rel="stylesheet" href="assets/stylesheets/main.ca7ac06f.min.css"> 26 27 28 <link rel="stylesheet" href="assets/stylesheets/palette.f1a3b89f.min.css"> 29 30 31 32 <meta name="theme-color" content="#4cae4f"> 33 34 35 36 37 38 39 40 <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin> 41 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Noto+Serif:300,400,400i,700%7CRoboto+Mono&display=fallback"> 42 <style>:root{--md-text-font-family:"Noto Serif";--md-code-font-family:"Roboto Mono"}</style> 43 44 45 46 47 <link rel="stylesheet" href="stylesheets/extra.css"> 48 49 50 51 52 53 54 55 </head> 56 57 58 59 60 61 62 63 <body dir="ltr" data-md-color-scheme="" data-md-color-primary="green" data-md-color-accent="green"> 64 65 66 <script>function __prefix(e){return new URL(".",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script> 67 68 <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off"> 69 <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off"> 70 <label class="md-overlay" for="__drawer"></label> 71 <div data-md-component="skip"> 72 73 74 <a href="#error-enumerations" class="md-skip"> 75 Skip to content 76 </a> 77 78 </div> 79 <div data-md-component="announce"> 80 81 </div> 82 83 <header class="md-header" data-md-component="header"> 84 <nav class="md-header__inner md-grid" aria-label="Header"> 85 <a href="index.html" title="FreeType-2.12.1 API Reference" class="md-header__button md-logo" aria-label="FreeType-2.12.1 API Reference" data-md-component="logo"> 86 87 <img src="images/favico.ico" alt="logo"> 88 89 </a> 90 <label class="md-header__button md-icon" for="__drawer"> 91 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg> 92 </label> 93 <div class="md-header__title" data-md-component="header-title"> 94 <div class="md-header__ellipsis"> 95 <div class="md-header__topic"> 96 <span class="md-ellipsis"> 97 FreeType-2.12.1 API Reference 98 </span> 99 </div> 100 <div class="md-header__topic" data-md-component="header-topic"> 101 <span class="md-ellipsis"> 102 103 Error Enumerations 104 105 </span> 106 </div> 107 </div> 108 </div> 109 110 111 112 <label class="md-header__button md-icon" for="__search"> 113 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg> 114 </label> 115 116<div class="md-search" data-md-component="search" role="dialog"> 117 <label class="md-search__overlay" for="__search"></label> 118 <div class="md-search__inner" role="search"> 119 <form class="md-search__form" name="search"> 120 <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" data-md-state="active" required> 121 <label class="md-search__icon md-icon" for="__search"> 122 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg> 123 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg> 124 </label> 125 <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1"> 126 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg> 127 </button> 128 </form> 129 <div class="md-search__output"> 130 <div class="md-search__scrollwrap" data-md-scrollfix> 131 <div class="md-search-result" data-md-component="search-result"> 132 <div class="md-search-result__meta"> 133 Initializing search 134 </div> 135 <ol class="md-search-result__list"></ol> 136 </div> 137 </div> 138 </div> 139 </div> 140</div> 141 142 143 </nav> 144</header> 145 146 <div class="md-container" data-md-component="container"> 147 148 149 150 151 <main class="md-main" data-md-component="main"> 152 <div class="md-main__inner md-grid"> 153 154 155 156 <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" > 157 <div class="md-sidebar__scrollwrap"> 158 <div class="md-sidebar__inner"> 159 160 161 162<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0"> 163 <label class="md-nav__title" for="__drawer"> 164 <a href="index.html" title="FreeType-2.12.1 API Reference" class="md-nav__button md-logo" aria-label="FreeType-2.12.1 API Reference" data-md-component="logo"> 165 166 <img src="images/favico.ico" alt="logo"> 167 168 </a> 169 FreeType-2.12.1 API Reference 170 </label> 171 172 <ul class="md-nav__list" data-md-scrollfix> 173 174 175 176 177 178 179 180 181 <li class="md-nav__item"> 182 <a href="index.html" class="md-nav__link"> 183 TOC 184 </a> 185 </li> 186 187 188 189 190 191 192 193 194 195 196 <li class="md-nav__item"> 197 <a href="ft2-index.html" class="md-nav__link"> 198 Index 199 </a> 200 </li> 201 202 203 204 205 206 207 208 209 210 211 212 <li class="md-nav__item md-nav__item--nested"> 213 214 215 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" > 216 217 <label class="md-nav__link" for="__nav_3"> 218 General Remarks 219 <span class="md-nav__icon md-icon"></span> 220 </label> 221 <nav class="md-nav" aria-label="General Remarks" data-md-level="1"> 222 <label class="md-nav__title" for="__nav_3"> 223 <span class="md-nav__icon md-icon"></span> 224 General Remarks 225 </label> 226 <ul class="md-nav__list" data-md-scrollfix> 227 228 229 230 231 232 <li class="md-nav__item"> 233 <a href="ft2-preamble.html" class="md-nav__link"> 234 Preamble 235 </a> 236 </li> 237 238 239 240 241 242 243 244 <li class="md-nav__item"> 245 <a href="ft2-header_inclusion.html" class="md-nav__link"> 246 FreeType's header inclusion scheme 247 </a> 248 </li> 249 250 251 252 253 254 255 256 <li class="md-nav__item"> 257 <a href="ft2-user_allocation.html" class="md-nav__link"> 258 User allocation 259 </a> 260 </li> 261 262 263 264 </ul> 265 </nav> 266 </li> 267 268 269 270 271 272 273 274 275 276 277 278 <li class="md-nav__item md-nav__item--nested"> 279 280 281 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" > 282 283 <label class="md-nav__link" for="__nav_4"> 284 Core API 285 <span class="md-nav__icon md-icon"></span> 286 </label> 287 <nav class="md-nav" aria-label="Core API" data-md-level="1"> 288 <label class="md-nav__title" for="__nav_4"> 289 <span class="md-nav__icon md-icon"></span> 290 Core API 291 </label> 292 <ul class="md-nav__list" data-md-scrollfix> 293 294 295 296 297 298 <li class="md-nav__item"> 299 <a href="ft2-version.html" class="md-nav__link"> 300 FreeType Version 301 </a> 302 </li> 303 304 305 306 307 308 309 310 <li class="md-nav__item"> 311 <a href="ft2-basic_types.html" class="md-nav__link"> 312 Basic Data Types 313 </a> 314 </li> 315 316 317 318 319 320 321 322 <li class="md-nav__item"> 323 <a href="ft2-base_interface.html" class="md-nav__link"> 324 Base Interface 325 </a> 326 </li> 327 328 329 330 331 332 333 334 <li class="md-nav__item"> 335 <a href="ft2-glyph_variants.html" class="md-nav__link"> 336 Unicode Variation Sequences 337 </a> 338 </li> 339 340 341 342 343 344 345 346 <li class="md-nav__item"> 347 <a href="ft2-color_management.html" class="md-nav__link"> 348 Glyph Color Management 349 </a> 350 </li> 351 352 353 354 355 356 357 358 <li class="md-nav__item"> 359 <a href="ft2-layer_management.html" class="md-nav__link"> 360 Glyph Layer Management 361 </a> 362 </li> 363 364 365 366 367 368 369 370 <li class="md-nav__item"> 371 <a href="ft2-glyph_management.html" class="md-nav__link"> 372 Glyph Management 373 </a> 374 </li> 375 376 377 378 379 380 381 382 <li class="md-nav__item"> 383 <a href="ft2-mac_specific.html" class="md-nav__link"> 384 Mac Specific Interface 385 </a> 386 </li> 387 388 389 390 391 392 393 394 <li class="md-nav__item"> 395 <a href="ft2-sizes_management.html" class="md-nav__link"> 396 Size Management 397 </a> 398 </li> 399 400 401 402 403 404 405 406 <li class="md-nav__item"> 407 <a href="ft2-header_file_macros.html" class="md-nav__link"> 408 Header File Macros 409 </a> 410 </li> 411 412 413 414 </ul> 415 </nav> 416 </li> 417 418 419 420 421 422 423 424 425 426 427 428 <li class="md-nav__item md-nav__item--nested"> 429 430 431 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" > 432 433 <label class="md-nav__link" for="__nav_5"> 434 Format-Specific API 435 <span class="md-nav__icon md-icon"></span> 436 </label> 437 <nav class="md-nav" aria-label="Format-Specific API" data-md-level="1"> 438 <label class="md-nav__title" for="__nav_5"> 439 <span class="md-nav__icon md-icon"></span> 440 Format-Specific API 441 </label> 442 <ul class="md-nav__list" data-md-scrollfix> 443 444 445 446 447 448 <li class="md-nav__item"> 449 <a href="ft2-multiple_masters.html" class="md-nav__link"> 450 Multiple Masters 451 </a> 452 </li> 453 454 455 456 457 458 459 460 <li class="md-nav__item"> 461 <a href="ft2-truetype_tables.html" class="md-nav__link"> 462 TrueType Tables 463 </a> 464 </li> 465 466 467 468 469 470 471 472 <li class="md-nav__item"> 473 <a href="ft2-type1_tables.html" class="md-nav__link"> 474 Type 1 Tables 475 </a> 476 </li> 477 478 479 480 481 482 483 484 <li class="md-nav__item"> 485 <a href="ft2-sfnt_names.html" class="md-nav__link"> 486 SFNT Names 487 </a> 488 </li> 489 490 491 492 493 494 495 496 <li class="md-nav__item"> 497 <a href="ft2-bdf_fonts.html" class="md-nav__link"> 498 BDF and PCF Files 499 </a> 500 </li> 501 502 503 504 505 506 507 508 <li class="md-nav__item"> 509 <a href="ft2-cid_fonts.html" class="md-nav__link"> 510 CID Fonts 511 </a> 512 </li> 513 514 515 516 517 518 519 520 <li class="md-nav__item"> 521 <a href="ft2-pfr_fonts.html" class="md-nav__link"> 522 PFR Fonts 523 </a> 524 </li> 525 526 527 528 529 530 531 532 <li class="md-nav__item"> 533 <a href="ft2-winfnt_fonts.html" class="md-nav__link"> 534 Window FNT Files 535 </a> 536 </li> 537 538 539 540 541 542 543 544 <li class="md-nav__item"> 545 <a href="ft2-svg_fonts.html" class="md-nav__link"> 546 OpenType SVG Fonts 547 </a> 548 </li> 549 550 551 552 553 554 555 556 <li class="md-nav__item"> 557 <a href="ft2-font_formats.html" class="md-nav__link"> 558 Font Formats 559 </a> 560 </li> 561 562 563 564 565 566 567 568 <li class="md-nav__item"> 569 <a href="ft2-gasp_table.html" class="md-nav__link"> 570 Gasp Table 571 </a> 572 </li> 573 574 575 576 </ul> 577 </nav> 578 </li> 579 580 581 582 583 584 585 586 587 588 589 590 <li class="md-nav__item md-nav__item--nested"> 591 592 593 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" > 594 595 <label class="md-nav__link" for="__nav_6"> 596 Controlling FreeType Modules 597 <span class="md-nav__icon md-icon"></span> 598 </label> 599 <nav class="md-nav" aria-label="Controlling FreeType Modules" data-md-level="1"> 600 <label class="md-nav__title" for="__nav_6"> 601 <span class="md-nav__icon md-icon"></span> 602 Controlling FreeType Modules 603 </label> 604 <ul class="md-nav__list" data-md-scrollfix> 605 606 607 608 609 610 <li class="md-nav__item"> 611 <a href="ft2-auto_hinter.html" class="md-nav__link"> 612 The auto-hinter 613 </a> 614 </li> 615 616 617 618 619 620 621 622 <li class="md-nav__item"> 623 <a href="ft2-cff_driver.html" class="md-nav__link"> 624 The CFF driver 625 </a> 626 </li> 627 628 629 630 631 632 633 634 <li class="md-nav__item"> 635 <a href="ft2-t1_cid_driver.html" class="md-nav__link"> 636 The Type 1 and CID drivers 637 </a> 638 </li> 639 640 641 642 643 644 645 646 <li class="md-nav__item"> 647 <a href="ft2-tt_driver.html" class="md-nav__link"> 648 The TrueType driver 649 </a> 650 </li> 651 652 653 654 655 656 657 658 <li class="md-nav__item"> 659 <a href="ft2-pcf_driver.html" class="md-nav__link"> 660 The PCF driver 661 </a> 662 </li> 663 664 665 666 667 668 669 670 <li class="md-nav__item"> 671 <a href="ft2-ot_svg_driver.html" class="md-nav__link"> 672 The SVG driver 673 </a> 674 </li> 675 676 677 678 679 680 681 682 <li class="md-nav__item"> 683 <a href="ft2-properties.html" class="md-nav__link"> 684 Driver properties 685 </a> 686 </li> 687 688 689 690 691 692 693 694 <li class="md-nav__item"> 695 <a href="ft2-parameter_tags.html" class="md-nav__link"> 696 Parameter Tags 697 </a> 698 </li> 699 700 701 702 703 704 705 706 <li class="md-nav__item"> 707 <a href="ft2-lcd_rendering.html" class="md-nav__link"> 708 Subpixel Rendering 709 </a> 710 </li> 711 712 713 714 </ul> 715 </nav> 716 </li> 717 718 719 720 721 722 723 724 725 726 727 728 <li class="md-nav__item md-nav__item--nested"> 729 730 731 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" > 732 733 <label class="md-nav__link" for="__nav_7"> 734 Cache Sub-System 735 <span class="md-nav__icon md-icon"></span> 736 </label> 737 <nav class="md-nav" aria-label="Cache Sub-System" data-md-level="1"> 738 <label class="md-nav__title" for="__nav_7"> 739 <span class="md-nav__icon md-icon"></span> 740 Cache Sub-System 741 </label> 742 <ul class="md-nav__list" data-md-scrollfix> 743 744 745 746 747 748 <li class="md-nav__item"> 749 <a href="ft2-cache_subsystem.html" class="md-nav__link"> 750 Cache Sub-System 751 </a> 752 </li> 753 754 755 756 </ul> 757 </nav> 758 </li> 759 760 761 762 763 764 765 766 767 768 769 770 <li class="md-nav__item md-nav__item--nested"> 771 772 773 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" > 774 775 <label class="md-nav__link" for="__nav_8"> 776 Support API 777 <span class="md-nav__icon md-icon"></span> 778 </label> 779 <nav class="md-nav" aria-label="Support API" data-md-level="1"> 780 <label class="md-nav__title" for="__nav_8"> 781 <span class="md-nav__icon md-icon"></span> 782 Support API 783 </label> 784 <ul class="md-nav__list" data-md-scrollfix> 785 786 787 788 789 790 <li class="md-nav__item"> 791 <a href="ft2-computations.html" class="md-nav__link"> 792 Computations 793 </a> 794 </li> 795 796 797 798 799 800 801 802 <li class="md-nav__item"> 803 <a href="ft2-list_processing.html" class="md-nav__link"> 804 List Processing 805 </a> 806 </li> 807 808 809 810 811 812 813 814 <li class="md-nav__item"> 815 <a href="ft2-outline_processing.html" class="md-nav__link"> 816 Outline Processing 817 </a> 818 </li> 819 820 821 822 823 824 825 826 <li class="md-nav__item"> 827 <a href="ft2-quick_advance.html" class="md-nav__link"> 828 Quick retrieval of advance values 829 </a> 830 </li> 831 832 833 834 835 836 837 838 <li class="md-nav__item"> 839 <a href="ft2-bitmap_handling.html" class="md-nav__link"> 840 Bitmap Handling 841 </a> 842 </li> 843 844 845 846 847 848 849 850 <li class="md-nav__item"> 851 <a href="ft2-raster.html" class="md-nav__link"> 852 Scanline Converter 853 </a> 854 </li> 855 856 857 858 859 860 861 862 <li class="md-nav__item"> 863 <a href="ft2-glyph_stroker.html" class="md-nav__link"> 864 Glyph Stroker 865 </a> 866 </li> 867 868 869 870 871 872 873 874 <li class="md-nav__item"> 875 <a href="ft2-system_interface.html" class="md-nav__link"> 876 System Interface 877 </a> 878 </li> 879 880 881 882 883 884 885 886 <li class="md-nav__item"> 887 <a href="ft2-module_management.html" class="md-nav__link"> 888 Module Management 889 </a> 890 </li> 891 892 893 894 895 896 897 898 <li class="md-nav__item"> 899 <a href="ft2-gzip.html" class="md-nav__link"> 900 GZIP Streams 901 </a> 902 </li> 903 904 905 906 907 908 909 910 <li class="md-nav__item"> 911 <a href="ft2-lzw.html" class="md-nav__link"> 912 LZW Streams 913 </a> 914 </li> 915 916 917 918 919 920 921 922 <li class="md-nav__item"> 923 <a href="ft2-bzip2.html" class="md-nav__link"> 924 BZIP2 Streams 925 </a> 926 </li> 927 928 929 930 931 932 933 934 <li class="md-nav__item"> 935 <a href="ft2-debugging_apis.html" class="md-nav__link"> 936 External Debugging APIs 937 </a> 938 </li> 939 940 941 942 </ul> 943 </nav> 944 </li> 945 946 947 948 949 950 951 952 953 954 955 956 957 958 <li class="md-nav__item md-nav__item--active md-nav__item--nested"> 959 960 961 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9" type="checkbox" id="__nav_9" checked> 962 963 <label class="md-nav__link" for="__nav_9"> 964 Error Codes 965 <span class="md-nav__icon md-icon"></span> 966 </label> 967 <nav class="md-nav" aria-label="Error Codes" data-md-level="1"> 968 <label class="md-nav__title" for="__nav_9"> 969 <span class="md-nav__icon md-icon"></span> 970 Error Codes 971 </label> 972 <ul class="md-nav__list" data-md-scrollfix> 973 974 975 976 977 978 979 980 <li class="md-nav__item md-nav__item--active"> 981 982 <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc"> 983 984 985 986 987 988 <label class="md-nav__link md-nav__link--active" for="__toc"> 989 Error Enumerations 990 <span class="md-nav__icon md-icon"></span> 991 </label> 992 993 <a href="ft2-error_enumerations.html" class="md-nav__link md-nav__link--active"> 994 Error Enumerations 995 </a> 996 997 998<nav class="md-nav md-nav--secondary" aria-label="Table of contents"> 999 1000 1001 1002 1003 1004 1005 <label class="md-nav__title" for="__toc"> 1006 <span class="md-nav__icon md-icon"></span> 1007 Table of contents 1008 </label> 1009 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> 1010 1011 <li class="md-nav__item"> 1012 <a href="#synopsis" class="md-nav__link"> 1013 Synopsis 1014 </a> 1015 1016</li> 1017 1018 <li class="md-nav__item"> 1019 <a href="#ft_error_string" class="md-nav__link"> 1020 FT_Error_String 1021 </a> 1022 1023</li> 1024 1025 </ul> 1026 1027</nav> 1028 1029 </li> 1030 1031 1032 1033 1034 1035 1036 1037 <li class="md-nav__item"> 1038 <a href="ft2-error_code_values.html" class="md-nav__link"> 1039 Error Code Values 1040 </a> 1041 </li> 1042 1043 1044 1045 </ul> 1046 </nav> 1047 </li> 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 <li class="md-nav__item md-nav__item--nested"> 1060 1061 1062 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_10" type="checkbox" id="__nav_10" > 1063 1064 <label class="md-nav__link" for="__nav_10"> 1065 Miscellaneous 1066 <span class="md-nav__icon md-icon"></span> 1067 </label> 1068 <nav class="md-nav" aria-label="Miscellaneous" data-md-level="1"> 1069 <label class="md-nav__title" for="__nav_10"> 1070 <span class="md-nav__icon md-icon"></span> 1071 Miscellaneous 1072 </label> 1073 <ul class="md-nav__list" data-md-scrollfix> 1074 1075 1076 1077 1078 1079 <li class="md-nav__item"> 1080 <a href="ft2-gx_validation.html" class="md-nav__link"> 1081 TrueTypeGX/AAT Validation 1082 </a> 1083 </li> 1084 1085 1086 1087 1088 1089 1090 1091 <li class="md-nav__item"> 1092 <a href="ft2-incremental.html" class="md-nav__link"> 1093 Incremental Loading 1094 </a> 1095 </li> 1096 1097 1098 1099 1100 1101 1102 1103 <li class="md-nav__item"> 1104 <a href="ft2-truetype_engine.html" class="md-nav__link"> 1105 The TrueType Engine 1106 </a> 1107 </li> 1108 1109 1110 1111 1112 1113 1114 1115 <li class="md-nav__item"> 1116 <a href="ft2-ot_validation.html" class="md-nav__link"> 1117 OpenType Validation 1118 </a> 1119 </li> 1120 1121 1122 1123 </ul> 1124 </nav> 1125 </li> 1126 1127 1128 1129 </ul> 1130</nav> 1131 </div> 1132 </div> 1133 </div> 1134 1135 1136 1137 <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" > 1138 <div class="md-sidebar__scrollwrap"> 1139 <div class="md-sidebar__inner"> 1140 1141<nav class="md-nav md-nav--secondary" aria-label="Table of contents"> 1142 1143 1144 1145 1146 1147 1148 <label class="md-nav__title" for="__toc"> 1149 <span class="md-nav__icon md-icon"></span> 1150 Table of contents 1151 </label> 1152 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> 1153 1154 <li class="md-nav__item"> 1155 <a href="#synopsis" class="md-nav__link"> 1156 Synopsis 1157 </a> 1158 1159</li> 1160 1161 <li class="md-nav__item"> 1162 <a href="#ft_error_string" class="md-nav__link"> 1163 FT_Error_String 1164 </a> 1165 1166</li> 1167 1168 </ul> 1169 1170</nav> 1171 </div> 1172 </div> 1173 </div> 1174 1175 1176 <div class="md-content" data-md-component="content"> 1177 <article class="md-content__inner md-typeset"> 1178 1179 1180 1181 <p><a href="https://www.freetype.org">FreeType</a> » <a href="../">Docs</a> » <a href="index.html#error-codes">Error Codes</a> » Error Enumerations</p> 1182<hr /> 1183<h1 id="error-enumerations">Error Enumerations<a class="headerlink" href="#error-enumerations" title="Permanent link">¶</a></h1> 1184<h2 id="synopsis">Synopsis<a class="headerlink" href="#synopsis" title="Permanent link">¶</a></h2> 1185<p>The header file <code>fterrors.h</code> (which is automatically included by <code>freetype.h</code> defines the handling of FreeType's enumeration constants. It can also be used to generate error message strings with a small macro trick explained below.</p> 1186<p><strong>Error Formats</strong></p> 1187<p>The configuration macro <code>FT_CONFIG_OPTION_USE_MODULE_ERRORS</code> can be defined in <code>ftoption.h</code> in order to make the higher byte indicate the module where the error has happened (this is not compatible with standard builds of FreeType 2, however). See the file <code>ftmoderr.h</code> for more details.</p> 1188<p><strong>Error Message Strings</strong></p> 1189<p>Error definitions are set up with special macros that allow client applications to build a table of error message strings. The strings are not included in a normal build of FreeType 2 to save space (most client applications do not use them).</p> 1190<p>To do so, you have to define the following macros before including this file. 1191<div class="highlight"><pre><span></span><code> FT_ERROR_START_LIST 1192</code></pre></div></p> 1193<p>This macro is called before anything else to define the start of the error list. It is followed by several <code>FT_ERROR_DEF</code> calls. 1194<div class="highlight"><pre><span></span><code> FT_ERROR_DEF( e, v, s ) 1195</code></pre></div></p> 1196<p>This macro is called to define one single error. ‘e’ is the error code identifier (e.g., <code>Invalid_Argument</code>), ‘v’ is the error's numerical value, and ‘s’ is the corresponding error string. 1197<div class="highlight"><pre><span></span><code> FT_ERROR_END_LIST 1198</code></pre></div></p> 1199<p>This macro ends the list.</p> 1200<p>Additionally, you have to undefine <code>FTERRORS_H_</code> before #including this file.</p> 1201<p>Here is a simple example. 1202<div class="highlight"><pre><span></span><code> #undef FTERRORS_H_ 1203 #define FT_ERRORDEF( e, v, s ) { e, s }, 1204 #define FT_ERROR_START_LIST { 1205 #define FT_ERROR_END_LIST { 0, NULL } }; 1206 1207 const struct 1208 { 1209 int err_code; 1210 const char* err_msg; 1211 } ft_errors[] = 1212 1213 #include <freetype/fterrors.h> 1214</code></pre></div></p> 1215<p>An alternative to using an array is a switch statement. 1216<div class="highlight"><pre><span></span><code> #undef FTERRORS_H_ 1217 #define FT_ERROR_START_LIST switch ( error_code ) { 1218 #define FT_ERRORDEF( e, v, s ) case v: return s; 1219 #define FT_ERROR_END_LIST } 1220</code></pre></div></p> 1221<p>If you use <code>FT_CONFIG_OPTION_USE_MODULE_ERRORS</code>, <code>error_code</code> should be replaced with <code>FT_ERROR_BASE(error_code)</code> in the last example.</p> 1222<h2 id="ft_error_string">FT_Error_String<a class="headerlink" href="#ft_error_string" title="Permanent link">¶</a></h2> 1223<p>Defined in FT_ERRORS_H (freetype/fterrors.h).</p> 1224<div class = "codehilite"><pre><code> FT_EXPORT( <span class="keyword">const</span> <span class="keyword">char</span>* ) 1225 <b>FT_Error_String</b>( <a href="ft2-basic_types.html#ft_error">FT_Error</a> error_code ); 1226</code></pre></div> 1227 1228<p>Retrieve the description of a valid FreeType error code.</p> 1229<h4>input</h4> 1230<table class="fields"> 1231<tr><td class="val" id="error_code">error_code</td><td class="desc"> 1232<p>A valid FreeType error code.</p> 1233</td></tr> 1234</table> 1235 1236<h4>return</h4> 1237 1238<p>A C string or <code>NULL</code>, if any error occurred.</p> 1239<h4>note</h4> 1240 1241<p>FreeType has to be compiled with <code>FT_CONFIG_OPTION_ERROR_STRINGS</code> or <code>FT_DEBUG_LEVEL_ERROR</code> to get meaningful descriptions. ‘error_string’ will be <code>NULL</code> otherwise.</p> 1242<p>Module identification will be ignored: 1243<div class="highlight"><pre><span></span><code> <span class="n">strcmp</span><span class="p">(</span> <span class="n">FT_Error_String</span><span class="p">(</span> <span class="n">FT_Err_Unknown_File_Format</span> <span class="p">),</span> 1244 <span class="n">FT_Error_String</span><span class="p">(</span> <span class="n">BDF_Err_Unknown_File_Format</span> <span class="p">)</span> <span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">;</span> 1245</code></pre></div></p> 1246<hr> 1247 1248 1249 1250 1251 1252 1253 1254 </article> 1255 </div> 1256 </div> 1257 1258 </main> 1259 1260 1261<footer class="md-footer"> 1262 1263 <nav class="md-footer__inner md-grid" aria-label="Footer"> 1264 1265 1266 <a href="ft2-debugging_apis.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: External Debugging APIs" rel="prev"> 1267 <div class="md-footer__button md-icon"> 1268 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg> 1269 </div> 1270 <div class="md-footer__title"> 1271 <div class="md-ellipsis"> 1272 <span class="md-footer__direction"> 1273 Previous 1274 </span> 1275 External Debugging APIs 1276 </div> 1277 </div> 1278 </a> 1279 1280 1281 1282 <a href="ft2-error_code_values.html" class="md-footer__link md-footer__link--next" aria-label="Next: Error Code Values" rel="next"> 1283 <div class="md-footer__title"> 1284 <div class="md-ellipsis"> 1285 <span class="md-footer__direction"> 1286 Next 1287 </span> 1288 Error Code Values 1289 </div> 1290 </div> 1291 <div class="md-footer__button md-icon"> 1292 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg> 1293 </div> 1294 </a> 1295 1296 </nav> 1297 1298 <div class="md-footer-meta md-typeset"> 1299 <div class="md-footer-meta__inner md-grid"> 1300 <div class="md-footer-copyright"> 1301 1302 <div class="md-footer-copyright__highlight"> 1303 Copyright 2022 <a href = "https://www.freetype.org/license.html">The FreeType Project</a>. 1304 </div> 1305 1306 Made with 1307 <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener"> 1308 Material for MkDocs 1309 </a> 1310 1311 </div> 1312 1313 </div> 1314 </div> 1315</footer> 1316 1317 </div> 1318 <div class="md-dialog" data-md-component="dialog"> 1319 <div class="md-dialog__inner md-typeset"></div> 1320 </div> 1321 <script id="__config" type="application/json">{"base": ".", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "assets/javascripts/workers/search.477d984a.min.js", "version": null}</script> 1322 1323 1324 <script src="assets/javascripts/bundle.82b56eb2.min.js"></script> 1325 1326 <script src="javascripts/extra.js"></script> 1327 1328 1329 </body> 1330</html>