ImageGear for C and C++ on Windows v19.1 - Updated
IG_PDF_font_translate_string
API Reference Guide > PDF Component API Reference > PDF Component Objects Reference > General Objects > HIG_PDF_FONT > IG_PDF_font_translate_string

Translates a string from the hFont's encoding into host encoding.

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_PDF_font_translate_string(
        HIG_PDF_FONT hFont,
        LPSTR inP,
        LPSTR outP,
        LONG len,
        LPAT_PDF_BOOL lpbTableExists
);

Arguments:

Name Type Description
hFont HIG_PDF_FONT The font (and hence, encoding) that inP uses.
inP LPSTR The string to translate.
outP LPSTR The translated string. outP may point to the same buffer as inP to allow in-place translation.
len LONG The length of inP and outP.
lpbTableExists LPAT_PDF_BOOL Returns TRUE if an XlateTable exists in the font; FALSE otherwise. If no XlateTable exists in the font, outP is not written.

Return Value:

Error count.

Supported Raster Image Formats:

This function does not process image pixels.

Remarks:

If any characters cannot be represented in host encoding, they are replaced with space characters. If no XlateTable exists in the font, the function returns FALSE and outP is not written. For non-Roman character set viewers, it is not appropriate to call this function.