ulocdata.h File Reference

C API: Provides access to locale data. More...

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

Go to the source code of this file.

Typedefs

typedef ULocaleData ULocaleData
 A locale data object.

Enumerations

enum  ULocaleDataExemplarSetType { ULOCDATA_ES_STANDARD = 0, ULOCDATA_ES_AUXILIARY = 1, ULOCDATA_ES_COUNT = 3 }
 The possible types of exemplar character sets. More...
enum  ULocaleDataDelimiterType {
  ULOCDATA_QUOTATION_START = 0, ULOCDATA_QUOTATION_END = 1, ULOCDATA_ALT_QUOTATION_START = 2, ULOCDATA_ALT_QUOTATION_END = 3,
  ULOCDATA_DELIMITER_COUNT = 4
}
 The possible types of delimiters. More...
enum  UMeasurementSystem { UMS_SI, UMS_US, UMS_LIMIT }
 Enumeration for representing the measurement systems. More...

Functions

ULocaleDataulocdata_open (const char *localeID, UErrorCode *status)
 Opens a locale data object for the given locale.
void ulocdata_close (ULocaleData *uld)
 Closes a locale data object.
void ulocdata_setNoSubstitute (ULocaleData *uld, UBool setting)
 Sets the "no Substitute" attribute of the locale data object.
UBool ulocdata_getNoSubstitute (ULocaleData *uld)
 Retrieves the current "no Substitute" value of the locale data object.
USetulocdata_getExemplarSet (ULocaleData *uld, USet *fillIn, uint32_t options, ULocaleDataExemplarSetType extype, UErrorCode *status)
 Returns the set of exemplar characters for a locale.
int32_t ulocdata_getDelimiter (ULocaleData *uld, ULocaleDataDelimiterType type, UChar *result, int32_t resultLength, UErrorCode *status)
 Returns one of the delimiter strings associated with a locale.
UMeasurementSystem ulocdata_getMeasurementSystem (const char *localeID, UErrorCode *status)
 Returns the measurement system used in the locale specified by the localeID.
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.


Detailed Description

C API: Provides access to locale data.

Definition in file ulocdata.h.


Typedef Documentation

typedef struct ULocaleData ULocaleData

A locale data object.

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

Definition at line 33 of file ulocdata.h.


Enumeration Type Documentation

enum ULocaleDataDelimiterType

The possible types of delimiters.

Draft:
This API may be changed in the future versions and was introduced in ICU 3.4
Enumerator:
ULOCDATA_QUOTATION_START 
ULOCDATA_QUOTATION_END 
ULOCDATA_ALT_QUOTATION_START 
ULOCDATA_ALT_QUOTATION_END 
ULOCDATA_DELIMITER_COUNT 

Definition at line 51 of file ulocdata.h.

enum ULocaleDataExemplarSetType

The possible types of exemplar character sets.

Draft:
This API may be changed in the future versions and was introduced in ICU 3.4
Enumerator:
ULOCDATA_ES_STANDARD 
ULOCDATA_ES_AUXILIARY 
ULOCDATA_ES_COUNT 

Definition at line 40 of file ulocdata.h.

enum UMeasurementSystem

Enumeration for representing the measurement systems.

Stable:
ICU 2.8
Enumerator:
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 158 of file ulocdata.h.


Function Documentation

void ulocdata_close ( ULocaleData uld  ) 

Closes a locale data object.

Parameters:
uld The locale data object to close
Draft:
This API may be changed in the future versions and was introduced in ICU 3.4

int32_t ulocdata_getDelimiter ( ULocaleData uld,
ULocaleDataDelimiterType  type,
UChar *  result,
int32_t  resultLength,
UErrorCode status 
)

Returns one of the delimiter strings associated with a locale.

Parameters:
uld Pointer to the locale data object from which the delimiter string is to be retrieved.
type the type of delimiter to be retrieved.
result A pointer to a buffer to receive the result.
resultLength The maximum size of result.
status Pointer to an error code value
Returns:
int32_t The total buffer size needed; if greater than resultLength, the output was truncated.
Draft:
This API may be changed in the future versions and was introduced in ICU 3.4

USet* ulocdata_getExemplarSet ( ULocaleData uld,
USet fillIn,
uint32_t  options,
ULocaleDataExemplarSetType  extype,
UErrorCode status 
)

Returns the set of exemplar characters for a locale.

Parameters:
uld Pointer to the locale data object from which the exemplar character set is to be retrieved.
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.
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'.
extype Specifies the type of exemplar set to be retrieved.
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.4

UMeasurementSystem ulocdata_getMeasurementSystem ( const char *  localeID,
UErrorCode status 
)

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

Please note that this API will change in ICU 3.6 and will use an ulocdata object.

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.
Stable:
ICU 2.8

UBool ulocdata_getNoSubstitute ( ULocaleData uld  ) 

Retrieves the current "no Substitute" value of the locale data object.

If true, then any methods associated with the locale data object will return null when there is no data available for that method, given the locale ID supplied to ulocdata_open().

Parameters:
uld Pointer to the The locale data object to set.
Returns:
UBool Value of the "no substitute" attribute.
Draft:
This API may be changed in the future versions and was introduced in ICU 3.4

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. Please note that this API will change in ICU 3.6 and will use an ulocdata object.

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.
Stable:
ICU 2.8

ULocaleData* ulocdata_open ( const char *  localeID,
UErrorCode status 
)

Opens a locale data object for the given locale.

Parameters:
localeID Specifies the locale associated with this locale data object.
status Pointer to error status code.
Draft:
This API may be changed in the future versions and was introduced in ICU 3.4

void ulocdata_setNoSubstitute ( ULocaleData uld,
UBool  setting 
)

Sets the "no Substitute" attribute of the locale data object.

If true, then any methods associated with the locale data object will return null when there is no data available for that method, given the locale ID supplied to ulocdata_open().

Parameters:
uld The locale data object to set.
setting Value of the "no substitute" attribute.
Draft:
This API may be changed in the future versions and was introduced in ICU 3.4


Generated on Mon Aug 13 07:17:27 2007 for ICU 3.6 by  doxygen 1.5.2