docs/reference/ft2-error_code_values.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
   2 "http://www.w3.org/TR/html4/loose.dtd">
   3 <html>
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
   6 <title>FreeType-2.6.5 API Reference</title>
   7 <style type="text/css">
   8   a:link { color: #0000EF; }
   9   a:visited { color: #51188E; }
  10   a:hover { color: #FF0000; }
  11
  12   body { font-family: Verdana, Geneva, Arial, Helvetica, serif;
  13          color: #000000;
  14          background: #FFFFFF;
  15          width: 87%;
  16          margin: auto; }
  17
  18   div.section { width: 75%;
  19                 margin: auto; }
  20   div.section hr { margin: 4ex 0 1ex 0; }
  21   div.section h4 { background-color: #EEEEFF;
  22                    font-size: medium;
  23                    font-style: oblique;
  24                    font-weight: bold;
  25                    margin: 3ex 0 1.5ex 9%;
  26                    padding: 0.3ex 0 0.3ex 1%; }
  27   div.section p { margin: 1.5ex 0 1.5ex 10%; }
  28   div.section pre { margin: 3ex 0 3ex 9%;
  29                     background-color: #D6E8FF;
  30                     padding: 2ex 0 2ex 1%; }
  31   div.section table.fields { width: 90%;
  32                              margin: 1.5ex 0 1.5ex 10%; }
  33   div.section table.toc { width: 95%;
  34                           margin: 1.5ex 0 1.5ex 5%; }
  35   div.timestamp { text-align: center;
  36                   font-size: 69%;
  37                   margin: 1.5ex 0 1.5ex 0; }
  38
  39   h1 { text-align: center; }
  40   h3 { font-size: medium;
  41        margin: 4ex 0 1.5ex 0; }
  42
  43   p { text-align: justify; }
  44
  45   pre.colored { color: blue; }
  46
  47   span.keyword { font-family: monospace;
  48                  text-align: left;
  49                  white-space: pre;
  50                  color: darkblue; }
  51
  52   table.fields td.val { font-weight: bold;
  53                         text-align: right;
  54                         width: 30%;
  55                         vertical-align: baseline;
  56                         padding: 1ex 1em 1ex 0; }
  57   table.fields td.desc { vertical-align: baseline;
  58                          padding: 1ex 0 1ex 1em; }
  59   table.fields td.desc p:first-child { margin: 0; }
  60   table.fields td.desc p { margin: 1.5ex 0 0 0; }
  61   table.index { margin: 6ex auto 6ex auto;
  62                 border: 0;
  63                 border-collapse: separate;
  64                 border-spacing: 1em 0.3ex; }
  65   table.index tr { padding: 0; }
  66   table.index td { padding: 0; }
  67   table.index-toc-link { width: 100%;
  68                          border: 0;
  69                          border-spacing: 0;
  70                          margin: 1ex 0 1ex 0; }
  71   table.index-toc-link td.left { padding: 0 0.5em 0 0.5em;
  72                                  font-size: 83%;
  73                                  text-align: left; }
  74   table.index-toc-link td.middle { padding: 0 0.5em 0 0.5em;
  75                                    font-size: 83%;
  76                                    text-align: center; }
  77   table.index-toc-link td.right { padding: 0 0.5em 0 0.5em;
  78                                   font-size: 83%;
  79                                   text-align: right; }
  80   table.synopsis { margin: 6ex auto 6ex auto;
  81                    border: 0;
  82                    border-collapse: separate;
  83                    border-spacing: 2em 0.6ex; }
  84   table.synopsis tr { padding: 0; }
  85   table.synopsis td { padding: 0; }
  86   table.toc td.link { width: 30%;
  87                       text-align: right;
  88                       vertical-align: baseline;
  89                       padding: 1ex 1em 1ex 0; }
  90   table.toc td.desc { vertical-align: baseline;
  91                       padding: 1ex 0 1ex 1em;
  92                       text-align: left; }
  93   table.toc td.desc p:first-child { margin: 0;
  94                                     text-align: left; }
  95   table.toc td.desc p { margin: 1.5ex 0 0 0;
  96                         text-align: left; }
  97
  98 </style>
  99 </head>
 100 <body>
 101
 102 <table class="index-toc-link"><tr><td class="left">[<a href="ft2-index.html">Index</a>]</td><td class="right">[<a href="ft2-toc.html">TOC</a>]</td></tr></table>
 103 <h1>FreeType-2.6.5 API Reference</h1>
 104
 105 <h1 id="error_code_values">Error Code Values</h1>
 106 <h2>Synopsis</h2>
 107 <table class="synopsis">
 108 <tr><td><a href="#FT_Err_XXX">FT_Err_XXX</a></td><td></td><td></td><td></td><td></td><td></td><td></td></tr>
 109 </table>
 110
 111
 112 <p>The list below is taken verbatim from the file &lsquo;fterrdef.h&rsquo; (loaded automatically by including &lsquo;FT_FREETYPE_H&rsquo;). The first argument of the &lsquo;FT_ERROR_DEF_&rsquo; macro is the error label; by default, the prefix &lsquo;FT_Err_&rsquo; gets added so that you get error names like &lsquo;FT_Err_Cannot_Open_Resource&rsquo;. The second argument is the error code, and the last argument an error string, which is not used by FreeType.</p>
 113 <p>Within your application you should <b>only</b> use error names and <b>never</b> its numeric values! The latter might (and actually do) change in forthcoming FreeType versions.</p>
 114 <p>Macro &lsquo;FT_NOERRORDEF_&rsquo; defines &lsquo;FT_Err_Ok&rsquo;, which is always zero. See the &lsquo;Error Enumerations&rsquo; subsection how to automatically generate a list of error strings.</p>
 115
 116 <div class="section">
 117 <h3 id="FT_Err_XXX">FT_Err_XXX</h3>
 118 <pre>
 119   /* generic errors */
 120
 121   FT_NOERRORDEF_( Ok,                                        0x00,
 122                   "no error" )
 123
 124   FT_ERRORDEF_( Cannot_Open_Resource,                        0x01,
 125                 "cannot open resource" )
 126   FT_ERRORDEF_( Unknown_File_Format,                         0x02,
 127                 "unknown file format" )
 128   FT_ERRORDEF_( Invalid_File_Format,                         0x03,
 129                 "broken file" )
 130   FT_ERRORDEF_( Invalid_Version,                             0x04,
 131                 "invalid FreeType version" )
 132   FT_ERRORDEF_( Lower_Module_Version,                        0x05,
 133                 "module version is too low" )
 134   FT_ERRORDEF_( Invalid_Argument,                            0x06,
 135                 "invalid argument" )
 136   FT_ERRORDEF_( Unimplemented_Feature,                       0x07,
 137                 "unimplemented feature" )
 138   FT_ERRORDEF_( Invalid_Table,                               0x08,
 139                 "broken table" )
 140   FT_ERRORDEF_( Invalid_Offset,                              0x09,
 141                 "broken offset within table" )
 142   FT_ERRORDEF_( Array_Too_Large,                             0x0A,
 143                 "array allocation size too large" )
 144   FT_ERRORDEF_( Missing_Module,                              0x0B,
 145                 "missing module" )
 146   FT_ERRORDEF_( Missing_Property,                            0x0C,
 147                 "missing property" )
 148
 149   /* glyph/character errors */
 150
 151   FT_ERRORDEF_( Invalid_Glyph_Index,                         0x10,
 152                 "invalid glyph index" )
 153   FT_ERRORDEF_( Invalid_Character_Code,                      0x11,
 154                 "invalid character code" )
 155   FT_ERRORDEF_( Invalid_Glyph_Format,                        0x12,
 156                 "unsupported glyph image format" )
 157   FT_ERRORDEF_( Cannot_Render_Glyph,                         0x13,
 158                 "cannot render this glyph format" )
 159   FT_ERRORDEF_( Invalid_Outline,                             0x14,
 160                 "invalid outline" )
 161   FT_ERRORDEF_( Invalid_Composite,                           0x15,
 162                 "invalid composite glyph" )
 163   FT_ERRORDEF_( Too_Many_Hints,                              0x16,
 164                 "too many hints" )
 165   FT_ERRORDEF_( Invalid_Pixel_Size,                          0x17,
 166                 "invalid pixel size" )
 167
 168   /* handle errors */
 169
 170   FT_ERRORDEF_( Invalid_Handle,                              0x20,
 171                 "invalid object handle" )
 172   FT_ERRORDEF_( Invalid_Library_Handle,                      0x21,
 173                 "invalid library handle" )
 174   FT_ERRORDEF_( Invalid_Driver_Handle,                       0x22,
 175                 "invalid module handle" )
 176   FT_ERRORDEF_( Invalid_Face_Handle,                         0x23,
 177                 "invalid face handle" )
 178   FT_ERRORDEF_( Invalid_Size_Handle,                         0x24,
 179                 "invalid size handle" )
 180   FT_ERRORDEF_( Invalid_Slot_Handle,                         0x25,
 181                 "invalid glyph slot handle" )
 182   FT_ERRORDEF_( Invalid_CharMap_Handle,                      0x26,
 183                 "invalid charmap handle" )
 184   FT_ERRORDEF_( Invalid_Cache_Handle,                        0x27,
 185                 "invalid cache manager handle" )
 186   FT_ERRORDEF_( Invalid_Stream_Handle,                       0x28,
 187                 "invalid stream handle" )
 188
 189   /* driver errors */
 190
 191   FT_ERRORDEF_( Too_Many_Drivers,                            0x30,
 192                 "too many modules" )
 193   FT_ERRORDEF_( Too_Many_Extensions,                         0x31,
 194                 "too many extensions" )
 195
 196   /* memory errors */
 197
 198   FT_ERRORDEF_( Out_Of_Memory,                               0x40,
 199                 "out of memory" )
 200   FT_ERRORDEF_( Unlisted_Object,                             0x41,
 201                 "unlisted object" )
 202
 203   /* stream errors */
 204
 205   FT_ERRORDEF_( Cannot_Open_Stream,                          0x51,
 206                 "cannot open stream" )
 207   FT_ERRORDEF_( Invalid_Stream_Seek,                         0x52,
 208                 "invalid stream seek" )
 209   FT_ERRORDEF_( Invalid_Stream_Skip,                         0x53,
 210                 "invalid stream skip" )
 211   FT_ERRORDEF_( Invalid_Stream_Read,                         0x54,
 212                 "invalid stream read" )
 213   FT_ERRORDEF_( Invalid_Stream_Operation,                    0x55,
 214                 "invalid stream operation" )
 215   FT_ERRORDEF_( Invalid_Frame_Operation,                     0x56,
 216                 "invalid frame operation" )
 217   FT_ERRORDEF_( Nested_Frame_Access,                         0x57,
 218                 "nested frame access" )
 219   FT_ERRORDEF_( Invalid_Frame_Read,                          0x58,
 220                 "invalid frame read" )
 221
 222   /* raster errors */
 223
 224   FT_ERRORDEF_( Raster_Uninitialized,                        0x60,
 225                 "raster uninitialized" )
 226   FT_ERRORDEF_( Raster_Corrupted,                            0x61,
 227                 "raster corrupted" )
 228   FT_ERRORDEF_( Raster_Overflow,                             0x62,
 229                 "raster overflow" )
 230   FT_ERRORDEF_( Raster_Negative_Height,                      0x63,
 231                 "negative height while rastering" )
 232
 233   /* cache errors */
 234
 235   FT_ERRORDEF_( Too_Many_Caches,                             0x70,
 236                 "too many registered caches" )
 237
 238   /* TrueType and SFNT errors */
 239
 240   FT_ERRORDEF_( Invalid_Opcode,                              0x80,
 241                 "invalid opcode" )
 242   FT_ERRORDEF_( Too_Few_Arguments,                           0x81,
 243                 "too few arguments" )
 244   FT_ERRORDEF_( Stack_Overflow,                              0x82,
 245                 "stack overflow" )
 246   FT_ERRORDEF_( Code_Overflow,                               0x83,
 247                 "code overflow" )
 248   FT_ERRORDEF_( Bad_Argument,                                0x84,
 249                 "bad argument" )
 250   FT_ERRORDEF_( Divide_By_Zero,                              0x85,
 251                 "division by zero" )
 252   FT_ERRORDEF_( Invalid_Reference,                           0x86,
 253                 "invalid reference" )
 254   FT_ERRORDEF_( Debug_OpCode,                                0x87,
 255                 "found debug opcode" )
 256   FT_ERRORDEF_( ENDF_In_Exec_Stream,                         0x88,
 257                 "found ENDF opcode in execution stream" )
 258   FT_ERRORDEF_( Nested_DEFS,                                 0x89,
 259                 "nested DEFS" )
 260   FT_ERRORDEF_( Invalid_CodeRange,                           0x8A,
 261                 "invalid code range" )
 262   FT_ERRORDEF_( Execution_Too_Long,                          0x8B,
 263                 "execution context too <span class="keyword">long</span>" )
 264   FT_ERRORDEF_( Too_Many_Function_Defs,                      0x8C,
 265                 "too many function definitions" )
 266   FT_ERRORDEF_( Too_Many_Instruction_Defs,                   0x8D,
 267                 "too many instruction definitions" )
 268   FT_ERRORDEF_( Table_Missing,                               0x8E,
 269                 "SFNT font table missing" )
 270   FT_ERRORDEF_( Horiz_Header_Missing,                        0x8F,
 271                 "horizontal header (hhea) table missing" )
 272   FT_ERRORDEF_( Locations_Missing,                           0x90,
 273                 "locations (loca) table missing" )
 274   FT_ERRORDEF_( Name_Table_Missing,                          0x91,
 275                 "name table missing" )
 276   FT_ERRORDEF_( CMap_Table_Missing,                          0x92,
 277                 "character map (cmap) table missing" )
 278   FT_ERRORDEF_( Hmtx_Table_Missing,                          0x93,
 279                 "horizontal metrics (hmtx) table missing" )
 280   FT_ERRORDEF_( Post_Table_Missing,                          0x94,
 281                 "PostScript (post) table missing" )
 282   FT_ERRORDEF_( Invalid_Horiz_Metrics,                       0x95,
 283                 "invalid horizontal metrics" )
 284   FT_ERRORDEF_( Invalid_CharMap_Format,                      0x96,
 285                 "invalid character map (cmap) format" )
 286   FT_ERRORDEF_( Invalid_PPem,                                0x97,
 287                 "invalid ppem value" )
 288   FT_ERRORDEF_( Invalid_Vert_Metrics,                        0x98,
 289                 "invalid vertical metrics" )
 290   FT_ERRORDEF_( Could_Not_Find_Context,                      0x99,
 291                 "could not find context" )
 292   FT_ERRORDEF_( Invalid_Post_Table_Format,                   0x9A,
 293                 "invalid PostScript (post) table format" )
 294   FT_ERRORDEF_( Invalid_Post_Table,                          0x9B,
 295                 "invalid PostScript (post) table" )
 296
 297   /* CFF, CID, and Type 1 errors */
 298
 299   FT_ERRORDEF_( Syntax_Error,                                0xA0,
 300                 "opcode syntax error" )
 301   FT_ERRORDEF_( Stack_Underflow,                             0xA1,
 302                 "argument stack underflow" )
 303   FT_ERRORDEF_( Ignore,                                      0xA2,
 304                 "ignore" )
 305   FT_ERRORDEF_( No_Unicode_Glyph_Name,                       0xA3,
 306                 "no Unicode glyph name found" )
 307   FT_ERRORDEF_( Glyph_Too_Big,                               0xA4,
 308                 "glyph too big for hinting" )
 309
 310   /* BDF errors */
 311
 312   FT_ERRORDEF_( Missing_Startfont_Field,                     0xB0,
 313                 "`STARTFONT' field missing" )
 314   FT_ERRORDEF_( Missing_Font_Field,                          0xB1,
 315                 "`FONT' field missing" )
 316   FT_ERRORDEF_( Missing_Size_Field,                          0xB2,
 317                 "`SIZE' field missing" )
 318   FT_ERRORDEF_( Missing_Fontboundingbox_Field,               0xB3,
 319                 "`FONTBOUNDINGBOX' field missing" )
 320   FT_ERRORDEF_( Missing_Chars_Field,                         0xB4,
 321                 "`CHARS' field missing" )
 322   FT_ERRORDEF_( Missing_Startchar_Field,                     0xB5,
 323                 "`STARTCHAR' field missing" )
 324   FT_ERRORDEF_( Missing_Encoding_Field,                      0xB6,
 325                 "`ENCODING' field missing" )
 326   FT_ERRORDEF_( Missing_Bbx_Field,                           0xB7,
 327                 "`BBX' field missing" )
 328   FT_ERRORDEF_( Bbx_Too_Big,                                 0xB8,
 329                 "`BBX' too big" )
 330   FT_ERRORDEF_( Corrupted_Font_Header,                       0xB9,
 331                 "Font header corrupted or missing fields" )
 332   FT_ERRORDEF_( Corrupted_Font_Glyphs,                       0xBA,
 333                 "Font glyphs corrupted or missing fields" )
 334 </pre>
 335 <hr>
 336 <table class="index-toc-link"><tr><td class="left">[<a href="ft2-index.html">Index</a>]</td><td class="middle">[<a href="#">Top</a>]</td><td class="right">[<a href="ft2-toc.html">TOC</a>]</td></tr></table></div>
 337
 338 </body>
 339 </html>