The Free and Open Productivity Suite
Follow us on Twitter: @ApacheOO

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


Global Functions in Global Namespace C++
in Sourcefile tencinfo.h


rtl_getBestMimeCharsetFromTextEncoding
extern "C"
const sal_Char * rtl_getBestMimeCharsetFromTextEncoding(
rtl_TextEncoding eTextEncoding );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Summary
Map from a text encoding to the best matching MIME charset.
Parameters
eTextEncoding
    Any rtl_TextEncoding value.

    
Return
The best matching MIME charset string, or null if none matches.

rtl_getBestUnixCharsetFromTextEncoding
extern "C"
const sal_Char * rtl_getBestUnixCharsetFromTextEncoding(
rtl_TextEncoding eTextEncoding );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Summary
Map from a text encoding to the best matching Unix charset.
Parameters
eTextEncoding
    Any rtl_TextEncoding value.

    
Return
The best matching Unix charset string, or null if none matches.

rtl_getBestWindowsCharsetFromTextEncoding
extern "C"
sal_uInt8 rtl_getBestWindowsCharsetFromTextEncoding(
rtl_TextEncoding eTextEncoding );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Summary
Map from a text encoding to the best matching numeric Windows charset.
Parameters
eTextEncoding
    Any rtl_TextEncoding value.

    
Return
The best matching numeric Windows charset, or 1 if none matches.

rtl_getMimeCharsetFromTextEncoding
extern "C"
const char * rtl_getMimeCharsetFromTextEncoding(
rtl_TextEncoding nEncoding );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Summary
Map from a text encoding to a corresponding MIME charset name, if available (see ).
Parameters
nEncoding
Any rtl_TextEncoding value.

Return
The (preferred) MIME charset name corresponding to the given encoding, or NULL if none is available.

rtl_getTextEncodingFromMimeCharset
extern "C"
rtl_TextEncoding rtl_getTextEncodingFromMimeCharset(
const sal_Char * pMimeCharset );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Summary
Map from a MIME charset to a text encoding.
Parameters
pMimeCharset
    Any MIME charset string.  Must not be null.

    
Return
The corresponding rtl_TextEncoding value, or RTL_TEXTENCODING_DONTKNOW if no mapping is applicable.

rtl_getTextEncodingFromUnixCharset
extern "C"
rtl_TextEncoding rtl_getTextEncodingFromUnixCharset(
const sal_Char * pUnixCharset );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Summary
Map from a Unix charset to a text encoding.
Parameters
pMimeCharset
    Any Unix charset string.  Must not be null.

    
Return
The corresponding rtl_TextEncoding value, or RTL_TEXTENCODING_DONTKNOW if no mapping is applicable.

rtl_getTextEncodingFromWindowsCharset
extern "C"
rtl_TextEncoding rtl_getTextEncodingFromWindowsCharset(
sal_uInt8 nWinCharset );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Summary
Map from a numeric Windows charset to a text encoding.
Parameters
nWinCharset
    Any numeric Windows charset.

    
Return
The corresponding rtl_TextEncoding value, or RTL_TEXTENCODING_DONTKNOW if no mapping is applicable.

rtl_getTextEncodingFromWindowsCodePage
extern "C"
rtl_TextEncoding rtl_getTextEncodingFromWindowsCodePage(
sal_uInt32 nCodePage );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Summary
Map from a Windows code page to a text encoding.
Parameters
nCodePage
    Any Windows code page number.

    
Return
The corresponding rtl_TextEncoding value (which will be an octet text encoding, see rtl_isOctetTextEncoding), or RTL_TEXTENCODING_DONTKNOW if no mapping is applicable.

rtl_getTextEncodingInfo
extern "C"
sal_Bool rtl_getTextEncodingInfo(
rtl_TextEncoding eTextEncoding,
rtl_TextEncodingInfo * pEncInfo );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Summary
Return information about a text encoding.
Parameters
eTextEncoding
    Any rtl_TextEncoding value.

    
pEncInfo
    Returns information about the given encoding.  Must not be null, and the
    StructSize member must be set correctly.

    
Return
True if information about the given encoding is available, false otherwise.

rtl_getWindowsCodePageFromTextEncoding
extern "C"
sal_uInt32 rtl_getWindowsCodePageFromTextEncoding(
rtl_TextEncoding nEncoding );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Summary
Map from a text encoding to a Windows code page.
Parameters
nEncoding
    Any rtl_TextEncoding value.

    
Return
The corresponding Windows code page number, or 0 if no mapping is applicable.

rtl_isOctetTextEncoding
extern "C"
sal_Bool rtl_isOctetTextEncoding(
rtl_TextEncoding nEncoding );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Description
Determine whether a text encoding uses single octets as basic units of information (and can thus be used with the conversion routines in rtl/textcvt.h).
Parameters
nEncoding
Any rtl_TextEncoding value.

Return
True if the given encoding uses single octets as basic units of information, false otherwise.

Top of Page

Apache Software Foundation

Copyright & License | Privacy | Website Feedback | Contact Us | Donate | Thanks

Apache, the Apache feather logo, and OpenOffice are trademarks of The Apache Software Foundation. OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.