ICU 56.1: uenum.h Source File

ICU 56.1 56.1

- Main Page
- Related Pages
- Modules
- Namespaces
- Data Structures
- Files

- File List
- Globals

uenum.h
Go to the documentation of this file.
1 /*
2 *******************************************************************************
3 *
4 * Copyright (C) 2002-2013, International Business Machines
5 * Corporation and others. All Rights Reserved.
6 *
7 *******************************************************************************
8 * file name: uenum.h
9 * encoding: US-ASCII
10 * tab size: 8 (not used)
11 * indentation:2
12 *
13 * created on: 2002jul08
14 * created by: Vladimir Weinstein
15 */
16
17 #ifndef __UENUM_H
18 #define __UENUM_H
19
20 #include "unicode/utypes.h"
21 #include "unicode/localpointer.h"
22
23 #if U_SHOW_CPLUSPLUS_API
24 #include "unicode/strenum.h"
25 #endif
26
37 struct UEnumeration;
39 typedef struct UEnumeration UEnumeration;
40
48 U_STABLE void U_EXPORT2
49 uenum_close(UEnumeration* en);
50
51 #if U_SHOW_CPLUSPLUS_API
52
53 U_NAMESPACE_BEGIN
54
64 U_DEFINE_LOCAL_OPEN_POINTER(LocalUEnumerationPointer, UEnumeration, uenum_close);
65
66 U_NAMESPACE_END
67
68 #endif
69
84 U_STABLE int32_t U_EXPORT2
85 uenum_count(UEnumeration* en, UErrorCode* status);
86
108 U_STABLE const UChar* U_EXPORT2
109 uenum_unext(UEnumeration* en,
110 int32_t* resultLength,
111 UErrorCode* status);
112
141 U_STABLE const char* U_EXPORT2
142 uenum_next(UEnumeration* en,
143 int32_t* resultLength,
144 UErrorCode* status);
145
155 U_STABLE void U_EXPORT2
156 uenum_reset(UEnumeration* en, UErrorCode* status);
157
158 #if U_SHOW_CPLUSPLUS_API
159
169 U_STABLE UEnumeration* U_EXPORT2
170 uenum_openFromStringEnumeration(icu::StringEnumeration* adopted, UErrorCode* ec);
171
172 #endif
173
185 U_STABLE UEnumeration* U_EXPORT2
186 uenum_openUCharStringsEnumeration(const UChar* const strings[], int32_t count,
187 UErrorCode* ec);
188
189 /* Note: next function is not hidden as draft, as it is used internally (it was formerly an internal function). */
190
202 U_STABLE UEnumeration* U_EXPORT2
203 uenum_openCharStringsEnumeration(const char* const strings[], int32_t count,
204 UErrorCode* ec);
205
206 #endif
uenum_close
void uenum_close(UEnumeration *en)
Disposes of resources in use by the iterator.
uenum_openUCharStringsEnumeration
UEnumeration * uenum_openUCharStringsEnumeration(const UChar *const strings[], int32_t count, UErrorCode *ec)
Given an array of const UChar* strings, return a UEnumeration.
UEnumeration
struct UEnumeration UEnumeration
structure representing an enumeration object instance
Definition: uenum.h:39
icu::StringEnumeration
Base class for 'pure' C++ implementations of uenum api.
Definition: strenum.h:55
uenum_next
const char * uenum_next(UEnumeration *en, int32_t *resultLength, UErrorCode *status)
Returns the next element in the iterator's list.
U_NAMESPACE_BEGIN
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition: uversion.h:129
uenum_unext
const UChar * uenum_unext(UEnumeration *en, int32_t *resultLength, UErrorCode *status)
Returns the next element in the iterator's list.
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:535
localpointer.h
C++ API: "Smart pointers" for use with and in ICU4C C++ code.
uenum_count
int32_t uenum_count(UEnumeration *en, UErrorCode *status)
Returns the number of elements that the iterator traverses.
uenum_openCharStringsEnumeration
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.
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_NAMESPACE_END
#define U_NAMESPACE_END
This is used to end a declaration of a public ICU C++ API.
Definition: uversion.h:130
UErrorCode
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers...
Definition: utypes.h:476
strenum.h
C++ API: String Enumeration.
utypes.h
Basic definitions for ICU, for both C and C++ APIs.
LocalUEnumerationPointer
"Smart pointer" class, closes a UEnumeration via uenum_close().
uenum_reset
void uenum_reset(UEnumeration *en, UErrorCode *status)
Resets the iterator to the current list of service IDs.
uenum_openFromStringEnumeration
UEnumeration * uenum_openFromStringEnumeration(icu::StringEnumeration *adopted, UErrorCode *ec)
Given a StringEnumeration, wrap it in a UEnumeration.
U_STABLE
#define U_STABLE
This is used to declare a function as a stable public ICU C API.
Definition: umachine.h:109