ulocdata.h File Reference

#include "unicode/ures.h"
#include "unicode/uloc.h"
#include "unicode/uset.h"

Go to the source code of this file.

Typedefs

typedef enum UMeasurementSystem UMeasurementSystem
 Enumeration for representing the measurement systems.


Enumerations

enum  UMeasurementSystem { UMS_SI, UMS_US, UMS_LIMIT }
 Enumeration for representing the measurement systems. More...


Functions

U_DRAFT USet *U_EXPORT2 ulocdata_getExemplarSet (USet *fillIn, const char *localeID, uint32_t options, UErrorCode *status)
 Returns the set of exemplar characters for a locale.

U_DRAFT UMeasurementSystem
U_EXPORT2 
ulocdata_getMeasurementSystem (const char *localeID, UErrorCode *status)
 Returns the measurement system used in the locale specified by the localeID.

U_DRAFT void U_EXPORT2 ulocdata_getPaperSize (const char *localeID, int32_t *height, int32_t *width, UErrorCode *status)
 Returns the element gives the normal business letter size, and customary units.


Typedef Documentation

typedef enum UMeasurementSystem UMeasurementSystem
 

Enumeration for representing the measurement systems.

Draft:
This API may be changed in the future versions and was introduced in ICU 2.8


Enumeration Type Documentation

enum UMeasurementSystem
 

Enumeration for representing the measurement systems.

Draft:
This API may be changed in the future versions and was introduced in ICU 2.8
Enumeration values:
UMS_SI 
UMS_US  Measurement system specified by SI otherwise known as Metric system.
UMS_LIMIT  Measurement system followed in the United States of America.

Definition at line 62 of file ulocdata.h.


Function Documentation

U_DRAFT USet* U_EXPORT2 ulocdata_getExemplarSet USet fillIn,
const char *  localeID,
uint32_t  options,
UErrorCode status
 

Returns the set of exemplar characters for a locale.

Parameters:
fillIn Pointer to a USet object to receive the exemplar character set for the given locale. Previous contents of fillIn are lost. If fillIn is NULL, then a new USet is created and returned. The caller owns the result and must dispose of it by calling uset_close.
localeID Locale id for which the exemplar character set is to be retrieved.
options Bitmask for options to apply to the exemplar pattern. Specify zero to retrieve the exemplar set as it is defined in the locale data. Specify USET_CASE_INSENSITIVE to retrieve a case-folded exemplar set. See uset_applyPattern for a complete list of valid options. The USET_IGNORE_SPACE bit is always set, regardless of the value of 'options'.
status Pointer to an input-output error code value; must not be NULL.
Returns:
USet* Either fillIn, or if fillIn is NULL, a pointer to a newly-allocated USet that the user must close.
Draft:
This API may be changed in the future versions and was introduced in ICU 3.0

U_DRAFT UMeasurementSystem U_EXPORT2 ulocdata_getMeasurementSystem const char *  localeID,
UErrorCode status
 

Returns the measurement system used in the locale specified by the localeID.

Parameters:
localeID The id of the locale for which the measurement system to be retrieved.
status Must be a valid pointer to an error code value, which must not indicate a failure before the function call.
Returns:
UMeasurementSystem the measurement system used in the locale.
Draft:
This API may be changed in the future versions and was introduced in ICU 2.8

U_DRAFT void U_EXPORT2 ulocdata_getPaperSize const char *  localeID,
int32_t height,
int32_t width,
UErrorCode status
 

Returns the element gives the normal business letter size, and customary units.

The units for the numbers are always in milli-meters. For US since 8.5 and 11 do not yeild an integral value when converted to milli-meters, the values are rounded off. So for A4 size paper the height and width are 297 mm and 210 mm repectively, and for US letter size the height and width are 279 mm and 216 mm respectively.

Parameters:
localeID The id of the locale for which the paper size information to be retrieved.
height A pointer to int to recieve the height information.
width A pointer to int to recieve the width information.
status Must be a valid pointer to an error code value, which must not indicate a failure before the function call.
Draft:
This API may be changed in the future versions and was introduced in ICU 2.8


Generated on Fri Jun 18 12:36:11 2004 for ICU by doxygen 1.3.7