Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Search  

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


Enumerations

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


Functions

USetulocdata_getExemplarSet (USet *fillIn, const char *localeID, UErrorCode *status)
 Fills the set with the set of exemplar characters for the locale and returns the set. More...

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

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


Typedef Documentation

typedef enum UMeasurementSystem UMeasurementSystem
 

Enumeration for representing the measurement systems.

Draft:
This API has been introduced in ICU 2.8. It is still in draft state and may be modified in a future release.


Enumeration Type Documentation

enum UMeasurementSystem
 

Enumeration for representing the measurement systems.

Draft:
This API has been introduced in ICU 2.8. It is still in draft state and may be modified in a future release.
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 49 of file ulocdata.h.


Function Documentation

USet* ulocdata_getExemplarSet USet   fillIn,
const char *    localeID,
UErrorCode   status
 

Fills the set with the set of exemplar characters for the locale and returns the set.

Parameters:
fillIn  A pointer to USet object to be filled in with the exemplar characters set for the locale. If NULL is passed, then a new USet will be created and returned. The caller owns this object and must dispose it by calling uset_close.
localeID  The id of the locale for which the exemplar character set needs 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:
USet* The pointer to the fillIn USet object.
Draft:
This API has been introduced in ICU 2.8. It is still in draft state and may be modified in a future release.

UMeasurementSystem 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 has been introduced in ICU 2.8. It is still in draft state and may be modified in a future release.

void 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 has been introduced in ICU 2.8. It is still in draft state and may be modified in a future release.


Generated on Mon Nov 24 14:36:01 2003 for ICU 2.8 by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001