Logo Search packages:      
Sourcecode: icu version File versions  Download package

U_STABLE int32_t U_EXPORT2 uloc_getDisplayKeyword ( const char *  keyword,
const char *  displayLocale,
UChar *  dest,
int32_t  destCapacity,
UErrorCode status 

Gets the keyword name suitable for display for the specified locale. E.g: for the locale string de_DE@collation=PHONEBOOK, this API gets the display string for the keyword collation. Usage: UErrorCode status = U_ZERO_ERROR; const char* keyword =NULL; int32_t keywordLen = 0; int32_t keywordCount = 0; UChar displayKeyword[256]; int32_t displayKeywordLen = 0; UEnumeration* keywordEnum = uloc_openKeywords("de_DE@collation=PHONEBOOK;calendar=TRADITIONAL", &status); for(keywordCount = uenum_count(keywordEnum, &status); keywordCount > 0 ; keywordCount--){ if(U_FAILURE(status)){ ...something went wrong so handle the error... break; } // the uenum_next returns NUL terminated string keyword = uenum_next(keywordEnum, &keywordLen, &status); displayKeywordLen = uloc_getDisplayKeyword(keyword, "en_US", displayKeyword, 256); ... do something interesting ..... } uenum_close(keywordEnum);

keyword The keyword whose display string needs to be returned.
displayLocale Specifies the locale to be used to display the name. In other words, if the locale's language code is "en", passing Locale::getFrench() for inLocale would result in "Anglais", while passing Locale::getGerman() for inLocale would result in "Englisch". NULL may be used to specify the default.
dest the buffer to which the displayable keyword should be written.
destCapacity The size of the buffer (number of UChars). If it is 0, then dest may be NULL and the function will only return the length of the result without writing any of the result string (pre-flighting).
status error information if retrieving the displayable string failed. Should not be NULL and should not indicate failure on entry.
the actual buffer size needed for the displayable variant code.
See also:
uloc_openKeywords ICU 2.8

Definition at line 708 of file locdispnames.cpp.



    /* argument checking */
    if(status==NULL || U_FAILURE(*status)) {
        return 0;

    if(destCapacity<0 || (destCapacity>0 && dest==NULL)) {
        return 0;

    /* pass itemKey=NULL to look for a top-level item */
    return _getStringOrCopyKey(U_ICUDATA_LANG, displayLocale,
                               _kKeys, NULL, 
                               dest, destCapacity,


Generated by  Doxygen 1.6.0   Back to index