ICU 62.1 62.1
ulistformatter.h
Go to the documentation of this file.
1// © 2016 and later: Unicode, Inc. and others.
2// License & terms of use: http://www.unicode.org/copyright.html
3/*
4*****************************************************************************************
5* Copyright (C) 2015-2016, International Business Machines
6* Corporation and others. All Rights Reserved.
7*****************************************************************************************
8*/
9
10#ifndef ULISTFORMATTER_H
11#define ULISTFORMATTER_H
12
13#include "unicode/utypes.h"
14
15#if !UCONFIG_NO_FORMATTING
16
18
33struct UListFormatter;
52U_CAPI UListFormatter* U_EXPORT2
53ulistfmt_open(const char* locale,
54 UErrorCode* status);
55
62U_CAPI void U_EXPORT2
64
65
66#if U_SHOW_CPLUSPLUS_API
67
69
80
82
83#endif
84
119U_CAPI int32_t U_EXPORT2
121 const UChar* const strings[],
122 const int32_t * stringLengths,
123 int32_t stringCount,
124 UChar* result,
125 int32_t resultCapacity,
126 UErrorCode* status);
127
128#endif /* #if !UCONFIG_NO_FORMATTING */
129
130#endif
"Smart pointer" class, closes a UListFormatter via ulistfmt_close().
C++ API: "Smart pointers" for use with and in ICU4C C++ code.
#define U_DEFINE_LOCAL_OPEN_POINTER(LocalPointerClassName, Type, closeFunction)
"Smart pointer" definition macro, deletes objects via the closeFunction.
U_CAPI UListFormatter * ulistfmt_open(const char *locale, UErrorCode *status)
Open a new UListFormatter object using the rules for a given locale.
struct UListFormatter UListFormatter
C typedef for struct UListFormatter.
U_CAPI 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.
U_CAPI void ulistfmt_close(UListFormatter *listfmt)
Close a UListFormatter object.
#define U_CAPI
This is used to declare a function as a public ICU C API.
Definition umachine.h:109
uint16_t UChar
The base type for UTF-16 code units and pointers.
Definition umachine.h:353
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers,...
Definition utypes.h:396
#define U_NAMESPACE_END
This is used to end a declaration of a public ICU C++ API.
Definition uversion.h:138
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition uversion.h:137