ICU 63.1 63.1

ufieldpositer.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 * Copyright (C) 2015-2016, International Business Machines
6 * Corporation and others. All Rights Reserved.
7 *****************************************************************************************
8 */
9
10 #ifndef UFIELDPOSITER_H
11 #define UFIELDPOSITER_H
12
13 #include "unicode/utypes.h"
14
15 #if !UCONFIG_NO_FORMATTING
16
17 #include "unicode/localpointer.h"
18
43 struct UFieldPositionIterator;
44 typedef struct UFieldPositionIterator UFieldPositionIterator;
55 U_STABLE UFieldPositionIterator* U_EXPORT2
56 ufieldpositer_open(UErrorCode* status);
57
64 U_STABLE void U_EXPORT2
65 ufieldpositer_close(UFieldPositionIterator *fpositer);
66
67
68 #if U_SHOW_CPLUSPLUS_API
69
70 U_NAMESPACE_BEGIN
71
81 U_DEFINE_LOCAL_OPEN_POINTER(LocalUFieldPositionIteratorPointer, UFieldPositionIterator, ufieldpositer_close);
82
83 U_NAMESPACE_END
84
85 #endif
86
115 U_STABLE int32_t U_EXPORT2
116 ufieldpositer_next(UFieldPositionIterator *fpositer,
117 int32_t *beginIndex, int32_t *endIndex);
118
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:44
U_NAMESPACE_BEGIN
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition: uversion.h:137
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:487
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:138
UErrorCode
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers...
Definition: utypes.h:401
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_STABLE
#define U_STABLE
This is used to declare a function as a stable public ICU C API.
Definition: umachine.h:111