ImageGear for C and C++ on Windows v21.0 - Updated
API Reference Guide / PDF Component API Reference / PDF Component Functions Reference / IG_PDF_get_host_encoding
In This Topic
    IG_PDF_get_host_encoding
    In This Topic

    Indicates what kind of host encoding a system uses: Roman or non-Roman.

    Declaration:

     
    Copy Code
    AT_ERRCOUNT ACCUAPI IG_PDF_get_host_encoding(
            LPVOID* lpHostEncoding
    );
    

    Arguments:

    Name Type Description
    lpHostEncoding LPVOID* Returns 0 for a Roman system; nonzero for a non-Roman system (a structure that depends on the host encoding). Users should simply test whether this value is 0 or not.

    Return Value:

    Error count

    Supported Raster Image Formats:

    This function does not process image pixels.

    Remarks:

    Non-Roman is also known as CJK-capable, that is, capable of handling multi-byte character sets, such as Chinese, Japanese, or Korean.

    Host encoding is a platform-dependent encoding for the host machine. For non-UNIX Roman systems, it is MacRomanEncoding in Mac OS and WinAnsiEncoding in Windows. In UNIX (except HP-UX) Roman systems, it is ISO8859-1 (ISO Latin-1); for HP-UX, it is HP-ROMAN8. See Appendix D in the PDF Reference for descriptions of MacRomanEncoding, WinAnsiEncoding, and PDFDocEncoding.

    For non-Roman systems, the host encoding may be a variety of encodings, which are defined by a CMap (character map). See Section 5.6.4 in the PDF Reference for a list of predefined CMaps.