<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>ICU 3.6: UDataInfo Struct Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.7 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li id="current"><a href="classes.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li>
<form action="search.php" method="get">
<table cellspacing="0" cellpadding="0" border="0">
<tr>
<td><label> <u>S</u>earch for </label></td>
<td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
</tr>
</table>
</form>
</li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul></div>
<h1>UDataInfo Struct Reference</h1><!-- doxytag: class="UDataInfo" --><a class="el" href="structUDataInfo.html">UDataInfo</a> contains the properties about the requested data.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="udata_8h-source.html">udata.h</a>></code>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#009defcb88ef0180917f5d2ca68a5c30">uint16_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structUDataInfo.html#c574c73e15ab862e1ff01460e9a28cdf">size</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">sizeof(UDataInfo) <a href="#c574c73e15ab862e1ff01460e9a28cdf"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#009defcb88ef0180917f5d2ca68a5c30">uint16_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structUDataInfo.html#b985ed1e91e3f854ff721631577d97c3">reservedWord</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">unused, set to 0 <a href="#b985ed1e91e3f854ff721631577d97c3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#3ebf7c4fcbf17b618a01df30a79859d3">uint8_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structUDataInfo.html#2f89581c1ad86d73bcd46d9c73973d39">isBigEndian</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">0 for little-endian machine, 1 for big-endian <a href="#2f89581c1ad86d73bcd46d9c73973d39"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#3ebf7c4fcbf17b618a01df30a79859d3">uint8_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structUDataInfo.html#cf7b86edb12850b10699a05e74366ae0">charsetFamily</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">see U_CHARSET_FAMILY values in <a class="el" href="utypes_8h.html">utypes.h</a> <a href="#cf7b86edb12850b10699a05e74366ae0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#3ebf7c4fcbf17b618a01df30a79859d3">uint8_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structUDataInfo.html#f5cb5d734c69c92afffcca540edc44cc">sizeofUChar</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">sizeof(UChar), one of { 1, 2, 4 } <a href="#f5cb5d734c69c92afffcca540edc44cc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#3ebf7c4fcbf17b618a01df30a79859d3">uint8_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structUDataInfo.html#89a78a97ea466e61e34d5f0e0ed4df8d">reservedByte</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">unused, set to 0 <a href="#89a78a97ea466e61e34d5f0e0ed4df8d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#3ebf7c4fcbf17b618a01df30a79859d3">uint8_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structUDataInfo.html#930e8b9adedc6dc9b25a70bf54f96f38">dataFormat</a> [4]</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">data format identifier <a href="#930e8b9adedc6dc9b25a70bf54f96f38"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#3ebf7c4fcbf17b618a01df30a79859d3">uint8_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structUDataInfo.html#980b15d5ed1dd7bcad0561e6f619016e">formatVersion</a> [4]</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">versions: [0] major [1] minor [2] milli [3] micro <a href="#980b15d5ed1dd7bcad0561e6f619016e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#3ebf7c4fcbf17b618a01df30a79859d3">uint8_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structUDataInfo.html#da1b2a726f51a673c91b27a13a02ef1a">dataVersion</a> [4]</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">versions: [0] major [1] minor [2] milli [3] micro <a href="#da1b2a726f51a673c91b27a13a02ef1a"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="structUDataInfo.html">UDataInfo</a> contains the properties about the requested data.
<p>
This is meta data.<p>
This structure may grow in the future, indicated by the <code>size</code> field.<p>
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.<p>
The implementation for the <code>udata_open[Choice]()</code> functions may reject data based on the value in <code>isBigEndian</code>. No other field is used by the <code>udata</code> API implementation.<p>
The <code>dataFormat</code> may be used to identify the kind of data, e.g. a converter table.<p>
The <code>formatVersion</code> 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.<p>
The <code>dataVersion</code> 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. <dl compact><dt><b><a class="el" href="stable.html#_stable000972">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
<p>
Definition at line <a class="el" href="udata_8h-source.html#l00105">105</a> of file <a class="el" href="udata_8h-source.html">udata.h</a>.<hr><h2>Field Documentation</h2>
<a class="anchor" name="cf7b86edb12850b10699a05e74366ae0"></a><!-- doxytag: member="UDataInfo::charsetFamily" ref="cf7b86edb12850b10699a05e74366ae0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#3ebf7c4fcbf17b618a01df30a79859d3">uint8_t</a> <a class="el" href="structUDataInfo.html#cf7b86edb12850b10699a05e74366ae0">UDataInfo::charsetFamily</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
see U_CHARSET_FAMILY values in <a class="el" href="utypes_8h.html">utypes.h</a>
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000985">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="udata_8h-source.html#l00121">121</a> of file <a class="el" href="udata_8h-source.html">udata.h</a>.
</div>
</div><p>
<a class="anchor" name="930e8b9adedc6dc9b25a70bf54f96f38"></a><!-- doxytag: member="UDataInfo::dataFormat" ref="930e8b9adedc6dc9b25a70bf54f96f38" args="[4]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#3ebf7c4fcbf17b618a01df30a79859d3">uint8_t</a> <a class="el" href="structUDataInfo.html#930e8b9adedc6dc9b25a70bf54f96f38">UDataInfo::dataFormat</a>[4] </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
data format identifier
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000988">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="udata_8h-source.html#l00133">133</a> of file <a class="el" href="udata_8h-source.html">udata.h</a>.
</div>
</div><p>
<a class="anchor" name="da1b2a726f51a673c91b27a13a02ef1a"></a><!-- doxytag: member="UDataInfo::dataVersion" ref="da1b2a726f51a673c91b27a13a02ef1a" args="[4]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#3ebf7c4fcbf17b618a01df30a79859d3">uint8_t</a> <a class="el" href="structUDataInfo.html#da1b2a726f51a673c91b27a13a02ef1a">UDataInfo::dataVersion</a>[4] </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
versions: [0] major [1] minor [2] milli [3] micro
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000990">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="udata_8h-source.html#l00141">141</a> of file <a class="el" href="udata_8h-source.html">udata.h</a>.
</div>
</div><p>
<a class="anchor" name="980b15d5ed1dd7bcad0561e6f619016e"></a><!-- doxytag: member="UDataInfo::formatVersion" ref="980b15d5ed1dd7bcad0561e6f619016e" args="[4]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#3ebf7c4fcbf17b618a01df30a79859d3">uint8_t</a> <a class="el" href="structUDataInfo.html#980b15d5ed1dd7bcad0561e6f619016e">UDataInfo::formatVersion</a>[4] </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
versions: [0] major [1] minor [2] milli [3] micro
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000989">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="udata_8h-source.html#l00137">137</a> of file <a class="el" href="udata_8h-source.html">udata.h</a>.
</div>
</div><p>
<a class="anchor" name="2f89581c1ad86d73bcd46d9c73973d39"></a><!-- doxytag: member="UDataInfo::isBigEndian" ref="2f89581c1ad86d73bcd46d9c73973d39" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#3ebf7c4fcbf17b618a01df30a79859d3">uint8_t</a> <a class="el" href="structUDataInfo.html#2f89581c1ad86d73bcd46d9c73973d39">UDataInfo::isBigEndian</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
0 for little-endian machine, 1 for big-endian
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000984">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="udata_8h-source.html#l00117">117</a> of file <a class="el" href="udata_8h-source.html">udata.h</a>.
</div>
</div><p>
<a class="anchor" name="89a78a97ea466e61e34d5f0e0ed4df8d"></a><!-- doxytag: member="UDataInfo::reservedByte" ref="89a78a97ea466e61e34d5f0e0ed4df8d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#3ebf7c4fcbf17b618a01df30a79859d3">uint8_t</a> <a class="el" href="structUDataInfo.html#89a78a97ea466e61e34d5f0e0ed4df8d">UDataInfo::reservedByte</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
unused, set to 0
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000987">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="udata_8h-source.html#l00129">129</a> of file <a class="el" href="udata_8h-source.html">udata.h</a>.
</div>
</div><p>
<a class="anchor" name="b985ed1e91e3f854ff721631577d97c3"></a><!-- doxytag: member="UDataInfo::reservedWord" ref="b985ed1e91e3f854ff721631577d97c3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#009defcb88ef0180917f5d2ca68a5c30">uint16_t</a> <a class="el" href="structUDataInfo.html#b985ed1e91e3f854ff721631577d97c3">UDataInfo::reservedWord</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
unused, set to 0
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000983">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="udata_8h-source.html#l00112">112</a> of file <a class="el" href="udata_8h-source.html">udata.h</a>.
</div>
</div><p>
<a class="anchor" name="c574c73e15ab862e1ff01460e9a28cdf"></a><!-- doxytag: member="UDataInfo::size" ref="c574c73e15ab862e1ff01460e9a28cdf" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#009defcb88ef0180917f5d2ca68a5c30">uint16_t</a> <a class="el" href="structUDataInfo.html#c574c73e15ab862e1ff01460e9a28cdf">UDataInfo::size</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
sizeof(UDataInfo)
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000982">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="udata_8h-source.html#l00108">108</a> of file <a class="el" href="udata_8h-source.html">udata.h</a>.
</div>
</div><p>
<a class="anchor" name="f5cb5d734c69c92afffcca540edc44cc"></a><!-- doxytag: member="UDataInfo::sizeofUChar" ref="f5cb5d734c69c92afffcca540edc44cc" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#3ebf7c4fcbf17b618a01df30a79859d3">uint8_t</a> <a class="el" href="structUDataInfo.html#f5cb5d734c69c92afffcca540edc44cc">UDataInfo::sizeofUChar</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
sizeof(UChar), one of { 1, 2, 4 }
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000986">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="udata_8h-source.html#l00125">125</a> of file <a class="el" href="udata_8h-source.html">udata.h</a>.
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="udata_8h-source.html">udata.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Dec 13 17:29:55 2011 for ICU 3.6 by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
</body>
</html>
