docs/reference/ft2-error_enumerations.html

   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.13.2">
  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.4.3, mkdocs-material-7.1.9">
  18
  19
  20
  21         <title>Error Enumerations - FreeType-2.13.2 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.13.2 API Reference" class="md-header__button md-logo" aria-label="FreeType-2.13.2 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.13.2 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.13.2 API Reference" class="md-nav__button md-logo" aria-label="FreeType-2.13.2 API Reference" data-md-component="logo">
 165
 166   <img src="images/favico.ico" alt="logo">
 167
 168     </a>
 169     FreeType-2.13.2 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-basic_types.html" class="md-nav__link">
 300         Basic Data Types
 301       </a>
 302     </li>
 303
 304
 305
 306
 307
 308
 309
 310     <li class="md-nav__item">
 311       <a href="ft2-library_setup.html" class="md-nav__link">
 312         Library Setup
 313       </a>
 314     </li>
 315
 316
 317
 318
 319
 320
 321
 322     <li class="md-nav__item">
 323       <a href="ft2-face_creation.html" class="md-nav__link">
 324         Face Creation
 325       </a>
 326     </li>
 327
 328
 329
 330
 331
 332
 333
 334     <li class="md-nav__item">
 335       <a href="ft2-font_testing_macros.html" class="md-nav__link">
 336         Font Testing Macros
 337       </a>
 338     </li>
 339
 340
 341
 342
 343
 344
 345
 346     <li class="md-nav__item">
 347       <a href="ft2-sizing_and_scaling.html" class="md-nav__link">
 348         Sizing and Scaling
 349       </a>
 350     </li>
 351
 352
 353
 354
 355
 356
 357
 358     <li class="md-nav__item">
 359       <a href="ft2-glyph_retrieval.html" class="md-nav__link">
 360         Glyph Retrieval
 361       </a>
 362     </li>
 363
 364
 365
 366
 367
 368
 369
 370     <li class="md-nav__item">
 371       <a href="ft2-character_mapping.html" class="md-nav__link">
 372         Character Mapping
 373       </a>
 374     </li>
 375
 376
 377
 378
 379
 380
 381
 382     <li class="md-nav__item">
 383       <a href="ft2-information_retrieval.html" class="md-nav__link">
 384         Information Retrieval
 385       </a>
 386     </li>
 387
 388
 389
 390
 391
 392
 393
 394     <li class="md-nav__item">
 395       <a href="ft2-other_api_data.html" class="md-nav__link">
 396         Other API Data
 397       </a>
 398     </li>
 399
 400
 401
 402         </ul>
 403       </nav>
 404     </li>
 405
 406
 407
 408
 409
 410
 411
 412
 413
 414
 415
 416     <li class="md-nav__item md-nav__item--nested">
 417
 418
 419         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
 420
 421       <label class="md-nav__link" for="__nav_5">
 422         Extended API
 423         <span class="md-nav__icon md-icon"></span>
 424       </label>
 425       <nav class="md-nav" aria-label="Extended API" data-md-level="1">
 426         <label class="md-nav__title" for="__nav_5">
 427           <span class="md-nav__icon md-icon"></span>
 428           Extended API
 429         </label>
 430         <ul class="md-nav__list" data-md-scrollfix>
 431
 432
 433
 434
 435
 436     <li class="md-nav__item">
 437       <a href="ft2-glyph_variants.html" class="md-nav__link">
 438         Unicode Variation Sequences
 439       </a>
 440     </li>
 441
 442
 443
 444
 445
 446
 447
 448     <li class="md-nav__item">
 449       <a href="ft2-color_management.html" class="md-nav__link">
 450         Glyph Color Management
 451       </a>
 452     </li>
 453
 454
 455
 456
 457
 458
 459
 460     <li class="md-nav__item">
 461       <a href="ft2-layer_management.html" class="md-nav__link">
 462         Glyph Layer Management
 463       </a>
 464     </li>
 465
 466
 467
 468
 469
 470
 471
 472     <li class="md-nav__item">
 473       <a href="ft2-glyph_management.html" class="md-nav__link">
 474         Glyph Management
 475       </a>
 476     </li>
 477
 478
 479
 480
 481
 482
 483
 484     <li class="md-nav__item">
 485       <a href="ft2-mac_specific.html" class="md-nav__link">
 486         Mac Specific Interface
 487       </a>
 488     </li>
 489
 490
 491
 492
 493
 494
 495
 496     <li class="md-nav__item">
 497       <a href="ft2-sizes_management.html" class="md-nav__link">
 498         Size Management
 499       </a>
 500     </li>
 501
 502
 503
 504
 505
 506
 507
 508     <li class="md-nav__item">
 509       <a href="ft2-header_file_macros.html" class="md-nav__link">
 510         Header File Macros
 511       </a>
 512     </li>
 513
 514
 515
 516         </ul>
 517       </nav>
 518     </li>
 519
 520
 521
 522
 523
 524
 525
 526
 527
 528
 529
 530     <li class="md-nav__item md-nav__item--nested">
 531
 532
 533         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
 534
 535       <label class="md-nav__link" for="__nav_6">
 536         Format-Specific API
 537         <span class="md-nav__icon md-icon"></span>
 538       </label>
 539       <nav class="md-nav" aria-label="Format-Specific API" data-md-level="1">
 540         <label class="md-nav__title" for="__nav_6">
 541           <span class="md-nav__icon md-icon"></span>
 542           Format-Specific API
 543         </label>
 544         <ul class="md-nav__list" data-md-scrollfix>
 545
 546
 547
 548
 549
 550     <li class="md-nav__item">
 551       <a href="ft2-multiple_masters.html" class="md-nav__link">
 552         Multiple Masters
 553       </a>
 554     </li>
 555
 556
 557
 558
 559
 560
 561
 562     <li class="md-nav__item">
 563       <a href="ft2-truetype_tables.html" class="md-nav__link">
 564         TrueType Tables
 565       </a>
 566     </li>
 567
 568
 569
 570
 571
 572
 573
 574     <li class="md-nav__item">
 575       <a href="ft2-type1_tables.html" class="md-nav__link">
 576         Type 1 Tables
 577       </a>
 578     </li>
 579
 580
 581
 582
 583
 584
 585
 586     <li class="md-nav__item">
 587       <a href="ft2-sfnt_names.html" class="md-nav__link">
 588         SFNT Names
 589       </a>
 590     </li>
 591
 592
 593
 594
 595
 596
 597
 598     <li class="md-nav__item">
 599       <a href="ft2-bdf_fonts.html" class="md-nav__link">
 600         BDF and PCF Files
 601       </a>
 602     </li>
 603
 604
 605
 606
 607
 608
 609
 610     <li class="md-nav__item">
 611       <a href="ft2-cid_fonts.html" class="md-nav__link">
 612         CID Fonts
 613       </a>
 614     </li>
 615
 616
 617
 618
 619
 620
 621
 622     <li class="md-nav__item">
 623       <a href="ft2-pfr_fonts.html" class="md-nav__link">
 624         PFR Fonts
 625       </a>
 626     </li>
 627
 628
 629
 630
 631
 632
 633
 634     <li class="md-nav__item">
 635       <a href="ft2-winfnt_fonts.html" class="md-nav__link">
 636         Window FNT Files
 637       </a>
 638     </li>
 639
 640
 641
 642
 643
 644
 645
 646     <li class="md-nav__item">
 647       <a href="ft2-svg_fonts.html" class="md-nav__link">
 648         OpenType SVG Fonts
 649       </a>
 650     </li>
 651
 652
 653
 654
 655
 656
 657
 658     <li class="md-nav__item">
 659       <a href="ft2-font_formats.html" class="md-nav__link">
 660         Font Formats
 661       </a>
 662     </li>
 663
 664
 665
 666
 667
 668
 669
 670     <li class="md-nav__item">
 671       <a href="ft2-gasp_table.html" class="md-nav__link">
 672         Gasp Table
 673       </a>
 674     </li>
 675
 676
 677
 678         </ul>
 679       </nav>
 680     </li>
 681
 682
 683
 684
 685
 686
 687
 688
 689
 690
 691
 692     <li class="md-nav__item md-nav__item--nested">
 693
 694
 695         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
 696
 697       <label class="md-nav__link" for="__nav_7">
 698         Controlling FreeType Modules
 699         <span class="md-nav__icon md-icon"></span>
 700       </label>
 701       <nav class="md-nav" aria-label="Controlling FreeType Modules" data-md-level="1">
 702         <label class="md-nav__title" for="__nav_7">
 703           <span class="md-nav__icon md-icon"></span>
 704           Controlling FreeType Modules
 705         </label>
 706         <ul class="md-nav__list" data-md-scrollfix>
 707
 708
 709
 710
 711
 712     <li class="md-nav__item">
 713       <a href="ft2-auto_hinter.html" class="md-nav__link">
 714         The auto-hinter
 715       </a>
 716     </li>
 717
 718
 719
 720
 721
 722
 723
 724     <li class="md-nav__item">
 725       <a href="ft2-cff_driver.html" class="md-nav__link">
 726         The CFF driver
 727       </a>
 728     </li>
 729
 730
 731
 732
 733
 734
 735
 736     <li class="md-nav__item">
 737       <a href="ft2-t1_cid_driver.html" class="md-nav__link">
 738         The Type 1 and CID drivers
 739       </a>
 740     </li>
 741
 742
 743
 744
 745
 746
 747
 748     <li class="md-nav__item">
 749       <a href="ft2-tt_driver.html" class="md-nav__link">
 750         The TrueType driver
 751       </a>
 752     </li>
 753
 754
 755
 756
 757
 758
 759
 760     <li class="md-nav__item">
 761       <a href="ft2-pcf_driver.html" class="md-nav__link">
 762         The PCF driver
 763       </a>
 764     </li>
 765
 766
 767
 768
 769
 770
 771
 772     <li class="md-nav__item">
 773       <a href="ft2-ot_svg_driver.html" class="md-nav__link">
 774         The SVG driver
 775       </a>
 776     </li>
 777
 778
 779
 780
 781
 782
 783
 784     <li class="md-nav__item">
 785       <a href="ft2-properties.html" class="md-nav__link">
 786         Driver properties
 787       </a>
 788     </li>
 789
 790
 791
 792
 793
 794
 795
 796     <li class="md-nav__item">
 797       <a href="ft2-parameter_tags.html" class="md-nav__link">
 798         Parameter Tags
 799       </a>
 800     </li>
 801
 802
 803
 804
 805
 806
 807
 808     <li class="md-nav__item">
 809       <a href="ft2-lcd_rendering.html" class="md-nav__link">
 810         Subpixel Rendering
 811       </a>
 812     </li>
 813
 814
 815
 816         </ul>
 817       </nav>
 818     </li>
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830     <li class="md-nav__item md-nav__item--nested">
 831
 832
 833         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" >
 834
 835       <label class="md-nav__link" for="__nav_8">
 836         Cache Sub-System
 837         <span class="md-nav__icon md-icon"></span>
 838       </label>
 839       <nav class="md-nav" aria-label="Cache Sub-System" data-md-level="1">
 840         <label class="md-nav__title" for="__nav_8">
 841           <span class="md-nav__icon md-icon"></span>
 842           Cache Sub-System
 843         </label>
 844         <ul class="md-nav__list" data-md-scrollfix>
 845
 846
 847
 848
 849
 850     <li class="md-nav__item">
 851       <a href="ft2-cache_subsystem.html" class="md-nav__link">
 852         Cache Sub-System
 853       </a>
 854     </li>
 855
 856
 857
 858         </ul>
 859       </nav>
 860     </li>
 861
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871
 872     <li class="md-nav__item md-nav__item--nested">
 873
 874
 875         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9" type="checkbox" id="__nav_9" >
 876
 877       <label class="md-nav__link" for="__nav_9">
 878         Support API
 879         <span class="md-nav__icon md-icon"></span>
 880       </label>
 881       <nav class="md-nav" aria-label="Support API" data-md-level="1">
 882         <label class="md-nav__title" for="__nav_9">
 883           <span class="md-nav__icon md-icon"></span>
 884           Support API
 885         </label>
 886         <ul class="md-nav__list" data-md-scrollfix>
 887
 888
 889
 890
 891
 892     <li class="md-nav__item">
 893       <a href="ft2-computations.html" class="md-nav__link">
 894         Computations
 895       </a>
 896     </li>
 897
 898
 899
 900
 901
 902
 903
 904     <li class="md-nav__item">
 905       <a href="ft2-list_processing.html" class="md-nav__link">
 906         List Processing
 907       </a>
 908     </li>
 909
 910
 911
 912
 913
 914
 915
 916     <li class="md-nav__item">
 917       <a href="ft2-outline_processing.html" class="md-nav__link">
 918         Outline Processing
 919       </a>
 920     </li>
 921
 922
 923
 924
 925
 926
 927
 928     <li class="md-nav__item">
 929       <a href="ft2-quick_advance.html" class="md-nav__link">
 930         Quick retrieval of advance values
 931       </a>
 932     </li>
 933
 934
 935
 936
 937
 938
 939
 940     <li class="md-nav__item">
 941       <a href="ft2-bitmap_handling.html" class="md-nav__link">
 942         Bitmap Handling
 943       </a>
 944     </li>
 945
 946
 947
 948
 949
 950
 951
 952     <li class="md-nav__item">
 953       <a href="ft2-raster.html" class="md-nav__link">
 954         Scanline Converter
 955       </a>
 956     </li>
 957
 958
 959
 960
 961
 962
 963
 964     <li class="md-nav__item">
 965       <a href="ft2-glyph_stroker.html" class="md-nav__link">
 966         Glyph Stroker
 967       </a>
 968     </li>
 969
 970
 971
 972
 973
 974
 975
 976     <li class="md-nav__item">
 977       <a href="ft2-system_interface.html" class="md-nav__link">
 978         System Interface
 979       </a>
 980     </li>
 981
 982
 983
 984
 985
 986
 987
 988     <li class="md-nav__item">
 989       <a href="ft2-module_management.html" class="md-nav__link">
 990         Module Management
 991       </a>
 992     </li>
 993
 994
 995
 996
 997
 998
 999
1000     <li class="md-nav__item">
1001       <a href="ft2-gzip.html" class="md-nav__link">
1002         GZIP Streams
1003       </a>
1004     </li>
1005
1006
1007
1008
1009
1010
1011
1012     <li class="md-nav__item">
1013       <a href="ft2-lzw.html" class="md-nav__link">
1014         LZW Streams
1015       </a>
1016     </li>
1017
1018
1019
1020
1021
1022
1023
1024     <li class="md-nav__item">
1025       <a href="ft2-bzip2.html" class="md-nav__link">
1026         BZIP2 Streams
1027       </a>
1028     </li>
1029
1030
1031
1032
1033
1034
1035
1036     <li class="md-nav__item">
1037       <a href="ft2-debugging_apis.html" class="md-nav__link">
1038         External Debugging APIs
1039       </a>
1040     </li>
1041
1042
1043
1044         </ul>
1045       </nav>
1046     </li>
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1061
1062
1063         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_10" type="checkbox" id="__nav_10" checked>
1064
1065       <label class="md-nav__link" for="__nav_10">
1066         Error Codes
1067         <span class="md-nav__icon md-icon"></span>
1068       </label>
1069       <nav class="md-nav" aria-label="Error Codes" data-md-level="1">
1070         <label class="md-nav__title" for="__nav_10">
1071           <span class="md-nav__icon md-icon"></span>
1072           Error Codes
1073         </label>
1074         <ul class="md-nav__list" data-md-scrollfix>
1075
1076
1077
1078
1079
1080
1081
1082     <li class="md-nav__item md-nav__item--active">
1083
1084       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
1085
1086
1087
1088
1089
1090         <label class="md-nav__link md-nav__link--active" for="__toc">
1091           Error Enumerations
1092           <span class="md-nav__icon md-icon"></span>
1093         </label>
1094
1095       <a href="ft2-error_enumerations.html" class="md-nav__link md-nav__link--active">
1096         Error Enumerations
1097       </a>
1098
1099
1100 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1101
1102
1103
1104
1105
1106
1107     <label class="md-nav__title" for="__toc">
1108       <span class="md-nav__icon md-icon"></span>
1109       Table of contents
1110     </label>
1111     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1112
1113         <li class="md-nav__item">
1114   <a href="#synopsis" class="md-nav__link">
1115     Synopsis
1116   </a>
1117
1118 </li>
1119
1120         <li class="md-nav__item">
1121   <a href="#ft_error_string" class="md-nav__link">
1122     FT_Error_String
1123   </a>
1124
1125 </li>
1126
1127     </ul>
1128
1129 </nav>
1130
1131     </li>
1132
1133
1134
1135
1136
1137
1138
1139     <li class="md-nav__item">
1140       <a href="ft2-error_code_values.html" class="md-nav__link">
1141         Error Code Values
1142       </a>
1143     </li>
1144
1145
1146
1147         </ul>
1148       </nav>
1149     </li>
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161     <li class="md-nav__item md-nav__item--nested">
1162
1163
1164         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_11" type="checkbox" id="__nav_11" >
1165
1166       <label class="md-nav__link" for="__nav_11">
1167         Miscellaneous
1168         <span class="md-nav__icon md-icon"></span>
1169       </label>
1170       <nav class="md-nav" aria-label="Miscellaneous" data-md-level="1">
1171         <label class="md-nav__title" for="__nav_11">
1172           <span class="md-nav__icon md-icon"></span>
1173           Miscellaneous
1174         </label>
1175         <ul class="md-nav__list" data-md-scrollfix>
1176
1177
1178
1179
1180
1181     <li class="md-nav__item">
1182       <a href="ft2-gx_validation.html" class="md-nav__link">
1183         TrueTypeGX/AAT Validation
1184       </a>
1185     </li>
1186
1187
1188
1189
1190
1191
1192
1193     <li class="md-nav__item">
1194       <a href="ft2-incremental.html" class="md-nav__link">
1195         Incremental Loading
1196       </a>
1197     </li>
1198
1199
1200
1201
1202
1203
1204
1205     <li class="md-nav__item">
1206       <a href="ft2-truetype_engine.html" class="md-nav__link">
1207         The TrueType Engine
1208       </a>
1209     </li>
1210
1211
1212
1213
1214
1215
1216
1217     <li class="md-nav__item">
1218       <a href="ft2-ot_validation.html" class="md-nav__link">
1219         OpenType Validation
1220       </a>
1221     </li>
1222
1223
1224
1225         </ul>
1226       </nav>
1227     </li>
1228
1229
1230
1231   </ul>
1232 </nav>
1233                   </div>
1234                 </div>
1235               </div>
1236
1237
1238
1239               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1240                 <div class="md-sidebar__scrollwrap">
1241                   <div class="md-sidebar__inner">
1242
1243 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1244
1245
1246
1247
1248
1249
1250     <label class="md-nav__title" for="__toc">
1251       <span class="md-nav__icon md-icon"></span>
1252       Table of contents
1253     </label>
1254     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1255
1256         <li class="md-nav__item">
1257   <a href="#synopsis" class="md-nav__link">
1258     Synopsis
1259   </a>
1260
1261 </li>
1262
1263         <li class="md-nav__item">
1264   <a href="#ft_error_string" class="md-nav__link">
1265     FT_Error_String
1266   </a>
1267
1268 </li>
1269
1270     </ul>
1271
1272 </nav>
1273                   </div>
1274                 </div>
1275               </div>
1276
1277
1278           <div class="md-content" data-md-component="content">
1279             <article class="md-content__inner md-typeset">
1280
1281
1282
1283                 <p><a href="https://www.freetype.org">FreeType</a> &raquo; <a href="../">Docs</a> &raquo; <a href="index.html#error-codes">Error Codes</a> &raquo; Error Enumerations</p>
1284 <hr />
1285 <h1 id="error-enumerations">Error Enumerations<a class="headerlink" href="#error-enumerations" title="Permanent link">&para;</a></h1>
1286 <h2 id="synopsis">Synopsis<a class="headerlink" href="#synopsis" title="Permanent link">&para;</a></h2>
1287 <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>
1288 <p><strong>Error Formats</strong></p>
1289 <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&nbsp;2, however). See the file <code>ftmoderr.h</code> for more details.</p>
1290 <p><strong>Error Message Strings</strong></p>
1291 <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&nbsp;2 to save space (most client applications do not use them).</p>
1292 <p>To do so, you have to define the following macros before including this file.
1293 <div class="highlight"><pre><span></span><code>  FT_ERROR_START_LIST
1294 </code></pre></div></p>
1295 <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.
1296 <div class="highlight"><pre><span></span><code>  FT_ERROR_DEF( e, v, s )
1297 </code></pre></div></p>
1298 <p>This macro is called to define one single error. &lsquo;e&rsquo; is the error code identifier (e.g., <code>Invalid_Argument</code>), &lsquo;v&rsquo; is the error's numerical value, and &lsquo;s&rsquo; is the corresponding error string.
1299 <div class="highlight"><pre><span></span><code>  FT_ERROR_END_LIST
1300 </code></pre></div></p>
1301 <p>This macro ends the list.</p>
1302 <p>Additionally, you have to undefine <code>FTERRORS_H_</code> before #including this file.</p>
1303 <p>Here is a simple example.
1304 <div class="highlight"><pre><span></span><code>  #undef FTERRORS_H_
1305   #define FT_ERRORDEF( e, v, s )  { e, s },
1306   #define FT_ERROR_START_LIST     {
1307   #define FT_ERROR_END_LIST       { 0, NULL } };
1308
1309   const struct
1310   {
1311     int          err_code;
1312     const char*  err_msg;
1313   } ft_errors[] =
1314
1315   #include &lt;freetype/fterrors.h&gt;
1316 </code></pre></div></p>
1317 <p>An alternative to using an array is a switch statement.
1318 <div class="highlight"><pre><span></span><code>  #undef FTERRORS_H_
1319   #define FT_ERROR_START_LIST     switch ( error_code ) {
1320   #define FT_ERRORDEF( e, v, s )    case v: return s;
1321   #define FT_ERROR_END_LIST       }
1322 </code></pre></div></p>
1323 <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>
1324 <h2 id="ft_error_string">FT_Error_String<a class="headerlink" href="#ft_error_string" title="Permanent link">&para;</a></h2>
1325 <p>Defined in FT_ERRORS_H (freetype/fterrors.h).</p>
1326 <div class = "codehilite"><pre><code>  FT_EXPORT( <span class="keyword">const</span> <span class="keyword">char</span>* )
1327   <b>FT_Error_String</b>( <a href="ft2-basic_types.html#ft_error">FT_Error</a>  error_code );
1328 </code></pre></div>
1329
1330 <p>Retrieve the description of a valid FreeType error code.</p>
1331 <h4>input</h4>
1332 <table class="fields">
1333 <tr><td class="val" id="error_code">error_code</td><td class="desc">
1334 <p>A valid FreeType error code.</p>
1335 </td></tr>
1336 </table>
1337
1338 <h4>return</h4>
1339
1340 <p>A C&nbsp;string or <code>NULL</code>, if any error occurred.</p>
1341 <h4>note</h4>
1342
1343 <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. &lsquo;error_string&rsquo; will be <code>NULL</code> otherwise.</p>
1344 <p>Module identification will be ignored:
1345 <div class="highlight"><pre><span></span><code><span class="w">  </span><span class="n">strcmp</span><span class="p">(</span><span class="w"> </span><span class="n">FT_Error_String</span><span class="p">(</span><span class="w">  </span><span class="n">FT_Err_Unknown_File_Format</span><span class="w"> </span><span class="p">),</span>
1346 <span class="w">          </span><span class="n">FT_Error_String</span><span class="p">(</span><span class="w"> </span><span class="n">BDF_Err_Unknown_File_Format</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span>
1347 </code></pre></div></p>
1348 <hr>
1349
1350
1351
1352
1353
1354
1355
1356             </article>
1357           </div>
1358         </div>
1359
1360       </main>
1361
1362
1363 <footer class="md-footer">
1364
1365     <nav class="md-footer__inner md-grid" aria-label="Footer">
1366
1367
1368         <a href="ft2-debugging_apis.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: External Debugging APIs" rel="prev">
1369           <div class="md-footer__button md-icon">
1370             <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>
1371           </div>
1372           <div class="md-footer__title">
1373             <div class="md-ellipsis">
1374               <span class="md-footer__direction">
1375                 Previous
1376               </span>
1377               External Debugging APIs
1378             </div>
1379           </div>
1380         </a>
1381
1382
1383
1384         <a href="ft2-error_code_values.html" class="md-footer__link md-footer__link--next" aria-label="Next: Error Code Values" rel="next">
1385           <div class="md-footer__title">
1386             <div class="md-ellipsis">
1387               <span class="md-footer__direction">
1388                 Next
1389               </span>
1390               Error Code Values
1391             </div>
1392           </div>
1393           <div class="md-footer__button md-icon">
1394             <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>
1395           </div>
1396         </a>
1397
1398     </nav>
1399
1400   <div class="md-footer-meta md-typeset">
1401     <div class="md-footer-meta__inner md-grid">
1402       <div class="md-footer-copyright">
1403
1404           <div class="md-footer-copyright__highlight">
1405             Copyright 2023 <a href = "https://www.freetype.org/license.html">The FreeType Project</a>.
1406           </div>
1407
1408         Made with
1409         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
1410           Material for MkDocs
1411         </a>
1412
1413       </div>
1414
1415     </div>
1416   </div>
1417 </footer>
1418
1419     </div>
1420     <div class="md-dialog" data-md-component="dialog">
1421       <div class="md-dialog__inner md-typeset"></div>
1422     </div>
1423     <script id="__config" type="application/json">{"base": ".", "features": [], "search": "assets/javascripts/workers/search.477d984a.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "version": null}</script>
1424
1425
1426       <script src="assets/javascripts/bundle.82b56eb2.min.js"></script>
1427
1428         <script src="javascripts/extra.js"></script>
1429
1430
1431   </body>
1432 </html>