Main Page   Class Hierarchy   Compound List   File List   Header Files   Sources   Compound Members   File Members  

UDataInfo Struct Reference

Information about data memory. More...

#include <udata.h>

List of all members.


Public Members

uint16_t size
sizeof(UDataInfo).

uint16_t reservedWord
unused, set to 0.

uint8_t isBigEndian
0 for little-endian machine, 1 for big-endian.

uint8_t charsetFamily
see U_CHARSET_FAMILY values in utypes.h.

uint8_t sizeofUChar
sizeof(UChar), one of { 1, 2, 4 }.

uint8_t reservedByte
unused, set to 0.

uint8_t dataFormat [4]
data format identifier.

uint8_t formatVersion [4]
versions: [0] major [1] minor [2] milli [3] micro.

uint8_t dataVersion [4]


Detailed Description

Information about data memory.

This structure may grow in the future, indicated by the size field.

The platform data property fields help determine if a data file can be efficiently used on a given machine. The particular fields are of importance only if the data is affected by the properties - if there is integer data with word sizes > 1 byte, char* text, or UChar* text.

The implementation for the udata_open[Choice]() functions may reject data based on the value in isBigEndian. No other field is used by the udata API implementation.

The dataFormat may be used to identify the kind of data, e.g. a converter table.

The formatVersion field should be used to make sure that the format can be interpreted. I may be a good idea to check only for the one or two highest of the version elements to allow the data memory to get more or somewhat rearranged contents, for as long as the using code can still interpret the older contents.

The dataVersion field is intended to be a common place to store the source version of the data; for data from the Unicode character database, this could reflect the Unicode version.

Definition at line 54 of file udata.h.


Member Data Documentation

uint16_t UDataInfo::size

sizeof(UDataInfo).

Definition at line 56 of file udata.h.

uint16_t UDataInfo::reservedWord

unused, set to 0.

Definition at line 59 of file udata.h.

uint8_t UDataInfo::isBigEndian

0 for little-endian machine, 1 for big-endian.

Definition at line 63 of file udata.h.

uint8_t UDataInfo::charsetFamily

see U_CHARSET_FAMILY values in utypes.h.

Definition at line 66 of file udata.h.

uint8_t UDataInfo::sizeofUChar

sizeof(UChar), one of { 1, 2, 4 }.

Definition at line 69 of file udata.h.

uint8_t UDataInfo::reservedByte

unused, set to 0.

Definition at line 72 of file udata.h.

uint8_t UDataInfo::dataFormat[4]

data format identifier.

Definition at line 75 of file udata.h.

uint8_t UDataInfo::formatVersion[4]

versions: [0] major [1] minor [2] milli [3] micro.

Definition at line 78 of file udata.h.

uint8_t UDataInfo::dataVersion[4]

Definition at line 79 of file udata.h.


The documentation for this struct was generated from the following file:
Generated at Wed Aug 16 16:05:52 2000 for ICU1.6 by doxygen 1.0.0 written by Dimitri van Heesch, © 1997-1999