File: //opt/alt/alt-nodejs18/root/usr/share/doc/alt-nodejs18-libicu-doc/uversion_8h.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ICU 74.2: common/unicode/uversion.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ICU 74.2
 <span id="projectnumber">74.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_bdd9a5d540de89e9fe90efdfc6973a4f.html">common</a></li><li class="navelem"><a class="el" href="dir_f59c6450ff718ff1b085cfd1c36acbd7.html">unicode</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">uversion.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>C API: API for accessing ICU version numbers.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include "<a class="el" href="umachine_8h_source.html">unicode/umachine.h</a>"</code><br />
<code>#include "<a class="el" href="uvernum_8h_source.html">unicode/uvernum.h</a>"</code><br />
</div>
<p><a href="uversion_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a8855561449c5835245f330ce18b4f781"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="uversion_8h.html#a8855561449c5835245f330ce18b4f781">U_COPYRIGHT_STRING_LENGTH</a>   128</td></tr>
<tr class="memdesc:a8855561449c5835245f330ce18b4f781"><td class="mdescLeft"> </td><td class="mdescRight">Maximum length of the copyright string. <a href="#a8855561449c5835245f330ce18b4f781">More...</a><br /></td></tr>
<tr class="separator:a8855561449c5835245f330ce18b4f781"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acf6cc6b794656998aaaba2ab03f29baf"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="uversion_8h.html#acf6cc6b794656998aaaba2ab03f29baf">U_MAX_VERSION_LENGTH</a>   4</td></tr>
<tr class="memdesc:acf6cc6b794656998aaaba2ab03f29baf"><td class="mdescLeft"> </td><td class="mdescRight">An ICU version consists of up to 4 numbers from 0..255. <a href="#acf6cc6b794656998aaaba2ab03f29baf">More...</a><br /></td></tr>
<tr class="separator:acf6cc6b794656998aaaba2ab03f29baf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7d52298e2afe0f592cf53023d20c31e5"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="uversion_8h.html#a7d52298e2afe0f592cf53023d20c31e5">U_VERSION_DELIMITER</a>   '.'</td></tr>
<tr class="memdesc:a7d52298e2afe0f592cf53023d20c31e5"><td class="mdescLeft"> </td><td class="mdescRight">In a string, ICU version fields are delimited by dots. <a href="#a7d52298e2afe0f592cf53023d20c31e5">More...</a><br /></td></tr>
<tr class="separator:a7d52298e2afe0f592cf53023d20c31e5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af204c175920d1e8b82b1042447194977"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="uversion_8h.html#af204c175920d1e8b82b1042447194977">U_MAX_VERSION_STRING_LENGTH</a>   20</td></tr>
<tr class="memdesc:af204c175920d1e8b82b1042447194977"><td class="mdescLeft"> </td><td class="mdescRight">The maximum length of an ICU version string. <a href="#af204c175920d1e8b82b1042447194977">More...</a><br /></td></tr>
<tr class="separator:af204c175920d1e8b82b1042447194977"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a61caef96ba86d8e86a4031925ea44e94"><td class="memItemLeft" align="right" valign="top">typedef uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="uversion_8h.html#a61caef96ba86d8e86a4031925ea44e94">UVersionInfo</a>[<a class="el" href="uversion_8h.html#acf6cc6b794656998aaaba2ab03f29baf">U_MAX_VERSION_LENGTH</a>]</td></tr>
<tr class="memdesc:a61caef96ba86d8e86a4031925ea44e94"><td class="mdescLeft"> </td><td class="mdescRight">The binary form of a version on ICU APIs is an array of 4 uint8_t. <a href="#a61caef96ba86d8e86a4031925ea44e94">More...</a><br /></td></tr>
<tr class="separator:a61caef96ba86d8e86a4031925ea44e94"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ac4613e9025739ee2e8e4d47174dea6cc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="uversion_8h.html#ac4613e9025739ee2e8e4d47174dea6cc">u_versionFromString</a> (<a class="el" href="uversion_8h.html#a61caef96ba86d8e86a4031925ea44e94">UVersionInfo</a> versionArray, const char *versionString)</td></tr>
<tr class="memdesc:ac4613e9025739ee2e8e4d47174dea6cc"><td class="mdescLeft"> </td><td class="mdescRight">Parse a string with dotted-decimal version information and fill in a UVersionInfo structure with the result. <a href="#ac4613e9025739ee2e8e4d47174dea6cc">More...</a><br /></td></tr>
<tr class="separator:ac4613e9025739ee2e8e4d47174dea6cc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1fc92f0d26dc92035320b0c5923dab0c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="uversion_8h.html#a1fc92f0d26dc92035320b0c5923dab0c">u_versionFromUString</a> (<a class="el" href="uversion_8h.html#a61caef96ba86d8e86a4031925ea44e94">UVersionInfo</a> versionArray, const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *versionString)</td></tr>
<tr class="memdesc:a1fc92f0d26dc92035320b0c5923dab0c"><td class="mdescLeft"> </td><td class="mdescRight">Parse a Unicode string with dotted-decimal version information and fill in a UVersionInfo structure with the result. <a href="#a1fc92f0d26dc92035320b0c5923dab0c">More...</a><br /></td></tr>
<tr class="separator:a1fc92f0d26dc92035320b0c5923dab0c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a38380427d3e56aeae74fab2602565ada"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="uversion_8h.html#a38380427d3e56aeae74fab2602565ada">u_versionToString</a> (const <a class="el" href="uversion_8h.html#a61caef96ba86d8e86a4031925ea44e94">UVersionInfo</a> versionArray, char *versionString)</td></tr>
<tr class="memdesc:a38380427d3e56aeae74fab2602565ada"><td class="mdescLeft"> </td><td class="mdescRight">Write a string with dotted-decimal version information according to the input UVersionInfo. <a href="#a38380427d3e56aeae74fab2602565ada">More...</a><br /></td></tr>
<tr class="separator:a38380427d3e56aeae74fab2602565ada"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5f63967e333bbf351610c72049d591cf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="uversion_8h.html#a5f63967e333bbf351610c72049d591cf">u_getVersion</a> (<a class="el" href="uversion_8h.html#a61caef96ba86d8e86a4031925ea44e94">UVersionInfo</a> versionArray)</td></tr>
<tr class="memdesc:a5f63967e333bbf351610c72049d591cf"><td class="mdescLeft"> </td><td class="mdescRight">Gets the ICU release version. <a href="#a5f63967e333bbf351610c72049d591cf">More...</a><br /></td></tr>
<tr class="separator:a5f63967e333bbf351610c72049d591cf"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>C API: API for accessing ICU version numbers. </p>
<p class="definition">Definition in file <a class="el" href="uversion_8h_source.html">uversion.h</a>.</p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a8855561449c5835245f330ce18b4f781"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8855561449c5835245f330ce18b4f781">◆ </a></span>U_COPYRIGHT_STRING_LENGTH</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define U_COPYRIGHT_STRING_LENGTH   128</td>
</tr>
</table>
</div><div class="memdoc">
<p>Maximum length of the copyright string. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003480">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
<p class="definition">Definition at line <a class="el" href="uversion_8h_source.html#l00038">38</a> of file <a class="el" href="uversion_8h_source.html">uversion.h</a>.</p>
</div>
</div>
<a id="acf6cc6b794656998aaaba2ab03f29baf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf6cc6b794656998aaaba2ab03f29baf">◆ </a></span>U_MAX_VERSION_LENGTH</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define U_MAX_VERSION_LENGTH   4</td>
</tr>
</table>
</div><div class="memdoc">
<p>An ICU version consists of up to 4 numbers from 0..255. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003481">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
<p class="definition">Definition at line <a class="el" href="uversion_8h_source.html#l00043">43</a> of file <a class="el" href="uversion_8h_source.html">uversion.h</a>.</p>
</div>
</div>
<a id="af204c175920d1e8b82b1042447194977"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af204c175920d1e8b82b1042447194977">◆ </a></span>U_MAX_VERSION_STRING_LENGTH</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define U_MAX_VERSION_STRING_LENGTH   20</td>
</tr>
</table>
</div><div class="memdoc">
<p>The maximum length of an ICU version string. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003483">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
<p class="definition">Definition at line <a class="el" href="uversion_8h_source.html#l00053">53</a> of file <a class="el" href="uversion_8h_source.html">uversion.h</a>.</p>
</div>
</div>
<a id="a7d52298e2afe0f592cf53023d20c31e5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7d52298e2afe0f592cf53023d20c31e5">◆ </a></span>U_VERSION_DELIMITER</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define U_VERSION_DELIMITER   '.'</td>
</tr>
</table>
</div><div class="memdoc">
<p>In a string, ICU version fields are delimited by dots. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003482">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
<p class="definition">Definition at line <a class="el" href="uversion_8h_source.html#l00048">48</a> of file <a class="el" href="uversion_8h_source.html">uversion.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="a61caef96ba86d8e86a4031925ea44e94"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a61caef96ba86d8e86a4031925ea44e94">◆ </a></span>UVersionInfo</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef uint8_t UVersionInfo[<a class="el" href="uversion_8h.html#acf6cc6b794656998aaaba2ab03f29baf">U_MAX_VERSION_LENGTH</a>]</td>
</tr>
</table>
</div><div class="memdoc">
<p>The binary form of a version on ICU APIs is an array of 4 uint8_t. </p>
<p>To compare two versions, use memcmp(v1,v2,sizeof(UVersionInfo)). </p><dl class="stable"><dt><b><a class="el" href="stable.html#_stable003484">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
<p class="definition">Definition at line <a class="el" href="uversion_8h_source.html#l00059">59</a> of file <a class="el" href="uversion_8h_source.html">uversion.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a5f63967e333bbf351610c72049d591cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5f63967e333bbf351610c72049d591cf">◆ </a></span>u_getVersion()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> void u_getVersion </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uversion_8h.html#a61caef96ba86d8e86a4031925ea44e94">UVersionInfo</a> </td>
<td class="paramname"><em>versionArray</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the ICU release version. </p>
<p>The version array stores the version information for ICU. For example, release "1.3.31.2" is then represented as 0x01031F02. Definition of this function lives in putil.c</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">versionArray</td><td>the version # information, the result will be filled in </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003488">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a id="ac4613e9025739ee2e8e4d47174dea6cc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac4613e9025739ee2e8e4d47174dea6cc">◆ </a></span>u_versionFromString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> void u_versionFromString </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uversion_8h.html#a61caef96ba86d8e86a4031925ea44e94">UVersionInfo</a> </td>
<td class="paramname"><em>versionArray</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>versionString</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Parse a string with dotted-decimal version information and fill in a UVersionInfo structure with the result. </p>
<p>Definition of this function lives in putil.c</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">versionArray</td><td>The destination structure for the version information. </td></tr>
<tr><td class="paramname">versionString</td><td>A string with dotted-decimal version information, with up to four non-negative number fields with values of up to 255 each. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003485">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</div>
</div>
<a id="a1fc92f0d26dc92035320b0c5923dab0c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1fc92f0d26dc92035320b0c5923dab0c">◆ </a></span>u_versionFromUString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> void u_versionFromUString </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uversion_8h.html#a61caef96ba86d8e86a4031925ea44e94">UVersionInfo</a> </td>
<td class="paramname"><em>versionArray</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"><em>versionString</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Parse a Unicode string with dotted-decimal version information and fill in a UVersionInfo structure with the result. </p>
<p>Definition of this function lives in putil.c</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">versionArray</td><td>The destination structure for the version information. </td></tr>
<tr><td class="paramname">versionString</td><td>A Unicode string with dotted-decimal version information, with up to four non-negative number fields with values of up to 255 each. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003486">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>
</div>
</div>
<a id="a38380427d3e56aeae74fab2602565ada"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a38380427d3e56aeae74fab2602565ada">◆ </a></span>u_versionToString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> void u_versionToString </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="uversion_8h.html#a61caef96ba86d8e86a4031925ea44e94">UVersionInfo</a> </td>
<td class="paramname"><em>versionArray</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>versionString</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Write a string with dotted-decimal version information according to the input UVersionInfo. </p>
<p>Definition of this function lives in putil.c</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">versionArray</td><td>The version information to be written as a string. </td></tr>
<tr><td class="paramname">versionString</td><td>A string buffer that will be filled in with a string corresponding to the numeric version information in versionArray. The buffer size must be at least U_MAX_VERSION_STRING_LENGTH. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003487">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>