a/alt-icu57/alt-icu57-doc_57.1-5_all.deb

/*

*****************************************************************************************

* Copyright (C) 2015-2016, International Business Machines

* Corporation and others. All Rights Reserved.

*****************************************************************************************

*/


#ifndef ULISTFORMATTER_H

#define ULISTFORMATTER_H


#include "unicode/utypes.h"


#if !UCONFIG_NO_FORMATTING


#include "unicode/localpointer.h"


struct UListFormatter;

typedef struct UListFormatter UListFormatter;

U_STABLE UListFormatter* U_EXPORT2

ulistfmt_open(const char*  locale,

              UErrorCode*  status);


U_STABLE void U_EXPORT2

ulistfmt_close(UListFormatter *listfmt);


#if U_SHOW_CPLUSPLUS_API


U_NAMESPACE_BEGIN


U_DEFINE_LOCAL_OPEN_POINTER(LocalUListFormatterPointer, UListFormatter, ulistfmt_close);


U_NAMESPACE_END


#endif


U_DRAFT int32_t U_EXPORT2

ulistfmt_format(const UListFormatter* listfmt,

                const UChar* const strings[],

                const int32_t *    stringLengths,

                int32_t            stringCount,

                UChar*             result,

                int32_t            resultCapacity,

                UErrorCode*        status);


#endif /* #if !UCONFIG_NO_FORMATTING */


#endif

LocalUListFormatterPointer
"Smart pointer" class, closes a UListFormatter via ulistfmt_close().

localpointer.h
C++ API: "Smart pointers" for use with and in ICU4C C++ code.

U_DEFINE_LOCAL_OPEN_POINTER
#define U_DEFINE_LOCAL_OPEN_POINTER(LocalPointerClassName, Type, closeFunction)
"Smart pointer" definition macro, deletes objects via the closeFunction.
Definition: localpointer.h:539

ulistfmt_open
UListFormatter * ulistfmt_open(const char *locale, UErrorCode *status)
Open a new UListFormatter object using the rules for a given locale.

ulistfmt_format
int32_t ulistfmt_format(const UListFormatter *listfmt, const UChar *const strings[], const int32_t *stringLengths, int32_t stringCount, UChar *result, int32_t resultCapacity, UErrorCode *status)
Formats a list of strings using the conventions established for the UListFormatter object.

UListFormatter
struct UListFormatter UListFormatter
C typedef for struct UListFormatter.
Definition: ulistformatter.h:32

ulistfmt_close
void ulistfmt_close(UListFormatter *listfmt)
Close a UListFormatter object.

U_DRAFT
#define U_DRAFT
This is used to declare a function as a draft public ICU C API
Definition: umachine.h:111

UChar
uint16_t UChar
Define UChar to be UCHAR_TYPE, if that is #defined (for example, to char16_t), or wchar_t if that is ...
Definition: umachine.h:312

U_STABLE
#define U_STABLE
This is used to declare a function as a stable public ICU C API.
Definition: umachine.h:109

utypes.h
Basic definitions for ICU, for both C and C++ APIs.

UErrorCode
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers,...
Definition: utypes.h:476

U_NAMESPACE_END
#define U_NAMESPACE_END
This is used to end a declaration of a public ICU C++ API.
Definition: uversion.h:130

U_NAMESPACE_BEGIN
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition: uversion.h:129