ICU 56.1: ufieldpositer.h Source File

ICU 56.1 56.1

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

- File List
- Globals

ufieldpositer.h
Go to the documentation of this file.
1 /*
2 *****************************************************************************************
3 * Copyright (C) 2015, International Business Machines
4 * Corporation and others. All Rights Reserved.
5 *****************************************************************************************
6 */
7
8 #ifndef UFIELDPOSITER_H
9 #define UFIELDPOSITER_H
10
11 #include "unicode/utypes.h"
12
13 #if !UCONFIG_NO_FORMATTING
14 #ifndef U_HIDE_DRAFT_API
15
16 #include "unicode/localpointer.h"
17
42 struct UFieldPositionIterator;
43 typedef struct UFieldPositionIterator UFieldPositionIterator;
54 U_DRAFT UFieldPositionIterator* U_EXPORT2
55 ufieldpositer_open(UErrorCode* status);
56
63 U_DRAFT void U_EXPORT2
64 ufieldpositer_close(UFieldPositionIterator *fpositer);
65
66
67 #if U_SHOW_CPLUSPLUS_API
68
69 U_NAMESPACE_BEGIN
70
80 U_DEFINE_LOCAL_OPEN_POINTER(LocalUFieldPositionIteratorPointer, UFieldPositionIterator, ufieldpositer_close);
81
82 U_NAMESPACE_END
83
84 #endif
85
114 U_DRAFT int32_t U_EXPORT2
115 ufieldpositer_next(UFieldPositionIterator *fpositer,
116 int32_t *beginIndex, int32_t *endIndex);
117
118 #endif /* U_HIDE_DRAFT_API */
119 #endif /* #if !UCONFIG_NO_FORMATTING */
120
121 #endif
ufieldpositer_open
UFieldPositionIterator * ufieldpositer_open(UErrorCode *status)
Open a new, unset UFieldPositionIterator object.
UFieldPositionIterator
struct UFieldPositionIterator UFieldPositionIterator
C typedef for struct UFieldPositionIterator.
Definition: ufieldpositer.h:43
U_NAMESPACE_BEGIN
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition: uversion.h:129
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
LocalUFieldPositionIteratorPointer
"Smart pointer" class, closes a UFieldPositionIterator via ufieldpositer_close(). ...
localpointer.h
C++ API: "Smart pointers" for use with and in ICU4C C++ code.
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
ufieldpositer_close
void ufieldpositer_close(UFieldPositionIterator *fpositer)
Close a UFieldPositionIterator object.
utypes.h
Basic definitions for ICU, for both C and C++ APIs.
ufieldpositer_next
int32_t ufieldpositer_next(UFieldPositionIterator *fpositer, int32_t *beginIndex, int32_t *endIndex)
Get information for the next field in the formatted string to which this UFieldPositionIterator curre...
U_DRAFT
#define U_DRAFT
This is used to declare a function as a draft public ICU C API.
Definition: umachine.h:111