ICU 70.1  70.1
uregion.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) 2014, International Business Machines
6 * Corporation and others. All Rights Reserved.
7 *****************************************************************************************
8 */
9 
10 #ifndef UREGION_H
11 #define UREGION_H
12 
13 #include "unicode/utypes.h"
14 #include "unicode/uenum.h"
15 
65 typedef enum URegionType {
71 
77 
83 
89 
95 
102 
109 
110 #ifndef U_HIDE_DEPRECATED_API
115  URGN_LIMIT
116 #endif /* U_HIDE_DEPRECATED_API */
118 
119 #if !UCONFIG_NO_FORMATTING
120 
125 struct URegion;
126 typedef struct URegion URegion;
136 U_CAPI const URegion* U_EXPORT2
137 uregion_getRegionFromCode(const char *regionCode, UErrorCode *status);
138 
144 U_CAPI const URegion* U_EXPORT2
146 
152 U_CAPI UEnumeration* U_EXPORT2
154 
159 U_CAPI UBool U_EXPORT2
160 uregion_areEqual(const URegion* uregion, const URegion* otherRegion);
161 
168 U_CAPI const URegion* U_EXPORT2
170 
180 U_CAPI const URegion* U_EXPORT2
182 
193 U_CAPI UEnumeration* U_EXPORT2
195 
205 U_CAPI UEnumeration* U_EXPORT2
207 
213 U_CAPI UBool U_EXPORT2
214 uregion_contains(const URegion* uregion, const URegion* otherRegion);
215 
224 U_CAPI UEnumeration* U_EXPORT2
226 
231 U_CAPI const char* U_EXPORT2
233 
239 U_CAPI int32_t U_EXPORT2
241 
246 U_CAPI URegionType U_EXPORT2
247 uregion_getType(const URegion* uregion);
248 
249 
250 #endif /* #if !UCONFIG_NO_FORMATTING */
251 
252 #endif
C API: String Enumeration.
struct UEnumeration UEnumeration
structure representing an enumeration object instance
Definition: uenum.h:44
int8_t UBool
The ICU boolean type, a signed-byte integer.
Definition: umachine.h:269
#define U_CAPI
This is used to declare a function as a public ICU C API.
Definition: umachine.h:110
U_CAPI const URegion * uregion_getContainingRegion(const URegion *uregion)
Returns a pointer to the URegion that contains the specified uregion.
U_CAPI UBool uregion_contains(const URegion *uregion, const URegion *otherRegion)
Returns true if the specified uregion contains the specified otherRegion anywhere in the region hiera...
U_CAPI const URegion * uregion_getContainingRegionOfType(const URegion *uregion, URegionType type)
Return a pointer to the URegion that geographically contains this uregion and matches the specified t...
U_CAPI UEnumeration * uregion_getAvailable(URegionType type, UErrorCode *status)
Returns an enumeration over the canonical codes of all known regions that match the given type.
U_CAPI const URegion * uregion_getRegionFromNumericCode(int32_t code, UErrorCode *status)
Returns a pointer to a URegion for the specified numeric region code.
U_CAPI const URegion * uregion_getRegionFromCode(const char *regionCode, UErrorCode *status)
Returns a pointer to a URegion for the specified region code: A 2-letter or 3-letter ISO 3166 code,...
U_CAPI UEnumeration * uregion_getPreferredValues(const URegion *uregion, UErrorCode *status)
If the specified uregion is deprecated, returns an enumeration over the canonical codes of the region...
URegionType
URegionType is an enumeration defining the different types of regions.
Definition: uregion.h:65
@ URGN_LIMIT
One more than the highest normal URegionType value.
Definition: uregion.h:115
@ URGN_CONTINENT
Type representing a continent.
Definition: uregion.h:88
@ URGN_WORLD
Type representing the whole world.
Definition: uregion.h:82
@ URGN_GROUPING
Type representing a grouping of territories that is not to be used in the normal WORLD/CONTINENT/SUBC...
Definition: uregion.h:101
@ URGN_UNKNOWN
Type representing the unknown region.
Definition: uregion.h:70
@ URGN_DEPRECATED
Type representing a region whose code has been deprecated, usually due to a country splitting into mu...
Definition: uregion.h:108
@ URGN_TERRITORY
Type representing a territory.
Definition: uregion.h:76
@ URGN_SUBCONTINENT
Type representing a sub-continent.
Definition: uregion.h:94
struct URegion URegion
Definition: uregion.h:126
U_CAPI UEnumeration * uregion_getContainedRegionsOfType(const URegion *uregion, URegionType type, UErrorCode *status)
Returns an enumeration over the canonical codes of all the regions that are children of the specified...
U_CAPI UBool uregion_areEqual(const URegion *uregion, const URegion *otherRegion)
Returns true if the specified uregion is equal to the specified otherRegion.
U_CAPI UEnumeration * uregion_getContainedRegions(const URegion *uregion, UErrorCode *status)
Return an enumeration over the canonical codes of all the regions that are immediate children of the ...
U_CAPI int32_t uregion_getNumericCode(const URegion *uregion)
Returns the specified uregion's numeric code, or a negative value if there is no numeric code for the...
U_CAPI URegionType uregion_getType(const URegion *uregion)
Returns the URegionType of the specified uregion.
U_CAPI const char * uregion_getRegionCode(const URegion *uregion)
Returns the specified uregion's canonical code.
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition: utypes.h:415