ICU 4.2.1
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
uenum.h
Go to the documentation of this file.
1 /*
2 *******************************************************************************
3 *
4 * Copyright (C) 2002-2009, 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 
22 #ifdef XP_CPLUSPLUS
23 #include "unicode/strenum.h"
24 #endif
25 
36 struct UEnumeration;
38 typedef struct UEnumeration UEnumeration;
39 
49 
65 uenum_count(UEnumeration* en, UErrorCode* status);
66 
90  int32_t* resultLength,
91  UErrorCode* status);
92 
121 U_STABLE const char* U_EXPORT2
123  int32_t* resultLength,
124  UErrorCode* status);
125 
135 U_STABLE void U_EXPORT2
136 uenum_reset(UEnumeration* en, UErrorCode* status);
137 
138 #ifdef XP_CPLUSPLUS
139 
150 uenum_openFromStringEnumeration(U_NAMESPACE_QUALIFIER StringEnumeration* adopted, UErrorCode* ec);
151 
152 #endif
153 
154 #endif
#define U_CAPI
This is used to declare a function as a public ICU C API.
Definition: umachine.h:115
void uenum_close(UEnumeration *en)
Disposes of resources in use by the iterator.
struct UEnumeration UEnumeration
structure representing an enumeration object instance
Definition: uenum.h:38
const char * uenum_next(UEnumeration *en, int32_t *resultLength, UErrorCode *status)
Returns the next element in the iterator's list.
const UChar * uenum_unext(UEnumeration *en, int32_t *resultLength, UErrorCode *status)
Returns the next element in the iterator's list.
#define U_NAMESPACE_QUALIFIER
This is used to qualify that a function or class is part of the public ICU C++ API namespace...
Definition: uversion.h:186
int32_t uenum_count(UEnumeration *en, UErrorCode *status)
Returns the number of elements that the iterator traverses.
#define U_EXPORT2
Definition: platform.h:338
uint16_t UChar
Define UChar to be wchar_t if that is 16 bits wide; always assumed to be unsigned.
Definition: umachine.h:299
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers...
Definition: utypes.h:593
Base class for 'pure' C++ implementations of uenum api.
Definition: strenum.h:55
C++ API: String Enumeration.
Basic definitions for ICU, for both C and C++ APIs.
void uenum_reset(UEnumeration *en, UErrorCode *status)
Resets the iterator to the current list of service IDs.
signed int int32_t
Define 64 bit limits.
Definition: pwin32.h:143
#define U_STABLE
This is used to declare a function as a stable public ICU C API.
Definition: umachine.h:117