ICU 4.8.1.1  4.8.1.1
uldnames.h
Go to the documentation of this file.
00001 /*
00002 *******************************************************************************
00003 *   Copyright (C) 2010, International Business Machines Corporation and       * 
00004 *   others.  All Rights Reserved.                                             *
00005 *******************************************************************************
00006 */
00007 
00008 #ifndef __ULDNAMES_H__
00009 #define __ULDNAMES_H__
00010 
00016 #include "unicode/utypes.h"
00017 #include "unicode/localpointer.h"
00018 #include "unicode/uscript.h"
00019 
00024 typedef enum {
00030     ULDN_STANDARD_NAMES = 0,
00036     ULDN_DIALECT_NAMES
00037 } UDialectHandling;
00038 
00043 struct ULocaleDisplayNames;
00044 
00049 typedef struct ULocaleDisplayNames ULocaleDisplayNames;  
00050 
00051 #if !UCONFIG_NO_FORMATTING
00052 
00065 U_STABLE ULocaleDisplayNames * U_EXPORT2
00066 uldn_open(const char * locale,
00067           UDialectHandling dialectHandling,
00068           UErrorCode *pErrorCode);
00069 
00075 U_STABLE void U_EXPORT2
00076 uldn_close(ULocaleDisplayNames *ldn);
00077 
00078 #if U_SHOW_CPLUSPLUS_API
00079 
00080 U_NAMESPACE_BEGIN
00081 
00091 U_DEFINE_LOCAL_OPEN_POINTER(LocalULocaleDisplayNamesPointer, ULocaleDisplayNames, uldn_close);
00092 
00093 U_NAMESPACE_END
00094 
00095 #endif
00096 
00097 /* getters for state */
00098 
00106 U_STABLE const char * U_EXPORT2
00107 uldn_getLocale(const ULocaleDisplayNames *ldn);
00108 
00115 U_STABLE UDialectHandling U_EXPORT2
00116 uldn_getDialectHandling(const ULocaleDisplayNames *ldn);
00117 
00118 /* names for entire locales */
00119 
00131 U_STABLE int32_t U_EXPORT2
00132 uldn_localeDisplayName(const ULocaleDisplayNames *ldn,
00133                        const char *locale,
00134                        UChar *result,
00135                        int32_t maxResultSize,
00136                        UErrorCode *pErrorCode);
00137 
00138 /* names for components of a locale */
00139 
00151 U_STABLE int32_t U_EXPORT2
00152 uldn_languageDisplayName(const ULocaleDisplayNames *ldn,
00153                          const char *lang,
00154                          UChar *result,
00155                          int32_t maxResultSize,
00156                          UErrorCode *pErrorCode);
00157 
00169 U_STABLE int32_t U_EXPORT2
00170 uldn_scriptDisplayName(const ULocaleDisplayNames *ldn,
00171                        const char *script,
00172                        UChar *result,
00173                        int32_t maxResultSize,
00174                        UErrorCode *pErrorCode);
00175 
00187 U_STABLE int32_t U_EXPORT2
00188 uldn_scriptCodeDisplayName(const ULocaleDisplayNames *ldn,
00189                            UScriptCode scriptCode,
00190                            UChar *result,
00191                            int32_t maxResultSize,
00192                            UErrorCode *pErrorCode);
00193 
00205 U_STABLE int32_t U_EXPORT2
00206 uldn_regionDisplayName(const ULocaleDisplayNames *ldn,
00207                        const char *region,
00208                        UChar *result,
00209                        int32_t maxResultSize,
00210                        UErrorCode *pErrorCode);
00211 
00223 U_STABLE int32_t U_EXPORT2
00224 uldn_variantDisplayName(const ULocaleDisplayNames *ldn,
00225                         const char *variant,
00226                         UChar *result,
00227                         int32_t maxResultSize,
00228                         UErrorCode *pErrorCode);
00229 
00241 U_STABLE int32_t U_EXPORT2
00242 uldn_keyDisplayName(const ULocaleDisplayNames *ldn,
00243                     const char *key,
00244                     UChar *result,
00245                     int32_t maxResultSize,
00246                     UErrorCode *pErrorCode);
00247 
00260 U_STABLE int32_t U_EXPORT2
00261 uldn_keyValueDisplayName(const ULocaleDisplayNames *ldn,
00262                          const char *key,
00263                          const char *value,
00264                          UChar *result,
00265                          int32_t maxResultSize,
00266                          UErrorCode *pErrorCode);
00267 
00268 
00269 #endif  /* !UCONFIG_NO_FORMATTING */
00270 #endif  /* __ULDNAMES_H__ */
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Defines