Sign in Join
FPDoc Onlineexperiment

TT_Open_Collection function

In unit LazFreeType

Opens a font file embedded in a collection.

Declaration

pascal
function TT_Open_Collection(fontname: string; faceIndex: Integer; 
 var _face: TT_Face): TT_Error

Arguments

fontname

Font collection examined in the routine.

faceIndex

Position of the desired font embedded in the collection.

_face

Handle for the font face opened in the routine.

Function result

Success or fail status for the routine.

Description

TT_Open_Collection is a function used to open a TrueType font embbedded in a font collection.

fontname is the name of the font collection opend in the routine.

faceIndex is the position of the desired font in the collection.

_face contains the handle for the font loaded in the routine.

The return value is a TT_Error type which indicates the success or failure of the routine. Please note that success is indicated by the value TT_Err_Ok (0). Any other value indicates an error condition.

See also

  • TT_Error
  • TT_Err_Ok
  • TT_Open_Stream
  • Cache_New
  • error

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.