ICU 57.1 57.1
uregion.h
Go to the documentation of this file.
1/*
2*****************************************************************************************
3* Copyright (C) 2014, International Business Machines
4* Corporation and others. All Rights Reserved.
5*****************************************************************************************
6*/
7
8#ifndef UREGION_H
9#define UREGION_H
10
11#include "unicode/utypes.h"
12#include "unicode/uenum.h"
13
55
114
115#if !UCONFIG_NO_FORMATTING
116
121struct URegion;
122typedef struct URegion URegion;
123
132U_STABLE const URegion* U_EXPORT2
133uregion_getRegionFromCode(const char *regionCode, UErrorCode *status);
134
140U_STABLE const URegion* U_EXPORT2
142
148U_STABLE UEnumeration* U_EXPORT2
150
155U_STABLE UBool U_EXPORT2
156uregion_areEqual(const URegion* uregion, const URegion* otherRegion);
157
164U_STABLE const URegion* U_EXPORT2
166
176U_STABLE const URegion* U_EXPORT2
178
189U_STABLE UEnumeration* U_EXPORT2
191
201U_STABLE UEnumeration* U_EXPORT2
203
209U_STABLE UBool U_EXPORT2
210uregion_contains(const URegion* uregion, const URegion* otherRegion);
211
220U_STABLE UEnumeration* U_EXPORT2
222
227U_STABLE const char* U_EXPORT2
229
235U_STABLE int32_t U_EXPORT2
237
242U_STABLE URegionType U_EXPORT2
243uregion_getType(const URegion* uregion);
244
245
246#endif /* #if !UCONFIG_NO_FORMATTING */
247
248#endif
C API: String Enumeration.
struct UEnumeration UEnumeration
structure representing an enumeration object instance
Definition uenum.h:39
int8_t UBool
The ICU boolean type.
Definition umachine.h:234
#define U_STABLE
This is used to declare a function as a stable public ICU C API.
Definition umachine.h:109
const char * uregion_getRegionCode(const URegion *uregion)
Returns the specified uregion's canonical code.
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,...
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...
UEnumeration * uregion_getPreferredValues(const URegion *uregion, UErrorCode *status)
If the specified uregion is deprecated, returns an enumeration over the canonical codes of the region...
const URegion * uregion_getContainingRegion(const URegion *uregion)
Returns a pointer to the URegion that contains the specified uregion.
const URegion * uregion_getRegionFromNumericCode(int32_t code, UErrorCode *status)
Returns a pointer to a URegion for the specified numeric region code.
UBool uregion_contains(const URegion *uregion, const URegion *otherRegion)
Returns true if the specified uregion contains the specified otherRegion anywhere in the region hiera...
URegionType uregion_getType(const URegion *uregion)
Returns the URegionType of the specified uregion.
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 ...
UEnumeration * uregion_getAvailable(URegionType type, UErrorCode *status)
Returns an enumeration over the canonical codes of all known regions that match the given type.
URegionType
URegionType is an enumeration defining the different types of regions.
Definition uregion.h:63
@ URGN_LIMIT
Maximum value for this unumeration.
Definition uregion.h:112
@ URGN_CONTINENT
Type representing a continent.
Definition uregion.h:86
@ URGN_WORLD
Type representing the whole world.
Definition uregion.h:80
@ URGN_GROUPING
Type representing a grouping of territories that is not to be used in the normal WORLD/CONTINENT/SUBC...
Definition uregion.h:99
@ URGN_UNKNOWN
Type representing the unknown region.
Definition uregion.h:68
@ URGN_DEPRECATED
Type representing a region whose code has been deprecated, usually due to a country splitting into mu...
Definition uregion.h:106
@ URGN_TERRITORY
Type representing a territory.
Definition uregion.h:74
@ URGN_SUBCONTINENT
Type representing a sub-continent.
Definition uregion.h:92
UBool uregion_areEqual(const URegion *uregion, const URegion *otherRegion)
Returns true if the specified uregion is equal to the specified otherRegion.
struct URegion URegion
Definition uregion.h:122
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...
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...
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers,...
Definition utypes.h:476