ICU 62.1 62.1
uenum.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*
6* Copyright (C) 2002-2013, International Business Machines
7* Corporation and others. All Rights Reserved.
8*
9*******************************************************************************
10* file name: uenum.h
11* encoding: UTF-8
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"
24
25#if U_SHOW_CPLUSPLUS_API
27class StringEnumeration;
29#endif
30
41struct UEnumeration;
44
52U_STABLE void U_EXPORT2
54
55#if U_SHOW_CPLUSPLUS_API
56
58
69
71
72#endif
73
88U_STABLE int32_t U_EXPORT2
90
112U_STABLE const UChar* U_EXPORT2
114 int32_t* resultLength,
115 UErrorCode* status);
116
145U_STABLE const char* U_EXPORT2
147 int32_t* resultLength,
148 UErrorCode* status);
149
159U_STABLE void U_EXPORT2
161
162#if U_SHOW_CPLUSPLUS_API
163
173U_STABLE UEnumeration* U_EXPORT2
175
176#endif
177
189U_STABLE UEnumeration* U_EXPORT2
190uenum_openUCharStringsEnumeration(const UChar* const strings[], int32_t count,
191 UErrorCode* ec);
192
193/* Note: next function is not hidden as draft, as it is used internally (it was formerly an internal function). */
194
206U_STABLE UEnumeration* U_EXPORT2
207uenum_openCharStringsEnumeration(const char* const strings[], int32_t count,
208 UErrorCode* ec);
209
210#endif
"Smart pointer" class, closes a UEnumeration via uenum_close().
Base class for 'pure' C++ implementations of uenum api.
Definition strenum.h:57
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.
struct UEnumeration UEnumeration
structure representing an enumeration object instance
Definition uenum.h:43
const char * uenum_next(UEnumeration *en, int32_t *resultLength, UErrorCode *status)
Returns the next element in the iterator's list.
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.
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.
const UChar * uenum_unext(UEnumeration *en, int32_t *resultLength, UErrorCode *status)
Returns the next element in the iterator's list.
UEnumeration * uenum_openUCharStringsEnumeration(const UChar *const strings[], int32_t count, UErrorCode *ec)
Given an array of const UChar* strings, return a UEnumeration.
void uenum_close(UEnumeration *en)
Disposes of resources in use by the iterator.
uint16_t UChar
The base type for UTF-16 code units and pointers.
Definition umachine.h:353
#define U_STABLE
This is used to declare a function as a stable public ICU C API.
Definition umachine.h:111
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