Content-type: text/html Manpage of FT_Get_Glyph_Name

FT_Get_Glyph_Name

Section: Misc. Reference Manual Pages (3)
Index Return to Main Contents
 

NAME

FT_Get_Glyph_Name  

DESCRIPTION

Retrieves the ASCII name of a given glyph in a face. This only works for those faces where FT_HAS_GLYPH_NAME(face) returns true.

Input:

face :: A handle to a source face object.

glyph_index :: The glyph index.

buffer_max :: The maximal number of bytes available in the buffer.

Output:

buffer :: A pointer to a target buffer where the name will be copied to. Retrieves the ASCII name of a given glyph in a face. This only works for those faces where FT_HAS_GLYPH_NAME(face) returns true.

Input:

face :: A handle to a source face object.

glyph_index :: The glyph index.

buffer_max :: The maximal number of bytes available in the buffer.

Output:

buffer :: A pointer to a target buffer where the name will be copied to.

Notes: An error is returned if the face doesn't provide glyph names or if the glyph index is invalid. In all cases of failure, the first byte of `buffer' will be set to 0 to indicate an empty name. The glyph name is truncated to fit within the buffer if it is too long. The returned string is always zero-terminated. This function is not compiled within the library if the config macro FT_CONFIG_OPTION_NO_GLYPH_NAMES is defined in `include/freetype/config/ftoptions.h' FT_EXPORT( FT_Error ) FT_Get_Glyph_Name( FT_Face face, FT_UInt glyph_index, FT_Pointer buffer, FT_UInt buffer_max );  

RETURNS

FreeType error code. 0 means success.  

VERSION

This documentation was generated for Freetype 2.0.4 by autodocbook (http://www.stillhq.com). Autodocbook is (c) Michael Still 2001.
      

AUTHOR

Copyright 1996-2000 by David Turner, Robert Wilhelm, and Werner Lemberg.
    

This file is part of the FreeType project, and may only be used, modified, and distributed under the terms of the FreeType project license, LICENSE.TXT. By continuing to use, modify, or distribute this file you indicate that you have read the license and understand and accept it fully.  

BUGS

Please report errors in this documentation, and Freetype itself to freetype@freetype.org


 

Index

NAME
DESCRIPTION
RETURNS
VERSION
AUTHOR
BUGS

This document was created by man2html, using the manual pages.
Time: 04:44:37 GMT, July 26, 2001