ICU 58.2  58.2
uenum.h
Go to the documentation of this file.
1 // Copyright (C) 2016 and later: Unicode, Inc. and others.
2 // License & terms of use: http://www.unicode.org/copyright.html
3 /*
4 *******************************************************************************
5 *
6 * Copyright (C) 2002-2013, International Business Machines
7 * Corporation and others. All Rights Reserved.
8 *
9 *******************************************************************************
10 * file name: uenum.h
11 * encoding: US-ASCII
12 * tab size: 8 (not used)
13 * indentation:2
14 *
15 * created on: 2002jul08
16 * created by: Vladimir Weinstein
17 */
18 
19 #ifndef __UENUM_H
20 #define __UENUM_H
21 
22 #include "unicode/utypes.h"
23 #include "unicode/localpointer.h"
24 
25 #if U_SHOW_CPLUSPLUS_API
26 #include "unicode/strenum.h"
27 #endif
28 
39 struct UEnumeration;
41 typedef struct UEnumeration UEnumeration;
42 
50 U_STABLE void U_EXPORT2
52 
53 #if U_SHOW_CPLUSPLUS_API
54 
56 
67 
69 
70 #endif
71 
86 U_STABLE int32_t U_EXPORT2
87 uenum_count(UEnumeration* en, UErrorCode* status);
88 
110 U_STABLE const UChar* U_EXPORT2
112  int32_t* resultLength,
113  UErrorCode* status);
114 
143 U_STABLE const char* U_EXPORT2
145  int32_t* resultLength,
146  UErrorCode* status);
147 
157 U_STABLE void U_EXPORT2
158 uenum_reset(UEnumeration* en, UErrorCode* status);
159 
160 #if U_SHOW_CPLUSPLUS_API
161 
171 U_STABLE UEnumeration* U_EXPORT2
173 
174 #endif
175 
187 U_STABLE UEnumeration* U_EXPORT2
188 uenum_openUCharStringsEnumeration(const UChar* const strings[], int32_t count,
189  UErrorCode* ec);
190 
191 /* Note: next function is not hidden as draft, as it is used internally (it was formerly an internal function). */
192 
204 U_STABLE UEnumeration* U_EXPORT2
205 uenum_openCharStringsEnumeration(const char* const strings[], int32_t count,
206  UErrorCode* ec);
207 
208 #endif
void uenum_close(UEnumeration *en)
Disposes of resources in use by the iterator.
UEnumeration * uenum_openUCharStringsEnumeration(const UChar *const strings[], int32_t count, UErrorCode *ec)
Given an array of const UChar* strings, return a UEnumeration.
struct UEnumeration UEnumeration
structure representing an enumeration object instance
Definition: uenum.h:41
Base class for 'pure' C++ implementations of uenum api.
Definition: strenum.h:57
const char * uenum_next(UEnumeration *en, int32_t *resultLength, UErrorCode *status)
Returns the next element in the iterator's list.
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition: uversion.h:131
const UChar * uenum_unext(UEnumeration *en, int32_t *resultLength, UErrorCode *status)
Returns the next element in the iterator's list.
#define U_DEFINE_LOCAL_OPEN_POINTER(LocalPointerClassName, Type, closeFunction)
"Smart pointer" definition macro, deletes objects via the closeFunction.
Definition: localpointer.h:530
C++ API: "Smart pointers" for use with and in ICU4C C++ code.
int32_t uenum_count(UEnumeration *en, UErrorCode *status)
Returns the number of elements that the iterator traverses.
UEnumeration * uenum_openCharStringsEnumeration(const char *const strings[], int32_t count, UErrorCode *ec)
Given an array of const char* strings (invariant chars only), return a UEnumeration.
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:337
#define U_NAMESPACE_END
This is used to end a declaration of a public ICU C++ API.
Definition: uversion.h:132
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers...
Definition: utypes.h:396
C++ API: String Enumeration.
Basic definitions for ICU, for both C and C++ APIs.
"Smart pointer" class, closes a UEnumeration via uenum_close().
void uenum_reset(UEnumeration *en, UErrorCode *status)
Resets the iterator to the current list of service IDs.
UEnumeration * uenum_openFromStringEnumeration(icu::StringEnumeration *adopted, UErrorCode *ec)
Given a StringEnumeration, wrap it in a UEnumeration.
#define U_STABLE
This is used to declare a function as a stable public ICU C API.
Definition: umachine.h:134