x86_64/Packages/alt-libicu57-doc-57.1-5.el10.noarch.rpm

/*

*****************************************************************************************

* Copyright (C) 2015-2016, International Business Machines

* Corporation and others. All Rights Reserved.

*****************************************************************************************

*/


#ifndef UFIELDPOSITER_H

#define UFIELDPOSITER_H


#include "unicode/utypes.h"


#if !UCONFIG_NO_FORMATTING


#include "unicode/localpointer.h"


struct UFieldPositionIterator;

typedef struct UFieldPositionIterator UFieldPositionIterator;


U_STABLE UFieldPositionIterator* U_EXPORT2

ufieldpositer_open(UErrorCode* status);


U_STABLE void U_EXPORT2

ufieldpositer_close(UFieldPositionIterator *fpositer);


#if U_SHOW_CPLUSPLUS_API


U_NAMESPACE_BEGIN


U_DEFINE_LOCAL_OPEN_POINTER(LocalUFieldPositionIteratorPointer, UFieldPositionIterator, ufieldpositer_close);


U_NAMESPACE_END


#endif


U_STABLE int32_t U_EXPORT2

ufieldpositer_next(UFieldPositionIterator *fpositer,

                   int32_t *beginIndex, int32_t *endIndex);


#endif /* #if !UCONFIG_NO_FORMATTING */


#endif

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_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:539

ufieldpositer_close
void ufieldpositer_close(UFieldPositionIterator *fpositer)
Close a UFieldPositionIterator object.

ufieldpositer_open
UFieldPositionIterator * ufieldpositer_open(UErrorCode *status)
Open a new, unset UFieldPositionIterator object.

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...

UFieldPositionIterator
struct UFieldPositionIterator UFieldPositionIterator
C typedef for struct UFieldPositionIterator.
Definition ufieldpositer.h:42

U_STABLE
#define U_STABLE
This is used to declare a function as a stable public ICU C API.
Definition umachine.h:109

utypes.h
Basic definitions for ICU, for both C and C++ APIs.

UErrorCode
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers,...
Definition utypes.h:476

U_NAMESPACE_END
#define U_NAMESPACE_END
This is used to end a declaration of a public ICU C++ API.
Definition uversion.h:130

U_NAMESPACE_BEGIN
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition uversion.h:129