/usr/share/doc/libudunits2-dev/udunits2lib.html is in libudunits2-dev 2.2.17-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 | <html lang="en">
<head>
<title>The UDUNITS-2 C API Guide</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="The UDUNITS-2 C API Guide">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="top" href="#Top">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
Copyright 2014 University Corporation for Atmospheric Research and contributors.
All rights reserved.
This software was developed by the Unidata Program Center of the
University Corporation for Atmospheric Research (UCAR)
<http://www.unidata.ucar.edu>.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
1) Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2) Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3) Neither the names of the development group, the copyright holders, nor the
names of contributors may be used to endorse or promote products derived
from this software without specific prior written permission.
4) This license shall terminate automatically and you may no longer exercise
any of the rights granted to you by this license as of the date you
commence an action, including a cross-claim or counterclaim, against
the copyright holders or any contributor alleging that this software
infringes a patent. This termination provision shall not apply for an
action alleging patent infringement by combinations of this software with
other software or hardware.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE CONTRIBUTORS
OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS WITH THE SOFTWARE.
-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<h1 class="settitle">The UDUNITS-2 C API Guide</h1>
<div class="contents">
<h2>Table of Contents</h2>
<ul>
<li><a name="toc_Top" href="#Top">UDUNITS-2</a>
<li><a name="toc_Synopsis" href="#Synopsis">1 Synopsis</a>
<li><a name="toc_Why" href="#Why">2 What's a Unit Package Good For?</a>
<li><a name="toc_Unit_002dSystems" href="#Unit_002dSystems">3 Unit-Systems</a>
<ul>
<li><a href="#Obtaining">3.1 Obtaining a Unit-System</a>
<li><a href="#Extracting">3.2 Extracting Units from a Unit-System</a>
<li><a href="#Adding">3.3 Adding Units to a Unit-System</a>
<li><a href="#Prefixes">3.4 Adding Unit-Prefixes to a Unit-System</a>
<li><a href="#Misc">3.5 Miscelaneous Operations on Unit-Systems</a>
</li></ul>
<li><a name="toc_Value-Conversion" href="#Value-Conversion">4 Converting Values Between Units</a>
<li><a name="toc_Parsing" href="#Parsing">5 Parsing a String into a Unit</a>
<li><a name="toc_Syntax" href="#Syntax">6 Unit Syntax</a>
<ul>
<li><a href="#Examples">6.1 Unit Specification Examples</a>
<li><a href="#Grammar">6.2 Unit Grammar</a>
</li></ul>
<li><a name="toc_Formatting" href="#Formatting">7 Formatting a Unit into a String</a>
<li><a name="toc_Operations" href="#Operations">8 Unit Operations</a>
<ul>
<li><a href="#Unary">8.1 Unary Unit Operations</a>
<li><a href="#Binary">8.2 Binary Unit Operations</a>
</li></ul>
<li><a name="toc_Mapping" href="#Mapping">9 Mapping Between Identifiers and Units</a>
<ul>
<li><a href="#Names">9.1 Names</a>
<li><a href="#Symbols">9.2 Symbols</a>
</li></ul>
<li><a name="toc_Time" href="#Time">10 The Handling of Time</a>
<li><a name="toc_Errors" href="#Errors">11 Error Handling</a>
<ul>
<li><a href="#Status">11.1 Status of Last Operation</a>
<li><a href="#Messages">11.2 Error-Messages</a>
</li></ul>
<li><a name="toc_Database" href="#Database">12 The Units Database</a>
<li><a name="toc_Types" href="#Types">13 Data Types</a>
<li><a name="toc_Complete-Index" href="#Complete-Index">Index</a>
</li></ul>
</div>
<div class="node">
<a name="Top"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Synopsis">Synopsis</a>,
Previous: <a rel="previous" accesskey="p" href="#dir">(dir)</a>,
Up: <a rel="up" accesskey="u" href="#dir">(dir)</a>
</div>
<h2 class="unnumbered">UDUNITS-2</h2>
<p>This manual describes how to use the C API of the UDUNITS-2 library.
Among other things, the library allows C code to obtain a binary
representation of a unit of a physical quantity, to
operate on such units, and to convert numeric values between compatible
units.
<p>The library comes with an extensive database of units all referenced to the
SI system of units.
<p>Copyright 2014 University Corporation for Atmospheric Research and contributors.
All rights reserved.
<p>This software was developed by the Unidata Program Center of the
University Corporation for Atmospheric Research (UCAR)
<http://www.unidata.ucar.edu>.
<p>Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
<p>1) Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2) Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3) Neither the names of the development group, the copyright holders, nor the
names of contributors may be used to endorse or promote products derived
from this software without specific prior written permission.
4) This license shall terminate automatically and you may no longer exercise
any of the rights granted to you by this license as of the date you
commence an action, including a cross-claim or counterclaim, against
the copyright holders or any contributor alleging that this software
infringes a patent. This termination provision shall not apply for an
action alleging patent infringement by combinations of this software with
other software or hardware.
<p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE CONTRIBUTORS
OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS WITH THE SOFTWARE.
<ul class="menu">
<li><a accesskey="1" href="#Synopsis">Synopsis</a>: Terse usage display
<li><a accesskey="2" href="#Why">Why</a>: What's a unit package good for?
<li><a accesskey="3" href="#Unit_002dSystems">Unit-Systems</a>: Explanation of unit-systems and how to get one
<li><a accesskey="4" href="#Parsing">Parsing</a>: Converting strings into units
<li><a accesskey="5" href="#Syntax">Syntax</a>: Syntax for string representation of units
<li><a accesskey="6" href="#Formatting">Formatting</a>: Converting units into strings
<li><a accesskey="7" href="#Value-Conversion">Value Conversion</a>: Converting values between units
<li><a accesskey="8" href="#Prefixes">Prefixes</a>: Defining unit prefixes
<li><a accesskey="9" href="#Mapping">Mapping</a>: Mapping between units and identifiers
<li><a href="#Operations">Operations</a>: Operations on units
<li><a href="#Time">Time</a>: Handling time
<li><a href="#Errors">Errors</a>: Error-handling
<li><a href="#Database">Database</a>: The units database
<li><a href="#Types">Types</a>: Data types
<li><a href="#Complete-Index">Complete Index</a>: Complete index
</ul>
<div class="node">
<a name="Synopsis"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Why">Why</a>,
Previous: <a rel="previous" accesskey="p" href="#Top">Top</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">1 Synopsis</h2>
<p><a name="index-synopsis-1"></a>
Coding:
<pre class="example"> #include <udunits2.h>
<blockquote>
<p><table summary=""><tr align="left"><td valign="top">const char* </td><td valign="top"><a href="#ut_005fget_005fpath_005fxml_0028_0029">ut_get_path_xml</a>(const char* <var>path</var>);
<br></td></tr><tr align="left"><td valign="top">ut_system* </td><td valign="top"><a href="#ut_005fread_005fxml_0028_0029">ut_read_xml</a>(const char* <var>path</var>);
<br></td></tr><tr align="left"><td valign="top">ut_system* </td><td valign="top"><a href="#ut_005fnew_005fsystem_0028_0029">ut_new_system</a>(void);
<br></td></tr><tr align="left"><td valign="top">void </td><td valign="top"><a href="#ut_005ffree_005fsystem_0028_0029">ut_free_system</a>(ut_system* <var>system</var>);
<br></td></tr><tr align="left"><td valign="top">ut_system* </td><td valign="top"><a href="#ut_005fget_005fsystem_0028_0029">ut_get_system</a>(const ut_unit* <var>unit</var>);
<br></td></tr><tr align="left"><td valign="top">ut_unit* </td><td valign="top"><a href="#ut_005fget_005fdimensionless_005funit_005fone_0028_0029">ut_get_dimensionless_unit_one</a>(const ut_system* <var>system</var>);
<br></td></tr><tr align="left"><td valign="top">ut_unit* </td><td valign="top"><a href="#ut_005fget_005funit_005fby_005fname_0028_0029">ut_get_unit_by_name</a>(const ut_system* <var>system</var>, const char* <var>name</var>);
<br></td></tr><tr align="left"><td valign="top">ut_unit* </td><td valign="top"><a href="#ut_005fget_005funit_005fby_005fsymbol_0028_0029">ut_get_unit_by_symbol</a>(const ut_system* <var>system</var>, const char* <var>symbol</var>);
<br></td></tr><tr align="left"><td valign="top">ut_status </td><td valign="top"><a href="#ut_005fset_005fsecond_0028_0029">ut_set_second</a>(const ut_unit* <var>second</var>);
<br></td></tr><tr align="left"><td valign="top">ut_status </td><td valign="top"><a href="#ut_005fadd_005fname_005fprefix_0028_0029">ut_add_name_prefix</a>(ut_system* <var>system</var>, const char* <var>name</var>, double <var>value</var>);
<br></td></tr><tr align="left"><td valign="top">ut_status </td><td valign="top"><a href="#ut_005fadd_005fsymbol_005fprefix_0028_0029">ut_add_symbol_prefix</a>(ut_system* <var>system</var>, const char* <var>symbol</var>, double <var>value</var>);
<br></td></tr><tr align="left"><td valign="top">ut_unit* </td><td valign="top"><a href="#ut_005fnew_005fbase_005funit_0028_0029">ut_new_base_unit</a>(ut_system* <var>system</var>);
<br></td></tr><tr align="left"><td valign="top">ut_unit* </td><td valign="top"><a href="#ut_005fnew_005fdimensionless_005funit_0028_0029">ut_new_dimensionless_unit</a>(ut_system* <var>system</var>);
<br></td></tr><tr align="left"><td valign="top">ut_unit* </td><td valign="top"><a href="#ut_005fclone_0028_0029">ut_clone</a>(const ut_unit* <var>unit</var>);
<br></td></tr><tr align="left"><td valign="top">void </td><td valign="top"><a href="#ut_005ffree_0028_0029">ut_free</a>(ut_unit* <var>unit</var>);
<br></td></tr><tr align="left"><td valign="top">const char* </td><td valign="top"><a href="#ut_005fget_005fname_0028_0029">ut_get_name</a>(const ut_unit* <var>unit</var>, ut_encoding <var>encoding</var>);
<br></td></tr><tr align="left"><td valign="top">ut_status </td><td valign="top"><a href="#ut_005fmap_005fname_005fto_005funit_0028_0029">ut_map_name_to_unit</a>(const char* <var>name</var>, const ut_encoding <var>encoding</var>, const ut_unit* <var>unit</var>);
<br></td></tr><tr align="left"><td valign="top">ut_status </td><td valign="top"><a href="#ut_005funmap_005fname_005fto_005funit_0028_0029">ut_unmap_name_to_unit</a>(ut_system* <var>system</var>, const char* <var>name</var>, const ut_encoding <var>encoding</var>);
<br></td></tr><tr align="left"><td valign="top">ut_status </td><td valign="top"><a href="#ut_005fmap_005funit_005fto_005fname_0028_0029">ut_map_unit_to_name</a>(const ut_unit* <var>unit</var>, const char* <var>name</var>, ut_encoding <var>encoding</var>);
<br></td></tr><tr align="left"><td valign="top">ut_status </td><td valign="top"><a href="#ut_005funmap_005funit_005fto_005fname_0028_0029">ut_unmap_unit_to_name</a>(const ut_unit* <var>unit</var>, ut_encoding <var>encoding</var>);
<br></td></tr><tr align="left"><td valign="top">const char* </td><td valign="top"><a href="#ut_005fget_005fsymbol_0028_0029">ut_get_symbol</a>(const ut_unit* <var>unit</var>, ut_encoding <var>encoding</var>);
<br></td></tr><tr align="left"><td valign="top">ut_status </td><td valign="top"><a href="#ut_005fmap_005fsymbol_005fto_005funit_0028_0029">ut_map_symbol_to_unit</a>(const char* <var>symbol</var>, const ut_encoding <var>encoding</var>, const ut_unit* <var>unit</var>);
<br></td></tr><tr align="left"><td valign="top">ut_status </td><td valign="top"><a href="#ut_005funmap_005fsymbol_005fto_005funit_0028_0029">ut_unmap_symbol_to_unit</a>(ut_system* <var>system</var>, const char* <var>symbol</var>, const ut_encoding <var>encoding</var>);
<br></td></tr><tr align="left"><td valign="top">ut_status </td><td valign="top"><a href="#ut_005fmap_005funit_005fto_005fsymbol_0028_0029">ut_map_unit_to_symbol</a>(const ut_unit* <var>unit</var>, const char* <var>symbol</var>, ut_encoding <var>encoding</var>);
<br></td></tr><tr align="left"><td valign="top">ut_status </td><td valign="top"><a href="#ut_005funmap_005funit_005fto_005fsymbol_0028_0029">ut_unmap_unit_to_symbol</a>(const ut_unit* <var>unit</var>, ut_encoding <var>encoding</var>);
<br></td></tr><tr align="left"><td valign="top">int </td><td valign="top"><a href="#ut_005fis_005fdimensionless_0028_0029">ut_is_dimensionless</a>(const ut_unit* <var>unit</var>);
<br></td></tr><tr align="left"><td valign="top">int </td><td valign="top"><a href="#ut_005fsame_005fsystem_0028_0029">ut_same_system</a>(const ut_unit* <var>unit1</var>, const ut_unit* <var>unit2</var>);
<br></td></tr><tr align="left"><td valign="top">int </td><td valign="top"><a href="#ut_005fcompare_0028_0029">ut_compare</a>(const ut_unit* <var>unit1</var>, const ut_unit* <var>unit2</var>);
<br></td></tr><tr align="left"><td valign="top">int </td><td valign="top"><a href="#ut_005fare_005fconvertible_0028_0029">ut_are_convertible</a>(const ut_unit* <var>unit1</var>, const ut_unit* <var>unit2</var>);
<br></td></tr><tr align="left"><td valign="top">cv_converter* </td><td valign="top"><a href="#ut_005fget_005fconverter_0028_0029">ut_get_converter</a>(ut_unit* <var>from</var>, ut_unit* <var>to</var>);
<br></td></tr><tr align="left"><td valign="top">ut_unit* </td><td valign="top"><a href="#ut_005fscale_0028_0029">ut_scale</a>(double <var>factor</var>, const ut_unit* <var>unit</var>);
<br></td></tr><tr align="left"><td valign="top">ut_unit* </td><td valign="top"><a href="#ut_005foffset_0028_0029">ut_offset</a>(const ut_unit* <var>unit</var>, double <var>offset</var>);
<br></td></tr><tr align="left"><td valign="top">ut_unit* </td><td valign="top"><a href="#ut_005foffset_005fby_005ftime_0028_0029">ut_offset_by_time</a>(const ut_unit* <var>unit</var>, double <var>origin</var>);
<br></td></tr><tr align="left"><td valign="top">ut_unit* </td><td valign="top"><a href="#ut_005fmultiply_0028_0029">ut_multiply</a>(const ut_unit* <var>unit1</var>, const ut_unit* <var>unit2</var>);
<br></td></tr><tr align="left"><td valign="top">ut_unit* </td><td valign="top"><a href="#ut_005finvert_0028_0029">ut_invert</a>(const ut_unit* <var>unit</var>);
<br></td></tr><tr align="left"><td valign="top">ut_unit* </td><td valign="top"><a href="#ut_005fdivide_0028_0029">ut_divide</a>(const ut_unit* <var>numer</var>, const ut_unit* <var>denom</var>);
<br></td></tr><tr align="left"><td valign="top">ut_unit* </td><td valign="top"><a href="#ut_005fraise_0028_0029">ut_raise</a>(const ut_unit* <var>unit</var>, int <var>power</var>);
<br></td></tr><tr align="left"><td valign="top">ut_unit* </td><td valign="top"><a href="#ut_005froot_0028_0029">ut_root</a>(const ut_unit* <var>unit</var>, int <var>root</var>);
<br></td></tr><tr align="left"><td valign="top">ut_unit* </td><td valign="top"><a href="#ut_005flog_0028_0029">ut_log</a>(double <var>base</var>, const ut_unit* <var>reference</var>);
<br></td></tr><tr align="left"><td valign="top">ut_unit* </td><td valign="top"><a href="#ut_005fparse_0028_0029">ut_parse</a>(const ut_system* <var>system</var>, const char* <var>string</var>, ut_encoding <var>encoding</var>);
<br></td></tr><tr align="left"><td valign="top">char* </td><td valign="top"><a href="#ut_005ftrim_0028_0029">ut_trim</a>(char* <var>string</var>, ut_encoding <var>encoding</var>);
<br></td></tr><tr align="left"><td valign="top">int </td><td valign="top"><a href="#ut_005fformat_0028_0029">ut_format</a>(const ut_unit* <var>unit</var>, char* <var>buf</var>, size_t <var>size</var>, unsigned <var>opts</var>);
<br></td></tr><tr align="left"><td valign="top">ut_status </td><td valign="top"><a href="#ut_005faccept_005fvisitor_0028_0029">ut_accept_visitor</a>(const ut_unit* <var>unit</var>, const ut_visitor* <var>visitor</var>, void* <var>arg</var>);
<br></td></tr><tr align="left"><td valign="top">double </td><td valign="top"><a href="#ut_005fencode_005fdate_0028_0029">ut_encode_date</a>(int <var>year</var>, int <var>month</var>, int <var>day</var>);
<br></td></tr><tr align="left"><td valign="top">double </td><td valign="top"><a href="#ut_005fencode_005fclock_0028_0029">ut_encode_clock</a>(int <var>hours</var>, int <var>minutes</var>, double <var>seconds</var>);
<br></td></tr><tr align="left"><td valign="top">double </td><td valign="top"><a href="#ut_005fencode_005ftime_0028_0029">ut_encode_time</a>(int <var>year</var>, int <var>month</var>, int <var>day</var>, int <var>hour</var>, int <var>minute</var>, double <var>second</var>);
<br></td></tr><tr align="left"><td valign="top">void </td><td valign="top"><a href="#ut_005fdecode_005ftime_0028_0029">ut_decode_time</a>(double <var>value</var>, int* <var>year</var>, int* <var>month</var>, int* <var>day</var>, int* <var>hour</var>, int* <var>minute</var>, double* <var>second</var>, double* <var>resolution</var>);
<br></td></tr><tr align="left"><td valign="top">ut_status </td><td valign="top"><a href="#ut_005fget_005fstatus_0028_0029">ut_get_status</a>(void);
<br></td></tr><tr align="left"><td valign="top">void </td><td valign="top"><a href="#ut_005fset_005fstatus_0028_0029">ut_set_status</a>(ut_status <var>status</var>);
<br></td></tr><tr align="left"><td valign="top">int </td><td valign="top"><a href="#ut_005fhandle_005ferror_005fmessage_0028_0029">ut_handle_error_message</a>(const char* <var>fmt</var>, ...);
<br></td></tr><tr align="left"><td valign="top">ut_error_message_handler </td><td valign="top"><a href="#ut_005fset_005ferror_005fmessage_005fhandler_0028_0029">ut_set_error_message_handler</a>(ut_error_message_handler <var>handler</var>);
<br></td></tr><tr align="left"><td valign="top">int </td><td valign="top"><a href="#ut_005fwrite_005fto_005fstderr_0028_0029">ut_write_to_stderr</a>(const char* <var>fmt</var>, va_list <var>args</var>);
<br></td></tr><tr align="left"><td valign="top">int </td><td valign="top"><a href="#ut_005fignore_0028_0029">ut_ignore</a>(const char* <var>fmt</var>, va_list <var>args</var>);
<br></td></tr><tr align="left"><td valign="top"><br></td></tr><tr align="left"><td valign="top">float </td><td valign="top"><a href="#cv_005fconvert_005ffloat_0028_0029">cv_convert_float</a>(const cv_converter* <var>converter</var>, float <var>value</var>);
<br></td></tr><tr align="left"><td valign="top">double </td><td valign="top"><a href="#cv_005fconvert_005fdouble_0028_0029">cv_convert_double</a>(const cv_converter* <var>converter</var>, double <var>value</var>);
<br></td></tr><tr align="left"><td valign="top">float* </td><td valign="top"><a href="#cv_005fconvert_005ffloats_0028_0029">cv_convert_floats</a>(const cv_converter* <var>converter</var>, const float* <var>in</var>, size_t <var>count</var>, float* <var>out</var>);
<br></td></tr><tr align="left"><td valign="top">double* </td><td valign="top"><a href="#cv_005fconvert_005fdoubles_0028_0029">cv_convert_doubles</a>(const cv_converter* <var>converter</var>, const double* <var>const</var> in, <var>size_t</var> count, <var>double</var>* out);
<br></td></tr><tr align="left"><td valign="top">void </td><td valign="top"><a href="#cv_005ffree_0028_0029">cv_free</a>(cv_converter* <var>conv</var>);
<br></td></tr></table>
</blockquote>
</pre>
<p>Compiling:
<pre class="example"> c89 -I <em>includedir</em> ...
</pre>
<p>Where <em>includedir</em> is the installation-directory for C header
files (e.g., <code>/usr/local/include</code>).
<p>Linking:
<pre class="example"> c89 ... -L<em>libdir</em> -ludunits2 -lexpat ... -lm
</pre>
<p>Where <em>libdir</em> is the installation-directory for object code
libraries (e.g., <code>/usr/local/lib</code>).
<div class="node">
<a name="Why"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Unit_002dSystems">Unit-Systems</a>,
Previous: <a rel="previous" accesskey="p" href="#Synopsis">Synopsis</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">2 What's a Unit Package Good For?</h2>
<p>The existance of a software package is justified by what you can do with it.
The three main things you can do with the UDUNIT-2 package are
<ol type=1 start=1>
<li><a href="#Value-Conversion">Convert numeric values between compatible units</a>.
<li>Convert a string representation of a unit into a binary one — enabling
the programatic manipulation of units.
There are three ways to do this:
<ul>
<li><a href="#Extracting">Get the unit</a> from a <a href="#unit_002dsystem">unit-system</a>.
This requires that
you know the unit's name or symbol and that the unit is in a unit-system.
<li><a href="#Parsing">Parse a string representation of the unit into its binary representation</a>.
This requires that the string be parsable by <code><a href="#ut_005fparse_0028_0029">ut_parse()</a></code>.
<li><a href="#Operations">Explicity construct the unit from subcomponent units using unit operations</a>.
</ul>
<li><a href="#Formatting">Convert a binary representation of a unit into a string</a> —
enabling the printing and storing of units in a human-readable form.
</ol>
While the above might seem to be trivial activities, their
general availability at the time might have helped prevent
the <a href="http://en.wikipedia.org/wiki/Mars_Climate_Orbiter">Mars Climate Orbiter</a> fiasco.
<p><a name="unit_002dsystem"></a><div class="node">
<a name="Unit-Systems"></a>
<a name="Unit_002dSystems"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Value-Conversion">Value Conversion</a>,
Previous: <a rel="previous" accesskey="p" href="#Why">Why</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">3 Unit-Systems</h2>
<p><a name="index-unit_002dsystem-2"></a><a name="index-system-of-units-3"></a>
A unit-system is a set of units that are all defined in terms of the same
set of
<a name="index-unit_002c-base-4"></a><a name="index-base-unit-5"></a>base units.
In the SI system of units, for example, the base units are the
meter, kilogram, second, ampere, kelvin, mole, and candela.
(For definitions of these base units, see
<a href="http://physics.nist.gov/cuu/Units/current.html">http://physics.nist.gov/cuu/Units/current.html</a>.)
<p>In the UDUNITS-2 package, every accessible unit belongs to one and only one
unit-system. It is not possible to convert numeric values between units
of different unit-systems. Similarly, units belonging to different
unit-systems always compare unequal.
<p>There are several categories of operations on unit-systems:
<ul class="menu">
<li><a accesskey="1" href="#Obtaining">Obtaining</a>: How to obtain a unit-system.
<li><a accesskey="2" href="#Extracting">Extracting</a>: Getting a unit from a unit-system.
<li><a accesskey="3" href="#Adding">Adding</a>: Adding new units to a unit-system.
<li><a accesskey="4" href="#Prefixes">Prefixes</a>: Add new unit-prefixes to a unit-system.
<li><a accesskey="5" href="#Misc">Misc</a>: Miscelaneous unit-system operations.
</ul>
<div class="node">
<a name="Obtaining"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Extracting">Extracting</a>,
Up: <a rel="up" accesskey="u" href="#Unit_002dSystems">Unit-Systems</a>
</div>
<h3 class="section">3.1 Obtaining a Unit-System</h3>
<p><a name="index-database_002c-unit_002c-obtaining-predefined-6"></a><a name="index-unit-database_002c-obtaining-predefined-7"></a><a name="index-unit_002dsystem_002c-obtaining-predefined-8"></a><a name="index-units_002c-obtaining-predefined-9"></a><a name="index-g_t_0040code_007but_005fread_005fxml_0028_0029_007d_002c-discussion-of-10"></a>Typically, you would obtain a unit-system of predefined units by reading
the default unit database using <code><a href="#ut_005fread_005fxml_0028_0029">ut_read_xml()</a></code>
with a <code>NULL</code> pathname argument.
If this doesn't quite match your needs, then there are alternatives.
Together with the typical solution, the means for obtaining a useful
unit-system are (in order of increasing complexity):
<ul>
<li>Obtain the default unit-system using <code><a href="#ut_005fread_005fxml_0028_0029">ut_read_xml</a>(NULL)</code>.
<li>Copy and customize the unit database and then
call <code><a href="#ut_005fread_005fxml_0028_0029">ut_read_xml()</a></code> with the pathname of the customized
database to obtain a customized unit-system.
<li>Same as either of the above but then adding new units to the unit-system using
<code><a href="#ut_005fnew_005fbase_005funit_0028_0029">ut_new_base_unit()</a></code> and
<code><a href="#ut_005fnew_005fdimensionless_005funit_0028_0029">ut_new_dimensionless_unit()</a></code>.
<li>Same as the above but also deriving new units using
<a href="#Operations">unit operations</a>
and then adding them to the unit-system using
<a href="#Mapping">unit mapping</a>.
<li>Same as the above but starting with an empty unit-system obtained from
<code><a href="#ut_005fnew_005fsystem_0028_0029">ut_new_system()</a></code>,
in which case you will definitely have to start with
<code><a href="#ut_005fnew_005fbase_005funit_0028_0029">ut_new_base_unit()</a></code> and
<code><a href="#ut_005fnew_005fdimensionless_005funit_0028_0029">ut_new_dimensionless_unit()</a></code>.
</ul>
<p>You should pass every unit-system pointer to <code><a href="#ut_005ffree_005fsystem_0028_0029">ut_free_system()</a></code>
when you no longer need the corresponding unit-system.
<p><a name="ut_005fget_005fpath_005fxml_0028_0029"></a>
<div class="defun">
— Function: <code>const char*</code> <b>ut_get_path_xml</b> <code>(const char* </code><var>path</var><code>, ut_status* status)</code><var><a name="index-ut_005fget_005fpath_005fxml-11"></a></var><br>
<blockquote><p>Returns the pathname of the XML-formatted unit-database corresponding to
<var>path</var>. If <var>path</var> is non-<code>NULL</code>, then it is returned; otherwise,
if the environment variable <code>UDUNITS2_XML_PATH</code> is set, then its value is
returned; otherwise, the pathname of the default unit-database is returned.
The value of <code>*status</code> indicates which of these possibilities occurred:
<dl>
<dt><code>UT_OPEN_ARG</code><dd><var>path</var> is non-<code>NULL</code> and was returned.
<br><dt><code>UT_OPEN_ENV</code><dd><var>path</var> is <code>NULL</code>, the environment variable
<code>UDUNITS2_XML_PATH</code> is set, and its value was returned.
<br><dt><code>UT_OPEN_DEFAULT</code><dd><var>path</var> is <code>NULL</code>, the environment variable
<code>UDUNITS2_XML_PATH</code> is unset, and the pathname of the default unit-database
was returned.
</dl>
</p></blockquote></div>
<p><a name="ut_005fread_005fxml_0028_0029"></a>
<div class="defun">
— Function: <code>ut_system*</code> <b>ut_read_xml</b> <code>(const char* </code><var>path</var><code>)</code><var><a name="index-ut_005fread_005fxml-12"></a></var><br>
<blockquote><p>Reads the XML-formatted unit-database specified by <var>path</var>
and returns the corresponding unit-sytem.
If <var>path</var> is <code>NULL</code>, then the pathname specified by the
environment variable <code>UDUNITS2_XML_PATH</code> is used if set; otherwise,
the compile-time pathname of the installed, default, unit database is
used.
You should pass the returned pointer to <code>ut_free_system()</code> when you
no longer need the unit-system.
If an error occurs,
then this function writes an error-message using
<code><a href="#ut_005fhandle_005ferror_005fmessage_0028_0029">ut_handle_error_message()</a></code>
and returns <code>NULL</code>.
Also, <code><a href="#ut_005fget_005fstatus_0028_0029">ut_get_status()</a></code> will return one of the following:
<dl>
<dt><code>UT_OPEN_ARG</code><dd><var>path</var> is non-<code>NULL</code> but the file couldn't be opened.
See <code>errno</code> for the reason.
<br><dt><code>UT_OPEN_ENV</code><dd><var>path</var> is <code>NULL</code> and environment variable
<code>UDUNITS2_XML_PATH</code> is set but the file couldn't be opened.
See <code>errno</code> for the reason.
<br><dt><code>UT_OPEN_DEFAULT</code><dd><var>path</var> is <code>NULL</code>, environment variable
<code>UDUNITS2_XML_PATH</code> is unset, and the installed, default, unit
database couldn't be opened.
See <code>errno</code> for the reason.
<br><dt><code>UT_OS</code><dd>Operating-system error. See <code>errno</code>.
<br><dt><code>UT_PARSE</code><dd>The database file couldn't be parsed.
</dl>
</p></blockquote></div>
<p><a name="ut_005fnew_005fsystem_0028_0029"></a>
<div class="defun">
— Function: <code>ut_system*</code> <b>ut_new_system</b> <code>(void)</code><var><a name="index-ut_005fnew_005fsystem-13"></a></var><br>
<blockquote><p>Creates and returns a new unit-system.
On success, the unit-system will be empty
except for the dimensionless unit one.
You should pass the returned pointer to <code>ut_free_system()</code> when you
no longer need the unit-system.
If an error occurs,
then this function writes an error-message using
<code><a href="#ut_005fhandle_005ferror_005fmessage_0028_0029">ut_handle_error_message()</a></code>
and returns <code>NULL</code>.
Also, <code><a href="#ut_005fget_005fstatus_0028_0029">ut_get_status()</a></code> will return the following:
<dl>
<dt><code>UT_OS</code><dd>Operating-system error. See <code>errno</code>.
</dl>
</p></blockquote></div>
<div class="node">
<a name="Extracting"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Adding">Adding</a>,
Previous: <a rel="previous" accesskey="p" href="#Obtaining">Obtaining</a>,
Up: <a rel="up" accesskey="u" href="#Unit_002dSystems">Unit-Systems</a>
</div>
<h3 class="section">3.2 Extracting Units from a Unit-System</h3>
<p><strong>NOTE\:</strong> This section covers low-level access to the indidual units of a
<a href="#unit_002dsystem">unit-system</a>.
General parsing of arbitrary unit specifications is coverted in
the section <a href="#Parsing">Parsing</a>.
<p>A <a href="#unit_002dsystem">unit-system</a> contains mappings from identifiers to units (and
vice versa).
Consequently, once you have a unit-system, you can easily
obtain a unit for which you know the name or symbol using
the function <code><a href="#ut_005fget_005funit_005fby_005fname_0028_0029">ut_get_unit_by_name()</a></code> or
<code><a href="#ut_005fget_005funit_005fby_005fsymbol_0028_0029">ut_get_unit_by_symbol()</a></code>.
<p><a name="index-getting-a-unit-by-its-name-14"></a><a name="index-unit_002c-getting-by-name-15"></a><a name="ut_005fget_005funit_005fby_005fname_0028_0029"></a>
<div class="defun">
— Function: <code>ut_unit*</code> <b>ut_get_unit_by_name</b> <code>(const ut_system* </code><var>system</var><code>, const char* </code><var>name</var><code>)</code><var><a name="index-ut_005fget_005funit_005fby_005fname-16"></a></var><br>
<blockquote><p>Returns the unit to which <var>name</var> maps from the unit-system referenced by
<var>system</var> or <code>NULL</code> if no such unit exists.
Name comparisons are case-insensitive.
If this function returns <code>NULL</code>, then
<code><a href="#ut_005fget_005fstatus_0028_0029">ut_get_status()</a></code> will return
one of the following:
<dl>
<dt><code>UT_SUCCESS</code><dd><var>name</var> doesn't map to a unit of <var>system</var>.
<br><dt><code>UT_BAD_ARG</code><dd><var>system</var> or <var>name</var> is <code>NULL</code>.
</dl>
<p>You should pass the returned unit to <code>ut_free()</code> when it is no longer
needed.
</p></blockquote></div>
<p><a name="index-getting-a-unit-by-its-symbol-17"></a><a name="index-unit_002c-getting-by-symbol-18"></a><a name="ut_005fget_005funit_005fby_005fsymbol_0028_0029"></a>
<div class="defun">
— Function: <code>ut_unit*</code> <b>ut_get_unit_by_symbol</b> <code>(const ut_system* </code><var>system</var><code>, const char* </code><var>symbol</var><code>)</code><var><a name="index-ut_005fget_005funit_005fby_005fsymbol-19"></a></var><br>
<blockquote><p>Returns the unit to which <var>symbol</var> maps from the unit-system referenced by
<var>system</var> or <code>NULL</code> if no such unit exists.
Symbol comparisons are case-sensitive.
If this function returns <code>NULL</code>, then
<code><a href="#ut_005fget_005fstatus_0028_0029">ut_get_status()</a></code> will return
one of the following:
<dl>
<dt><code>UT_SUCCESS</code><dd><var>symbol</var> doesn't map to a unit of <var>system</var>.
<br><dt><code>UT_BAD_ARG</code><dd><var>system</var> or <var>symbol</var> is <code>NULL</code>.
</dl>
<p>You should pass the returned unit to <code>ut_free()</code> when it is no longer
needed.
</p></blockquote></div>
<p><a name="ut_005fget_005fdimensionless_005funit_005fone_0028_0029"></a>
<div class="defun">
— Function: <code>ut_unit*</code> <b>ut_get_dimensionless_unit_one</b> <code>(const ut_system* </code><var>system</var><code>)</code><var><a name="index-ut_005fget_005fdimensionless_005funit_005fone-20"></a></var><br>
<blockquote><p>Returns the dimensionless unit one of the unit-system referenced by
<var>system</var>.
While not necessary, the returned pointer may be passed to <code>ut_free()</code>
when you no longer need the unit.
If <var>system</var> is <code>NULL</code>, then this function writes an error-message
using <code><a href="#ut_005fhandle_005ferror_005fmessage_0028_0029">ut_handle_error_message()</a></code>
and returns <code>NULL</code>.
Also, <code><a href="#ut_005fget_005fstatus_0028_0029">ut_get_status()</a></code> will return <code>UT_BAD_ARG</code>.
</p></blockquote></div>
<div class="node">
<a name="Adding"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Prefixes">Prefixes</a>,
Previous: <a rel="previous" accesskey="p" href="#Extracting">Extracting</a>,
Up: <a rel="up" accesskey="u" href="#Unit_002dSystems">Unit-Systems</a>
</div>
<h3 class="section">3.3 Adding Units to a Unit-System</h3>
<p><a name="index-adding-units-to-a-unit_002dsystem-21"></a><a name="index-unit_002c-adding-to-a-unit_002dsystem-22"></a><a name="index-unit_002dsystem_002c-adding-a-unit-to-23"></a>
If you use <code><a href="#ut_005fread_005fxml_0028_0029">ut_read_xml()</a></code>, then you should not normally need to
add any new units to a unit-system.
<p>Because you get units via their names or symbols, adding a unit to a
unit-system actually means mapping one or more identifiers (i.e., names
or symbols) to the unit.
Thereafter, you can use <code><a href="#ut_005fget_005funit_005fby_005fname_0028_0029">ut_get_unit_by_name()</a></code> and
<code><a href="#ut_005fget_005funit_005fby_005fsymbol_0028_0029">ut_get_unit_by_symbol()</a></code> to retrieve the unit.
The mapping of identifiers to units is covered <a href="#Mapping">here</a>.
<p>Having said that, it is possible to create a new base or dimensionless
unit within a unit-system using <code><a href="#ut_005fnew_005fbase_005funit_0028_0029">ut_new_base_unit()</a></code> or
<code><a href="#ut_005fnew_005fdimensionless_005funit_0028_0029">ut_new_dimensionless_unit()</a></code>—you'll just also have to map
identifiers to the newly-created unit in order to be able to retrieve
it later by identifier.
<p><a name="ut_005fnew_005fbase_005funit_0028_0029"></a>
<div class="defun">
— Function: <code>ut_unit*</code> <b>ut_new_base_unit</b> <code>(ut_system* </code><var>system</var><code>)</code><var><a name="index-ut_005fnew_005fbase_005funit-24"></a></var><br>
<blockquote><p>Creates and adds a new base-unit to the unit-system referenced by <var>system</var>.
This function returns the new base-unit.
You should pass the returned pointer to <code>ut_free()</code> when you
no longer need the unit.
If an error occurs,
then this function writes an error-message using
<code><a href="#ut_005fhandle_005ferror_005fmessage_0028_0029">ut_handle_error_message()</a></code>
and returns <code>NULL</code>.
Also, <code><a href="#ut_005fget_005fstatus_0028_0029">ut_get_status()</a></code> will return one of the following:
<dl>
<dt><code>UT_BAD_ARG</code><dd><var>system</var> is <code>NULL</code>.
<br><dt><code>UT_OS</code><dd>Operating-system failure. See <code>errno</code>.
</dl>
If you use <code><a href="#ut_005fread_005fxml_0028_0029">ut_read_xml()</a></code>, then you should not normally need to call this
function.
</p></blockquote></div>
<p><a name="ut_005fnew_005fdimensionless_005funit_0028_0029"></a>
<div class="defun">
— Function: <code>ut_unit*</code> <b>ut_new_dimensionless_unit</b> <code>(ut_system* </code><var>system</var><code>)</code><var><a name="index-ut_005fnew_005fdimensionless_005funit-25"></a></var><br>
<blockquote><p>Creates and adds a new dimensionless-unit to the unit-system referenced by <var>system</var>.
This function returns the new dimensionless-unit.
You should pass the returned pointer to <code>ut_free()</code> when you
no longer need the unit.
If an error occurs,
then this function writes an error-message using
<code><a href="#ut_005fhandle_005ferror_005fmessage_0028_0029">ut_handle_error_message()</a></code>
and returns <code>NULL</code>.
Also, <code><a href="#ut_005fget_005fstatus_0028_0029">ut_get_status()</a></code> will return one of the following:
<dl>
<dt><code>UT_BAD_ARG</code><dd><var>system</var> is <code>NULL</code>.
<br><dt><code>UT_OS</code><dd>Operating-system failure. See <code>errno</code>.
</dl>
If you use <code><a href="#ut_005fread_005fxml_0028_0029">ut_read_xml()</a></code>, then you should not normally need to call this
function.
</p></blockquote></div>
<div class="node">
<a name="Prefixes"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Misc">Misc</a>,
Previous: <a rel="previous" accesskey="p" href="#Adding">Adding</a>,
Up: <a rel="up" accesskey="u" href="#Unit_002dSystems">Unit-Systems</a>
</div>
<h3 class="section">3.4 Adding Unit-Prefixes to a Unit-System</h3>
<p><a name="index-prefixes_002c-adding-to-a-unit_002dsystem-26"></a><a name="index-adding-prefixes-to-a-unit_002dsystem-27"></a><a name="index-unit_002dsystem_002c-adding-prefixes-to-a-28"></a>
A prefix is a word or symbol that is appended to the beginning of a word or
symbol that represents a unit in order to modify the value of that unit. For
example, the prefix “kilo” in the word “kiloamperes” changes the value
from one ampere to one-thousand amperes.
<p>If you use <code><a href="#ut_005fread_005fxml_0028_0029">ut_read_xml()</a></code>, then you should not normally need to
add any new prefixes to a unit-system.
<p><a name="ut_005fadd_005fname_005fprefix_0028_0029"></a>
<div class="defun">
— Function: <code><a href="#ut_005fstatus">ut_status</a></code> <b>ut_add_name_prefix</b> <code>(ut_system* </code><var>system</var><code>, const char* </code><var>name</var><code>, double </code><var>value</var><code>)</code><var><a name="index-ut_005fadd_005fname_005fprefix-29"></a></var><br>
<blockquote><p>Adds the name-prefix <var>name</var> with the value <var>value</var>
to the unit-system <var>system</var>.
A name-prefix is something like “mega” or “milli”.
Comparisons between name-prefixes are case-insensitive.
This function returns one of the following:
<dl>
<dt><code>UT_SUCCESS</code><dd>Success.
<br><dt><code>UT_BAD_ARG</code><dd><var>system</var> or <var>name</var> is <code>NULL</code>, or <var>value</var> is <code>0</code>.
<br><dt><code>UT_EXISTS</code><dd><var>name</var> already maps to a different value.
<br><dt><code>UT_OS</code><dd>Operating-system failure. See <code>errno</code>.
</dl>
</p></blockquote></div>
<p><a name="ut_005fadd_005fsymbol_005fprefix_0028_0029"></a>
<div class="defun">
— Function: <code><a href="#ut_005fstatus">ut_status</a></code> <b>ut_add_symbol_prefix</b> <code>(ut_system* </code><var>system</var><code>, const char* </code><var>symbol</var><code>, double </code><var>value</var><code>)</code><var><a name="index-ut_005fadd_005fsymbol_005fprefix-30"></a></var><br>
<blockquote><p>Adds the symbol-prefix <var>symbol</var> with the value <var>value</var>
to the unit-system <var>system</var>.
A symbol-prefix is something like “M” or “m”.
Comparisons between symbol-prefixes are case-sensitive.
This function returns one of the following:
<dl>
<dt><code>UT_SUCCESS</code><dd>Success.
<br><dt><code>UT_BAD_ARG</code><dd><var>system</var> or <var>symbol</var> is <code>NULL</code>, or <var>value</var> is <code>0</code>.
<br><dt><code>UT_EXISTS</code><dd><var>symbol</var> already maps to a different value.
<br><dt><code>UT_OS</code><dd>Operating-system failure. See <code>errno</code>.
</dl>
</p></blockquote></div>
<div class="node">
<a name="Misc"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Prefixes">Prefixes</a>,
Up: <a rel="up" accesskey="u" href="#Unit_002dSystems">Unit-Systems</a>
</div>
<h3 class="section">3.5 Miscelaneous Operations on Unit-Systems</h3>
<p><a name="ut_005ffree_005fsystem_0028_0029"></a>
<div class="defun">
— Function: <code>void</code> <b>ut_free_system</b> <code>(ut_system* </code><var>system</var><code>)</code><var><a name="index-ut_005ffree_005fsystem-31"></a></var><br>
<blockquote><p>Frees the unit-system referenced by <var>system</var>. All unit-to-identifier and
identifier-to-unit mappings are removed. Use of <code>system</code> after this
function returns results in undefined behavior.
</p></blockquote></div>
<p><a name="ut_005fset_005fsecond_0028_0029"></a>
<div class="defun">
— Function: <code><a href="#ut_005fstatus">ut_status</a></code> <b>ut_set_second</b> <code>(const ut_unit* </code><var>second</var><code>)</code><var><a name="index-ut_005fset_005fsecond-32"></a></var><br>
<blockquote><p>Sets the “second” unit of a unit-system. This function must be called before
the first call to <code>ut_offset_by_time()</code> for a unit in the same unit-system.
<code><a href="#ut_005fread_005fxml_0028_0029">ut_read_xml()</a></code> calls this function if the
unit-system it's reading contains a unit named “second”.
This function returns one of the following:
<dl>
<dt><code>UT_SUCCESS</code><dd>The “second” unit of <var>system</var> was successfully set.
<br><dt><code>UT_EXISTS</code><dd>The “second” unit of <var>system</var> is set to a different unit.
<br><dt><code>UT_BAD_ARG</code><dd><var>second</var> is <code>NULL</code>.
</dl>
</p></blockquote></div>
<div class="node">
<a name="Value-Conversion"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Parsing">Parsing</a>,
Previous: <a rel="previous" accesskey="p" href="#Unit_002dSystems">Unit-Systems</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">4 Converting Values Between Units</h2>
<p><a name="index-converting-values-between-units-33"></a><a name="index-unit-conversion-34"></a>
You can convert numeric values in one unit to equivalent values in
another, compatible unit by means of a converter.
For example
<pre class="example"> #include <udunits2.h>
...
ut_unit* from = ...;
ut_unit* to = ...;
cv_converter* converter = ut_get_converter(from, to);
double fromValue = ...;
double toValue = cv_convert_double(converter, fromValue);
cv_free(converter);
</pre>
<p>The converter API is declared in the header-file <code><converter.h></code>,
which is automatically included by the UDUNITS-2 header-file
(<code><udunits2.h></code>) so you don't need to explicitly include it.
<p><a name="ut_005fare_005fconvertible_0028_0029"></a>
<div class="defun">
— Function: <code>int</code> <b>ut_are_convertible</b> <code>(const ut_unit* </code><var>unit1</var><code>, uconst t_unit* </code><var>unit2</var><code>)</code><var><a name="index-ut_005fare_005fconvertible-35"></a></var><br>
<blockquote><p>Indicates if numeric values in unit <var>unit1</var> are convertible to numeric
values in unit <var>unit2</var> via <a href="#ut_005fget_005fconverter_0028_0029">ut_get_converter()</a>.
In making this determination, dimensionless units are ignored.
This function returns a non-zero value if conversion is possible;
otherwise, <code>0</code> is returned and <a href="#ut_005fget_005fstatus_0028_0029">ut_get_status()</a> will return one
of the following:
<dl>
<dt><code>UT_BAD_ARG</code><dd><var>unit1</var> or <var>unit2</var> is <code>NULL</code>.
<br><dt><code>UT_NOT_SAME_SYSTEM</code><dd><var>unit1</var> and <var>unit2</var> belong to different <a href="#unit_002dsystem">unit-system</a>s.
<br><dt><code>UT_SUCCESS</code><dd>Conversion between the units is not possible (e.g., <var>unit1</var> refers
to a meter and <var>unit2</var> refers to a kilogram.
</dl>
</p></blockquote></div>
<p><a name="ut_005fget_005fconverter_0028_0029"></a>
<div class="defun">
— Function: <code>cv_converter*</code> <b>ut_get_converter</b> <code>(ut_unit* const </code><var>from</var><code>, ut_unit* const </code><var>to</var><code>)</code><var><a name="index-ut_005fget_005fconverter-36"></a></var><br>
<blockquote><p>Creates and returns a converter of numeric values in the <var>from</var> unit
to equivalent values in the <var>to</var> unit.
You should pass the returned pointer to <code>cv_free()</code> when you
no longer need the converter.
If an error occurs,
then this function writes an error-message using
<code><a href="#ut_005fhandle_005ferror_005fmessage_0028_0029">ut_handle_error_message()</a></code>
and returns <code>NULL</code>.
Also, <code><a href="#ut_005fget_005fstatus_0028_0029">ut_get_status()</a></code> will return one of the following:
<dl>
<dt><code>UT_BAD_ARG</code><dd><var>from</var> or <var>to</var> is <code>NULL</code>.
<br><dt><code>UT_NOT_SAME_SYSTEM</code><dd>The units <var>from</var> and <var>to</var> don't belong to the same unit-system.
<br><dt><code>UT_MEANINGLESS</code><dd>The units belong to the same unit-system but conversion between them is
meaningless (e.g., conversion between seconds and kilograms is meaningless).
<br><dt><code>UT_OS</code><dd>Operating-system failure. See <code>errno</code>.
</dl>
</p></blockquote></div>
<p><a name="cv_005fconvert_005ffloat_0028_0029"></a>
<div class="defun">
— Function: <code>float</code> <b>cv_convert_float</b> <code>(const cv_converter* </code><var>converter</var><code>, const float </code><var>value</var><code>)</code><var><a name="index-cv_005fconvert_005ffloat-37"></a></var><br>
<blockquote><p>Converts the single floating-point value <var>value</var> and
returns the new value.
</p></blockquote></div>
<p><a name="cv_005fconvert_005fdouble_0028_0029"></a>
<div class="defun">
— Function: <code>double</code> <b>cv_convert_double</b> <code>(const cv_converter* </code><var>converter</var><code>, const double </code><var>value</var><code>)</code><var><a name="index-cv_005fconvert_005fdouble-38"></a></var><br>
<blockquote><p>Converts the single double-precision value <var>value</var> and
returns the new value.
</p></blockquote></div>
<p><a name="cv_005fconvert_005ffloats_0028_0029"></a>
<div class="defun">
— Function: <code>float*</code> <b>cv_convert_floats</b> <code>(const cv_converter* </code><var>converter</var><code>, const float* </code><var>in</var><code>, size_t </code><var>count</var><code>, float* </code><var>out</var><code>)</code><var><a name="index-cv_005fconvert_005ffloats-39"></a></var><br>
<blockquote><p>Converts the <var>count</var> floating-point values starting at <var>in</var>, writing
the new values starting at <var>out</var> and, as a convenience,
returns <var>out</var>.
The input and output arrays may overlap or be identical.
</p></blockquote></div>
<p><a name="cv_005fconvert_005fdoubles_0028_0029"></a>
<div class="defun">
— Function: <code>double*</code> <b>cv_convert_doubles</b> <code>(const cv_converter* </code><var>converter</var><code>, const double* </code><var>in</var><code>, size_t </code><var>count</var><code>, double* </code><var>out</var><code>)</code><var><a name="index-cv_005fconvert_005fdoubles-40"></a></var><br>
<blockquote><p>Converts the <var>count</var> double-precision values starting at <var>in</var>, writing
the new values starting at <var>out</var> and, as a convenience,
returns <var>out</var>.
The input and output arrays may overlap or be identical.
</p></blockquote></div>
<p><a name="cv_005ffree_0028_0029"></a>
<div class="defun">
— Function: <code>void</code> <b>cv_free</b> <code>(cv_converter* </code><var>conv</var><code>)</code><var>;<a name="index-cv_005ffree-41"></a></var><br>
<blockquote><p>Frees resources associated with the converter referenced by <var>conv</var>.
You should call this function when you no longer need the converter.
Use of <var>conv</var> upon return results in undefined behavior.
</p></blockquote></div>
<div class="node">
<a name="Parsing"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Syntax">Syntax</a>,
Previous: <a rel="previous" accesskey="p" href="#Value-Conversion">Value Conversion</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">5 Parsing a String into a Unit</h2>
<p><a name="index-parsing-a-string-into-a-unit-42"></a><a name="index-string_002c-parsing-into-a-unit-43"></a>
Here's an example of parsing a string representation of a unit into
its binary representation:
<pre class="example"> #include <stdlib.h>
#include <udunits2.h>
...
ut_system* unitSystem = <a href="#ut_005fread_005fxml_0028_0029">ut_read_xml(NULL)</a>;
const char* string = "kg.m2/s3";
ut_unit* watt = <a href="#ut_005fparse_0028_0029">ut_parse</a>(unitSystem, string, UT_ASCII);
if (watt == NULL) {
/* Unable to parse string. */
}
else {
/* Life is good. */
}
</pre>
<p><a name="ut_005fparse_0028_0029"></a>
<div class="defun">
— Function: <code>ut_unit*</code> <b>ut_parse</b> <code>(const ut_system* </code><var>system</var><code>, const char* </code><var>string</var><code>, ut_encoding </code><var>encoding</var><code>)</code><var><a name="index-ut_005fparse-44"></a></var><br>
<blockquote><p>Returns the binary unit representation corresponding to the string unit
representation <var>string</var> in the character-set <var>encoding</var> using the
unit-system <var>system</var>.
<var>string</var> must have no leading or trailing whitespace (see
<code><a href="#ut_005ftrim_0028_0029">ut_trim()</a></code>).
If an error occurs, then this function returns <code>NULL</code> and
<code><a href="#ut_005fget_005fstatus_0028_0029">ut_get_status()</a></code> will return one of the following:
<dl>
<dt><code>UT_BAD_ARG</code><dd><var>system</var> or <var>string</var> is <code>NULL</code>.
<br><dt><code>UT_SYNTAX</code><dd><var>string</var> contained a syntax error.
<br><dt><code>UT_UNKNOWN</code><dd><var>string</var> contained an unknown identifier.
<br><dt><code>UT_OS</code><dd>Operating-system failure. See <code>errno</code> for the reason.
</dl>
<p>You should pass the returned unit to <code>ut_free()</code> when it is no longer
needed.
</p></blockquote></div>
<p><a name="ut_005ftrim_0028_0029"></a>
<div class="defun">
— Function: <code>size_t</code> <b>ut_trim</b> <code>(char* </code><var>string</var><code>, ut_encoding </code><var>encoding</var><code>)</code><var><a name="index-ut_005ftrim-45"></a></var><br>
<blockquote><p>Removes all leading and trailing whitespace from the NUL-terminated string
<var>string</var>. Returns <var>string</var>, which is modified if it contained leading
or trailing whitespace.
</p></blockquote></div>
<div class="node">
<a name="Syntax"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Formatting">Formatting</a>,
Previous: <a rel="previous" accesskey="p" href="#Parsing">Parsing</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">6 Unit Syntax</h2>
<p><a name="index-unit-syntax-46"></a><a name="index-syntax_002c-unit-47"></a>
For the most part, the UDUNITS-2 package follows the syntax for unit-strings
promulgated by the US National Institute for Standards and Technology (NIST).
Details, of which, can be found at <a href="http://physics.nist.gov/cuu/Units/index.html">http://physics.nist.gov/cuu/Units/index.html</a>.
The one general exception to this is the invention of a syntax for
“offset”-units (e.g., the definition of the degree Celsius is “K @
273.15”).
<ul class="menu">
<li><a accesskey="1" href="#Examples">Examples</a>: Examples of unit specifications
<li><a accesskey="2" href="#Grammar">Grammar</a>: Formal unit grammar
</ul>
<div class="node">
<a name="Examples"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Grammar">Grammar</a>,
Up: <a rel="up" accesskey="u" href="#Syntax">Syntax</a>
</div>
<h3 class="section">6.1 Unit Specification Examples</h3>
<p><a name="index-unit-specification-examples-48"></a><a name="index-examples_002c-unit-specification-49"></a>
<blockquote>
<p><table summary=""><tr align="left"><th valign="top">String Type </th><th valign="top">Using Names </th><th valign="top">Using Symbols </th><th valign="top">Comment
<br></th></tr><tr align="left"><td valign="top">Simple </td><td valign="top">meter </td><td valign="top">m
<br></td></tr><tr align="left"><td valign="top">Raised </td><td valign="top">meter^2 </td><td valign="top">m2 </td><td valign="top">higher precedence than multiplying or
dividing
<br></td></tr><tr align="left"><td valign="top">Product </td><td valign="top">newton meter </td><td valign="top">N.m
<br></td></tr><tr align="left"><td valign="top">Quotient </td><td valign="top">meter per second </td><td valign="top">m/s
<br></td></tr><tr align="left"><td valign="top">Scaled </td><td valign="top">60 second </td><td valign="top">60 s
<br></td></tr><tr align="left"><td valign="top">Prefixed </td><td valign="top">kilometer </td><td valign="top">km
<br></td></tr><tr align="left"><td valign="top">Offset </td><td valign="top">kelvin from 273.15 </td><td valign="top">K @ 273.15 </td><td valign="top">lower
precedence than multiplying or dividing
<br></td></tr><tr align="left"><td valign="top">Logarithmic </td><td valign="top">lg(re milliwatt) </td><td valign="top">lg(re mW) </td><td valign="top">"lg" is base 10,
"ln" is base e, and "lb" is base 2
<br></td></tr><tr align="left"><td valign="top">Grouped </td><td valign="top">(5 meter)/(30 second) </td><td valign="top">(5 m)/(30 s)
<br></td></tr></table>
</blockquote>
<p>The above may be combined, e.g., "0.1 lg(re m/(5 s)^2) @ 50".
<p>You may also look at the <code><def></code> elements in <a href="#Database">the units database</a> to see examples of string unit specifications.
<p>You may use the <code><a href="udunits2prog.html#Top">udunits2</a></code> utility
to experiment with string unit specifications.
<div class="node">
<a name="Grammar"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Examples">Examples</a>,
Up: <a rel="up" accesskey="u" href="#Syntax">Syntax</a>
</div>
<h3 class="section">6.2 Unit Grammar</h3>
<p><a name="index-unit-grammar-50"></a><a name="index-grammar_002c-unit-51"></a>
Here is the unit-syntax understood by the UDUNITS-2 package. Words printed
<em>Thusly</em> indicate non-terminals; words printed THUSLY indicate terminals;
and words printed <thusly> indicate lexical elements.
<pre class="example"> <em>Unit-Spec: one of</em>
nothing
<em>Shift-Spec</em>
<em>Shift-Spec: one of</em>
<em>Product-Spec</em>
<em>Product-Spec</em> SHIFT REAL
<em>Product-Spec</em> SHIFT INT
<em>Product-Spec</em> SHIFT <em>Timestamp</em>
<em>Product-Spec: one of</em>
<em>Power-Spec</em>
<em>Product-Spec</em> <em>Power-Spec</em>
<em>Product-Spec</em> MULTIPLY <em>Power-Spec</em>
<em>Product-Spec</em> DIVIDE <em>Power-Spec</em>
<em>Power-Spec: one of</em>
<em>Basic-Spec</em>
<em>Basic-Spec</em> INT
<em>Basic-Spec</em> EXPONENT
<em>Basic-Spec</em> RAISE INT
<em>Basic-Spec: one of</em>
ID
"(" <em>Shift-Spec</em> ")"
LOGREF <em>Product_Spec</em> ")"
<em>Number</em>
<em>Number: one of</em>
INT
REAL
<em>Timestamp: one of</em>
DATE
DATE CLOCK
DATE CLOCK CLOCK
DATE CLOCK INT
DATE CLOCK ID
TIMESTAMP
TIMESTAMP INT
TIMESTAMP ID
SHIFT:
<space>* <shift_op> <space>*
<shift_op>: one of
"@"
"after"
"from"
"since"
"ref"
REAL:
the usual floating-point format
INT:
the usual integer format
MULTIPLY: one of
"-"
"."
"*"
<space>+
<centered middot>
DIVIDE:
<space>* <divide_op> <space>*
<divide_op>: one of
per
PER
"/"
EXPONENT:
ISO-8859-9 or UTF-8 encoded exponent characters
RAISE: one of
"^"
"**"
ID: one of
<id>
"%"
"'"
"\""
degree sign
greek mu character
<id>:
<alpha> <alphanum>*
<alpha>:
[A-Za-z_]
ISO-8859-1 alphabetic characters
non-breaking space
<alphanum>: one of
<alpha>
<digit>
<digit>:
[0-9]
LOGREF:
<log> <space>* <logref>
<log>: one of
"log"
"lg"
"ln"
"lb"
<logref>:
"(" <space>* <re> ":"? <space>*
DATE:
<year> "-" <month> ("-" <day>)?
<year>:
[+-]?[0-9]{1,4}
<month>:
"0"?[1-9]|1[0-2]
<day>:
"0"?[1-9]|[1-2][0-9]|"30"|"31"
CLOCK:
<hour> ":" <minute> (":" <second>)?
TIMSTAMP:
<year> (<month> <day>?)? "T" <hour> (<minute> <second>?)?
<hour>:
[+-]?[0-1]?[0-9]|2[0-3]
<minute>:
[0-5]?[0-9]
<second>:
(<minute>|60) (\.[0-9]*)?
</pre>
<div class="node">
<a name="Formatting"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Operations">Operations</a>,
Previous: <a rel="previous" accesskey="p" href="#Syntax">Syntax</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">7 Formatting a Unit into a String</h2>
<p><a name="index-formatting-a-unit-into-a-string-52"></a><a name="index-unit_002c-formatting-into-a-string-53"></a><a name="index-string_002c-formatting-a-unit-into-a-54"></a>
Use the <code><a href="#ut_005fformat_0028_0029">ut_format()</a></code> function to obtain the string representation
of a binary unit.
For example, the following gets the definition of the unit "watt" in
ASCII characters using unit-symbols rather than unit-names:
<pre class="example"> ut_unit* watt = ...;
char buf[128];
unsigned opts = <a href="#ut_005fencoding">UT_ASCII</a> | UT_DEFINITION;
int len = <a href="#ut_005fformat_0028_0029">ut_format</a>(watt, buf, sizeof(buf), opts);
if (len == -1) {
/* Couldn't get string */
}
else if (len == sizeof(buf)) {
/* Entire buffer used: no terminating NUL */
}
else {
/* Have string with terminating NUL */
}
</pre>
<p><a name="ut_005fformat_0028_0029"></a>
<div class="defun">
— Function: <code>int</code> <b>ut_format</b> <code>(const ut_unit* </code><var>unit</var><code>, char* </code><var>buf</var><code>, size_t </code><var>size</var><code>, unsigned </code><var>opts</var><code>)</code><var><a name="index-ut_005fformat-55"></a></var><br>
<blockquote><p>Formats the unit <var>unit</var> (i.e., returns its string representation)
into the buffer pointed-to by <var>buf</var> of size <var>size</var>.
The argument <var>opts</var> specifies how the formatting is to be done and
is a bitwise OR of a <a href="#ut_005fencoding">ut_encoding</a> value and zero or more of the following:
<dl>
<dt><code>UT_NAMES</code><dd>Use unit names instead of symbols.
<br><dt><code>UT_DEFINITION</code><dd>The formatted string should be the definition of <var>unit</var> in terms
of basic-units instead of stopping any expansion at the highest level
possible.
</dl>
<p>On success, this function returns either the number of bytes – excluding the
terminating <code>NUL</code> – that were written into <code>buf</code> or the number of
bytes that <em>would have been written</em>. The difference is due to the
runtime <code>snprinf()</code> function that was used.
<p>On failure, this function returns <code>-1</code> and <a href="#ut_005fget_005fstatus_0028_0029">ut_get_status()</a> will
return one of the following:
<dl>
<dt><code>UT_BAD_ARG</code><dd><var>unit</var> or <var>buf</var> is <code>NULL</code>, or
<var>opts</var> contains the bit patterns of both <code>UT_LATIN1</code> and
<code>UT_UTF8</code>.
<br><dt><code>UT_CANT_FORMAT</code><dd><var>unit</var> can't be formatted in the desired manner (e.g., <var>opts</var>
contains <code>UT_ASCII</code> but <var>unit</var> doesn't have an identifier in
that character-set or <var>opts</var> doesn't contain UT_NAMES and a necessary
symbol doesn't exist).
</dl>
</p></blockquote></div>
<div class="node">
<a name="Operations"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Mapping">Mapping</a>,
Previous: <a rel="previous" accesskey="p" href="#Formatting">Formatting</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">8 Unit Operations</h2>
<p><a name="index-unit-operations-56"></a><a name="index-operations_002c-unit-57"></a>
You can use unit operations to construct new units, get information
about units, or compare units.
<ul class="menu">
<li><a accesskey="1" href="#Unary">Unary</a>: Operations on a single unit
<li><a accesskey="2" href="#Binary">Binary</a>: Operations on pairs of units
</ul>
<div class="node">
<a name="Unary"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Binary">Binary</a>,
Up: <a rel="up" accesskey="u" href="#Operations">Operations</a>
</div>
<h3 class="section">8.1 Unary Unit Operations</h3>
<p><a name="index-unary-unit-operations-58"></a>
<a name="ut_005ffree_0028_0029"></a>
<div class="defun">
— Function: <code>void</code> <b>ut_free</b> <code>(ut_unit* </code><var>unit</var><code>)</code><var><a name="index-ut_005ffree-59"></a></var><br>
<blockquote><p>Frees resources associated with <var>unit</var>.
You should invoke this function on every unit that you no longer need.
Use of <var>unit</var> upon
return from this function results in undefined behavior.
</p></blockquote></div>
<p><a name="ut_005fscale_0028_0029"></a>
<div class="defun">
— Function: <code>ut_unit*</code> <b>ut_scale</b> <code>(double </code><var>factor</var><code>, const ut_unit* </code><var>unit</var><code>)</code><var><a name="index-ut_005fscale-60"></a></var><br>
<blockquote><p>Returns a unit equivalent to another unit scaled by a numeric factor.
For example:
<pre class="example"> const ut_unit* meter = ...
const ut_unit* kilometer = ut_scale(1000, meter);
</pre>
<p>The returned unit is equivalent to <var>unit</var> multiplied by
<var>factor</var>.
You should pass the returned pointer to <code><a href="#ut_005ffree_0028_0029">ut_free()</a></code> when you
no longer need the unit.
</p></blockquote></div>
<p><a name="ut_005foffset_0028_0029"></a>
<div class="defun">
— Function: <code>ut_unit*</code> <b>ut_offset</b> <code>(const ut_unit* </code><var>unit</var><code>, double </code><var>offset</var><code>)</code><var><a name="index-ut_005foffset-61"></a></var><br>
<blockquote><p>Returns a unit equivalent to another unit relative to a particular
origin.
For example:
<pre class="example"> const ut_unit* kelvin = ...
const ut_unit* celsius = ut_offset(kelvin, 273.15);
</pre>
<p>The returned unit is equivalent to <var>unit</var> with an origin of
<var>offset</var>.
You should pass the returned pointer to <code><a href="#ut_005ffree_0028_0029">ut_free()</a></code> when you
no longer need the unit.
If an error occurs, then this function returns <code>NULL</code> and
<code><a href="#ut_005fget_005fstatus_0028_0029">ut_get_status()</a></code> will return one of the following:
<dl>
<dt><code>UT_BAD_ARG</code><dd><var>unit</var> is <code>NULL</code>.
<br><dt><code>UT_OS</code><dd>Operating-system error. See <code>errno</code> for the reason.
</dl>
</p></blockquote></div>
<p><a name="ut_005foffset_005fby_005ftime_0028_0029"></a>
<div class="defun">
— Function: <code>ut_unit*</code> <b>ut_offset_by_time</b> <code>(const ut_unit* const </code><var>unit</var><code>, const double </code><var>origin</var><code>)</code><var><a name="index-ut_005foffset_005fby_005ftime-62"></a></var><br>
<blockquote><p>Returns a timestamp-unit equivalent to the time unit <var>unit</var>
referenced to the time-origin <var>origin</var> (as returned by
<code><a href="#ut_005fencode_005ftime_0028_0029">ut_encode_time()</a></code>).
For example:
<pre class="example"> const ut_unit* second = ...
const ut_unit* secondsSinceTheEpoch =
ut_offset_by_time(second, ut_encode_time(1970, 1, 1, 0, 0, 0.0));
</pre>
<p>Leap seconds are not taken into account.
You should pass the returned pointer to <code><a href="#ut_005ffree_0028_0029">ut_free()</a></code> when you
no longer need the unit.
If an error occurs, then this function returns <code>NULL</code> and
<code><a href="#ut_005fget_005fstatus_0028_0029">ut_get_status()</a></code> will return one of the following:
<dl>
<dt><code>UT_BAD_ARG</code><dd><var>unit</var> is <code>NULL</code>.
<br><dt><code>UT_OS</code><dd>Operating-system error. See <code>errno</code> for the reason.
<br><dt><code>UT_MEANINGLESS</code><dd>Creation of a timestamp unit based on <var>unit</var> is not meaningful. It
might not be a time-unit, for example.
<br><dt><code>UT_NO_SECOND</code><dd>The associated unit-system doesn't contain a “second” unit. See
<code><a href="#ut_005fset_005fsecond_0028_0029">ut_set_second()</a></code>.
</dl>
<p><strong>CAUTION:</strong>
The timestamp-unit was created to be analogous to, for example, the degree
celsius—but for the time dimension.
I've come to believe, however, that creating
such a unit was a mistake, primarily because users try to use the unit in
ways for which it was not designed (such as converting dates in a
calendar whose year is exactly 365 days long).
Such activities are much better handled by a dedicated calendar package.
Please be careful about using timestamp-units.
See also the section on <a href="#Time">The Handling of Time</a>.
</blockquote></div>
<p><a name="ut_005finvert_0028_0029"></a>
<div class="defun">
— Function: <code>ut_unit*</code> <b>ut_invert</b> <code>(const ut_unit* </code><var>unit</var><code>)</code><var><a name="index-ut_005finvert-63"></a></var><br>
<blockquote><p>Returns the inverse (i.e., reciprocal) of the unit <var>unit</var>.
This convenience function is equal to
<code><a href="#ut_005fraise_0028_0029">ut_raise(</code><var>unit</var><code>,-1)</a></code>.
You should pass the returned pointer to <code><a href="#ut_005ffree_0028_0029">ut_free()</a></code> when you
no longer need the unit.
If an error occurs,
then this function writes an error-message using
<code><a href="#ut_005fhandle_005ferror_005fmessage_0028_0029">ut_handle_error_message()</a></code>
and returns <code>NULL</code>.
Also, <code><a href="#ut_005fget_005fstatus_0028_0029">ut_get_status()</a></code> will return one of the following:
<dl>
<dt><code>UT_BAD_ARG</code><dd><var>unit</var> is <code>NULL</code>.
<br><dt><code>UT_OS</code><dd>Operating-system error. See <code>errno</code> for the reason.
</dl>
</p></blockquote></div>
<p><a name="ut_005fraise_0028_0029"></a>
<div class="defun">
— Function: <code>ut_unit*</code> <b>ut_raise</b> <code>(const ut_unit* </code><var>unit</var><code>, int </code><var>power</var><code>)</code><var><a name="index-ut_005fraise-64"></a></var><br>
<blockquote><p>Returns the unit equal to unit <var>unit</var> raised to the power <var>power</var>.
You should pass the returned pointer to <code>ut_free()</code> when you
no longer need the unit.
If an error occurs,
then this function writes an error-message using
<code><a href="#ut_005fhandle_005ferror_005fmessage_0028_0029">ut_handle_error_message()</a></code>
and returns <code>NULL</code>.
Also, <code><a href="#ut_005fget_005fstatus_0028_0029">ut_get_status()</a></code> will return one of the following:
<dl>
<dt><code>UT_BAD_ARG</code><dd><var>unit</var> is <code>NULL</code>.
<br><dt><code>UT_OS</code><dd>Operating-system error. See <code>errno</code> for the reason.
</dl>
</p></blockquote></div>
<p><a name="ut_005froot_0028_0029"></a>
<div class="defun">
— Function: <code>ut_unit*</code> <b>ut_root</b> <code>(const ut_unit* </code><var>unit</var><code>, int </code><var>root</var><code>)</code><var><a name="index-ut_005froot-65"></a></var><br>
<blockquote><p>Returns the unit equal to the <var>root</var> root of unit <var>unit</var>.
You should pass the returned pointer to <code>ut_free()</code> when you
no longer need the unit.
If an error occurs,
then this function writes an error-message using
<code><a href="#ut_005fhandle_005ferror_005fmessage_0028_0029">ut_handle_error_message()</a></code>
and returns <code>NULL</code>.
Also, <code><a href="#ut_005fget_005fstatus_0028_0029">ut_get_status()</a></code> will return one of the following:
<dl>
<dt><code>UT_BAD_ARG</code><dd><var>unit</var> is <code>NULL</code>.
<br><dt><code>UT_MEANINGLESS</code><dd>It's meaningless to take the given root of the given unit.
This could be because the
resulting unit would have fractional (i.e., non-integral) dimensionality,
or because the unit is, for example, a logarithmic unit.
<br><dt><code>UT_OS</code><dd>Operating-system error. See <code>errno</code> for the reason.
</dl>
</p></blockquote></div>
<p><a name="ut_005flog_0028_0029"></a>
<div class="defun">
— Function: <code>ut_unit*</code> <b>ut_log</b> <code>(double </code><var>base</var><code>, const ut_unit* </code><var>reference</var><code>)</code><var><a name="index-ut_005flog-66"></a></var><br>
<blockquote><p>Returns the logarithmic unit corresponding to the logarithmic base
<var>base</var> and a reference level specified as the unit <var>reference</var>.
For example, the following creates a decibel unit with a
one milliwatt reference level:
<pre class="example"> const ut_unit* milliWatt = ...;
const ut_unit* bel_1_mW = ut_log(10.0, milliWatt);
if (bel_1_mW != NULL) {
const ut_unit* decibel_1_mW = <a href="#ut_005fscale_0028_0029">ut_scale</a>(0.1, bel_1_mW);
<a href="#ut_005ffree_0028_0029">ut_free</a>(bel_1_mW); /* no longer needed */
if (decibel_1_mW != NULL) {
/* Have decibel unit with 1 mW reference */
...
<a href="#ut_005ffree_0028_0029">ut_free</a>(decibel_1_mW);
} /* "decibel_1_mW" allocated */
}
</pre>
<p>You should pass the returned pointer to <code>ut_free()</code> when you
no longer need the unit.
If an error occurs,
then this function writes an error-message using
<code><a href="#ut_005fhandle_005ferror_005fmessage_0028_0029">ut_handle_error_message()</a></code>
and returns <code>NULL</code>.
Also, <code><a href="#ut_005fget_005fstatus_0028_0029">ut_get_status()</a></code> will return one of the following:
<dl>
<dt><code>UT_BAD_ARG</code><dd><var>reference</var> is <code>NULL</code>.
<br><dt><code>UT_OS</code><dd>Operating-system error. See <code>errno</code> for the reason.
<br><dt><code>UT_BAD_ARG</code><dd><var>base</var> is invalid (e.g., it must be greater than one).
</dl>
</p></blockquote></div>
<p><a name="ut_005fget_005fname_0028_0029"></a>
<div class="defun">
— Function: <code>const char*</code> <b>ut_get_name</b> <code>(const ut_unit* </code><var>unit</var><code>, ut_encoding </code><var>encoding</var><code>)</code><var><a name="index-ut_005fget_005fname-67"></a></var><br>
<blockquote><p>Returns the name to which the unit referenced by <var>unit</var> maps in the
character-encoding specified by <var>encoding</var>.
If this function returns <code>NULL</code>, then
<code><a href="#ut_005fget_005fstatus_0028_0029">ut_get_status()</a></code> will return
one of the following:
<dl>
<dt><code>UT_BAD_ARG</code><dd><var>name</var> is <code>NULL</code>.
<br><dt><code>UT_SUCCESS</code><dd><var>unit</var> doesn't map to a name in the given character-set.
</dl>
</p></blockquote></div>
<p><a name="ut_005fget_005fsymbol_0028_0029"></a>
<div class="defun">
— Function: <code>const char*</code> <b>ut_get_symbol</b> <code>(const ut_unit* </code><var>unit</var><code>, ut_encoding </code><var>encoding</var><code>)</code><var><a name="index-ut_005fget_005fsymbol-68"></a></var><br>
<blockquote><p>Returns the symbol to which the unit referenced by <var>unit</var> maps in the
character-encoding specified by <var>encoding</var>.
If this function returns <code>NULL</code>, then
<code><a href="#ut_005fget_005fstatus_0028_0029">ut_get_status()</a></code> will return
one of the following:
<dl>
<dt><code>UT_BAD_ARG</code><dd><var>symbol</var> is <code>NULL</code>.
<br><dt><code>UT_SUCCESS</code><dd><var>unit</var> doesn't map to a symbol in the given character-set.
</dl>
</p></blockquote></div>
<p><a name="ut_005fget_005fsystem_0028_0029"></a>
<div class="defun">
— Function: <code>ut_system*</code> <b>ut_get_system</b> <code>(const ut_unit* </code><var>unit</var><code>)</code><var><a name="index-ut_005fget_005fsystem-69"></a></var><br>
<blockquote><p>Returns the unit-system to which the unit referenced by <var>unit</var> belongs.
If <var>unit</var> is <code>NULL</code>, then this function writes an error-message
using <code><a href="#ut_005fhandle_005ferror_005fmessage_0028_0029">ut_handle_error_message()</a></code>
and returns <code>NULL</code>.
Also, <code><a href="#ut_005fget_005fstatus_0028_0029">ut_get_status()</a></code> will return <code>UT_BAD_ARG</code>.
</p></blockquote></div>
<p><a name="ut_005fis_005fdimensionless_0028_0029"></a>
<div class="defun">
— Function: <code>int</code> <b>ut_is_dimensionless</b> <code>(const ut_unit* </code><var>unit</var><code>)</code><var><a name="index-ut_005fis_005fdimensionless-70"></a></var><br>
<blockquote><p>Indicates if unit <var>unit</var> is dimensionless (like “radian”).
This function returns a non-zero value if the unit is dimensionfull;
otherwise, <code>0</code> is returned and
<a href="#ut_005fget_005fstatus_0028_0029">ut_get_status()</a> will return one of the following:
<dl>
<dt><code>UT_BAD_ARG</code><dd><var>unit1</var> is <code>NULL</code>.
<br><dt><code>UT_SUCCESS</code><dd>The unit is dimensionless.
</dl>
</p></blockquote></div>
<p><a name="ut_005fclone_0028_0029"></a>
<div class="defun">
— Function: <code>ut_unit*</code> <b>ut_clone</b> <code>(const ut_unit* </code><var>unit</var><code>)</code><var><a name="index-ut_005fclone-71"></a></var><br>
<blockquote><p>Returns a copy of the unit referenced by <var>unit</var>.
You should pass the returned pointer to <code>ut_free()</code> when you
no longer need the unit.
If an error occurs,
then this function writes an error-message using
<code><a href="#ut_005fhandle_005ferror_005fmessage_0028_0029">ut_handle_error_message()</a></code>
and returns <code>NULL</code>.
Also, <code><a href="#ut_005fget_005fstatus_0028_0029">ut_get_status()</a></code> will return one of the following:
<dl>
<dt><code>UT_BAD_ARG</code><dd><var>unit</var> is <code>NULL</code>.
<br><dt><code>UT_OS</code><dd>Operating-system failure. See <code>errno</code>.
</dl>
If you use <code><a href="#ut_005fread_005fxml_0028_0029">ut_read_xml()</a></code>, then you should not normally
need to call this function.
</p></blockquote></div>
<p><a name="ut_005faccept_005fvisitor_0028_0029"></a>
<div class="defun">
— Function: <code><a href="#ut_005fstatus">ut_status</a></code> <b>ut_accept_visitor</b> <code>(const ut_unit* </code><var>unit</var><code>, const <a href="#ut_005fvisitor">ut_visitor</a>* </code><var>visitor</var><code>, void* </code><var>arg</var><code>)</code><var><a name="index-ut_005faccept_005fvisitor-72"></a></var><br>
<blockquote><p>Accepts the visitor <var>visitor</var> to the unit <var>unit</var>.
The argument <var>arg</var> is passed to the visitor's functions.
This function returns one of the following:
<dl>
<dt><code>UT_BAD_ARG</code><dd><var>visitor</var> or <var>unit</var> is <code>NULL</code>.
<br><dt><code>UT_VISIT_ERROR</code><dd>An error occurred in <var>visitor</var> while visiting <var>unit</var>.
<br><dt><code>UT_SUCCESS</code><dd>Success.
</dl>
</p></blockquote></div>
<p><a name="ut_005fvisitor"></a>
<div class="defun">
— Data type: <b>ut_visitor</b><var> int foo(int) int bar(int, int)<a name="index-ut_005fvisitor-73"></a></var><br>
<blockquote><p>You pass a pointer to a data object of this type if and when you call
<code><a href="#ut_005faccept_005fvisitor_0028_0029">ut_accept_visitor()</a></code>.
It contains the following pointers to functions that implement your
unit-visitor:
<dl>
<dt><code><a href="#ut_005fstatus">ut_status</a> (*visit_basic)(const ut_unit* </code><var>unit</var><code>, void* </code><var>arg</var><code>);</code><dd>Visits the basic-unit <var>unit</var>. A basic-unit is a base unit like
“meter” or a non-dimensional but named unit like “radian”.
This function returns <code><a href="#ut_005fstatus">UT_SUCCESS</a></code> on and only on success.
<br><dt><code><a href="#ut_005fstatus">ut_status</a> (*visit_product)(const ut_unit* </code><var>unit</var><code>, int </code><var>count</var><code>, const ut_unit* const* </code><var>basicUnits</var><code>, const int* </code><var>powers</var><code>, void* </code><var>arg</var><code>);</code><dd>Visits the product-unit <var>unit</var>.
The product-unit is a product of the <var>count</var>
basic-units referenced by <var>basicUnits</var>, each raised to their respective,
non-zero power in <var>powers</var>.
This function returns <code><a href="#ut_005fstatus">UT_SUCCESS</a></code> on and only on success.
<br><dt><code><a href="#ut_005fstatus">ut_status</a> (*visit_galilean)(const ut_unit* </code><var>unit</var><code>, double </code><var>scale</var><code>, const ut_unit* </code><var>underlyingUnit</var><code>, double </code><var>origin</var><code>, void* arg);</code><dd>Visits the Galilean-unit <var>unit</var>.
The Galilean-unit has the underlying unit <var>underlyingUnit</var> and either the
non-unity scale factor <var>scale</var> or the non-zero origin <var>origin</var>, or both.
This function returns <code><a href="#ut_005fstatus">UT_SUCCESS</a></code> on and only on success.
<br><dt><code><a href="#ut_005fstatus">ut_status</a> (*visit_timestamp)(const ut_unit* </code><var>unit</var><code>, const ut_unit* </code><var>timeUnit</var><code>, double </code><var>origin</var><code>, void* </code><var>arg</var><code>);</code><dd>Visits the timestamp-unit <var>unit</var>.
The timestamp-unit has the underlying unit of time <var>timeUnit</var>
and the <code><a href="#ut_005fencode_005ftime_0028_0029">ut_encode_time()</a></code>-encoded time-origin <var>origin</var>.
This function returns <code><a href="#ut_005fstatus">UT_SUCCESS</a></code> on and only on success.
<br><dt><code><a href="#ut_005fstatus">ut_status</a> (*visit_logarithmic)(const ut_unit* </code><var>unit</var><code>, double </code><var>base</var><code>, const ut_unit* </code><var>reference</var><code>, void* </code><var>arg</var><code>);</code><dd>Visits the logarithmic-unit <var>unit</var>.
The logarithmic-unit has the logarithmic base <var>base</var> and
the reference-level is specified by the unit <var>reference</var>.
This function returns <code><a href="#ut_005fstatus">UT_SUCCESS</a></code> on and only on success.
</dl>
</p></blockquote></div>
<div class="node">
<a name="Binary"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Unary">Unary</a>,
Up: <a rel="up" accesskey="u" href="#Operations">Operations</a>
</div>
<h3 class="section">8.2 Binary Unit Operations</h3>
<p><a name="index-binary-unit-operations-74"></a>
Binary unit operations act on two units.
<p><strong>NOTE\:</strong> The functions
<code><a href="#ut_005fare_005fconvertible_0028_0029">ut_are_convertible()</a></code> and <code><a href="#ut_005fget_005fconverter_0028_0029">ut_get_converter()</a></code> are also
binary unit operations but are documented elsewhere.
<p><a name="ut_005fmultiply_0028_0029"></a>
<div class="defun">
— Function: <code>ut_unit*</code> <b>ut_multiply</b> <code>(const ut_unit* </code><var>unit1</var><code>, const ut_unit* </code><var>unit2</var><code>)</code><var><a name="index-ut_005fmultiply-75"></a></var><br>
<blockquote><p>Returns the result of multiplying unit <var>unit1</var> by unit <var>unit2</var>.
You should pass the pointer to <a href="#ut_005ffree_0028_0029">ut_free()</a> when you no longer need the unit
On failure, this function returns <code>NULL</code> and <a href="#ut_005fget_005fstatus_0028_0029">ut_get_status()</a>
will return one of the following:
<dl>
<dt><code>UT_BAD_ARG</code><dd><var>unit1</var> or <var>unit2</var> is <code>NULL</code>.
<br><dt><code>UT_NOT_SAME_SYSTEM</code><dd><var>unit1</var> and <var>unit2</var> belong to different <a href="#unit_002dsystem">unit-system</a>s.
<br><dt><code>UT_OS</code><dd>Operating-system error. See <var>errno</var> for the reason.
</dl>
</p></blockquote></div>
<p><a name="ut_005fdivide_0028_0029"></a>
<div class="defun">
— Function: <code>ut_unit*</code> <b>ut_divide</b> <code>(const ut_unit* </code><var>numer</var><code>, const ut_unit* </code><var>denom</var><code>)</code><var><a name="index-ut_005fdivide-76"></a></var><br>
<blockquote><p>Returns the result of dividing unit <var>numer</var> by unit <var>denom</var>.
You should pass the pointer to <a href="#ut_005ffree_0028_0029">ut_free()</a> when you no longer need the unit
On failure, this function returns <code>NULL</code> and <a href="#ut_005fget_005fstatus_0028_0029">ut_get_status()</a>
will return one of the following:
<dl>
<dt><code>UT_BAD_ARG</code><dd><var>numer</var> or <var>denom</var> is <code>NULL</code>.
<br><dt><code>UT_NOT_SAME_SYSTEM</code><dd><var>unit1</var> and <var>unit2</var> belong to different <a href="#unit_002dsystem">unit-system</a>s.
<br><dt><code>UT_OS</code><dd>Operating-system error. See <code>errno</code> for the reason.
</dl>
</p></blockquote></div>
<p><a name="ut_005fcompare_0028_0029"></a>
<div class="defun">
— Function: <code>int</code> <b>ut_compare</b> <code>(const ut_unit* </code><var>unit1</var><code>, const ut_unit* </code><var>unit2</var><code>)</code><var><a name="index-ut_005fcompare-77"></a></var><br>
<blockquote><p>Compares two units. Returns a value less than, equal to, or greater than
zero as <var>unit1</var> is considered less than, equal to, or greater than
<var>unit2</var>, respectively.
Units from different <a href="#unit_002dsystem">unit-system</a>s never compare equal.
The value zero is also returned if both unit pointers are <code>NULL</code>.
</p></blockquote></div>
<p><a name="ut_005fsame_005fsystem_0028_0029"></a>
<div class="defun">
— Function: <code>int</code> <b>ut_same_system</b> <code>(const ut_unit* </code><var>unit1</var><code>, const ut_unit* </code><var>unit2</var><code>)</code><var><a name="index-ut_005fsame_005fsystem-78"></a></var><br>
<blockquote><p>Indicates if two units belong to the same unit-system.
This function returns a non-zero value if the two units belong to the
same <a href="#unit_002dsystem">unit-system</a>; otherwise, <code>0</code> is returned and
<a href="#ut_005fget_005fstatus_0028_0029">ut_get_status()</a> will return one of the following:
<dl>
<dt><code>UT_BAD_ARG</code><dd><var>unit1</var> or <var>unit2</var> is <code>NULL</code>.
<br><dt><code>UT_SUCCESS</code><dd>The units belong to different <a href="#unit_002dsystem">unit-system</a>s.
</dl>
</p></blockquote></div>
<div class="node">
<a name="Mapping"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Time">Time</a>,
Previous: <a rel="previous" accesskey="p" href="#Operations">Operations</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">9 Mapping Between Identifiers and Units</h2>
<p><a name="index-mapping-units-79"></a><a name="index-mapping-identifiers-80"></a><a name="index-units_002c-mapping-to-identifiers-81"></a>
Within a unit-system, you can map an identifier to a unit and vice
versa.
If an identifier maps to a unit, then the unit can be retrieved from the
unit-system via the identifier.
Similarly, if a unit maps to an identifier, then the unit can be printed
using the identifier.
<p>There a two kinds of identifiers: names and symbols.
<ul class="menu">
<li><a accesskey="1" href="#Names">Names</a>: Mapping between units and names.
<li><a accesskey="2" href="#Symbols">Symbols</a>: Mapping between units and symbols.
</ul>
<div class="node">
<a name="Names"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Symbols">Symbols</a>,
Up: <a rel="up" accesskey="u" href="#Mapping">Mapping</a>
</div>
<h3 class="section">9.1 Names</h3>
<p><a name="index-names-82"></a>
You can map a name to a unit and vice versa. If you use
<code><a href="#ut_005fread_005fxml_0028_0029">ut_read_xml()</a></code>, then you shouldn't normally need to do this.
<p><a name="ut_005fmap_005fname_005fto_005funit_0028_0029"></a>
<div class="defun">
— Function: <code><a href="#ut_005fstatus">ut_status</a></code> <b>ut_map_name_to_unit</b> <code>(const char* </code><var>name</var><code>, const ut_encoding </code><var>encoding</var><code>, const ut_unit* </code><var>unit</var><code>)</code><var><a name="index-ut_005fmap_005fname_005fto_005funit-83"></a></var><br>
<blockquote><p>Maps the name referenced by <var>name</var>, in character-set <var>encoding</var>,
to the unit referenced by <var>unit</var>
in the unit-system that contains <var>unit</var>.
This function returns one of the following:
<dl>
<dt><code>UT_SUCCESS</code><dd>Success.
<br><dt><code>UT_BAD_ARG</code><dd><var>name</var> or <var>unit</var> is <code>NULL</code>.
<br><dt><code>UT_OS</code><dd>Operating-system failure. See <code>errno</code>.
<br><dt><code>UT_EXISTS</code><dd><var>name</var> already maps to a different unit.
</dl>
</p></blockquote></div>
<p><a name="ut_005funmap_005fname_005fto_005funit_0028_0029"></a>
<div class="defun">
— Function: <code><a href="#ut_005fstatus">ut_status</a></code> <b>ut_unmap_name_to_unit</b> <code>(ut_system* </code><var>system</var><code>, const char* </code><var>name</var><code>, const ut_encoding </code><var>encoding</var><code>)</code><var><a name="index-ut_005funmap_005fname_005fto_005funit-84"></a></var><br>
<blockquote><p>Removes any mapping from name <var>name</var>, in character-set <var>encoding</var>, to a unit in unit-system <var>system</var>.
This function returns one of the following:
<dl>
<dt><code>UT_SUCCESS</code><dd>Success.
<br><dt><code>UT_BAD_ARG</code><dd><var>system</var> or <var>name</var> is <code>NULL</code>.
</dl>
</p></blockquote></div>
<p><a name="ut_005fmap_005funit_005fto_005fname_0028_0029"></a>
<div class="defun">
— Function: <code><a href="#ut_005fstatus">ut_status</a></code> <b>ut_map_unit_to_name</b> <code>(const ut_unit* </code><var>unit</var><code>, const char* </code><var>name</var><code>, ut_encoding </code><var>encoding</var><code>)</code><var><a name="index-ut_005fmap_005funit_005fto_005fname-85"></a></var><br>
<blockquote><p>Maps the unit <var>unit</var> to the name <var>name</var>, which is in character-set
<var>encoding</var>, in the unit-system that contains the unit.
This function returns one of the following:
<dl>
<dt><code>UT_SUCCESS</code><dd>Success.
<br><dt><code>UT_BAD_ARG</code><dd><var>unit</var> or <var>name</var> is <code>NULL</code>, or <var>name</var> is not in the
character-set <var>encoding</var>.
<br><dt><code>UT_OS</code><dd>Operating-system failure. See <code>errno</code>.
<br><dt><code>UT_EXISTS</code><dd><var>unit</var> already maps to a different name.
</dl>
</p></blockquote></div>
<p><a name="ut_005funmap_005funit_005fto_005fname_0028_0029"></a>
<div class="defun">
— Function: <code><a href="#ut_005fstatus">ut_status</a></code> <b>ut_unmap_unit_to_name</b> <code>(const ut_unit* </code><var>unit</var><code>, ut_encoding </code><var>encoding</var><code>)</code><var><a name="index-ut_005funmap_005funit_005fto_005fname-86"></a></var><br>
<blockquote><p>Removes any mapping from unit <var>unit</var> to a name in character-set
<var>encoding</var> from the unit-system that contains the unit.
This function returns one of the following:
<dl>
<dt><code>UT_SUCCESS</code><dd>Success.
<br><dt><code>UT_BAD_ARG</code><dd><var>unit</var> is <code>NULL</code>.
</dl>
</p></blockquote></div>
<div class="node">
<a name="Symbols"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Names">Names</a>,
Up: <a rel="up" accesskey="u" href="#Mapping">Mapping</a>
</div>
<h3 class="section">9.2 Symbols</h3>
<p><a name="index-symbols-87"></a>
You can map a symbol to a unit and vice versa. If you use
<code><a href="#ut_005fread_005fxml_0028_0029">ut_read_xml()</a></code>, then you shouldn't normally need to do this.
<p><a name="ut_005fmap_005fsymbol_005fto_005funit_0028_0029"></a>
<div class="defun">
— Function: <code><a href="#ut_005fstatus">ut_status</a></code> <b>ut_map_symbol_to_unit</b> <code>(const char* </code><var>symbol</var><code>, const ut_encoding </code><var>encoding</var><code>, const ut_unit* </code><var>unit</var><code>)</code><var><a name="index-ut_005fmap_005fsymbol_005fto_005funit-88"></a></var><br>
<blockquote><p>Maps the symbol referenced by <var>symbol</var>, in character-set <var>encoding</var>,
to the unit referenced by <var>unit</var>
in the unit-system that contains <var>unit</var>.
This function returns one of the following:
<dl>
<dt><code>UT_SUCCESS</code><dd>Success.
<br><dt><code>UT_BAD_ARG</code><dd><var>symbol</var> or <var>unit</var> is <code>NULL</code>.
<br><dt><code>UT_OS</code><dd>Operating-system failure. See <code>errno</code>.
<br><dt><code>UT_EXISTS</code><dd><var>symbol</var> already maps to a different unit.
</dl>
</p></blockquote></div>
<p><a name="ut_005funmap_005fsymbol_005fto_005funit_0028_0029"></a>
<div class="defun">
— Function: <code><a href="#ut_005fstatus">ut_status</a></code> <b>ut_unmap_symbol_to_unit</b> <code>(ut_system* </code><var>system</var><code>, const char* </code><var>symbol</var><code>, const ut_encoding </code><var>encoding</var><code>)</code><var><a name="index-ut_005funmap_005fsymbol_005fto_005funit-89"></a></var><br>
<blockquote><p>Removes any mapping from symbol <var>symbol</var>, in character-set <var>encoding</var>, to a unit in unit-system <var>system</var>.
This function returns one of the following:
<dl>
<dt><code>UT_SUCCESS</code><dd>Success.
<br><dt><code>UT_BAD_ARG</code><dd><var>system</var> or <var>symbol</var> is <code>NULL</code>.
</dl>
</p></blockquote></div>
<p><a name="ut_005fmap_005funit_005fto_005fsymbol_0028_0029"></a>
<div class="defun">
— Function: <code><a href="#ut_005fstatus">ut_status</a></code> <b>ut_map_unit_to_symbol</b> <code>(const ut_unit* </code><var>unit</var><code>, const char* </code><var>symbol</var><code>, ut_encoding </code><var>encoding</var><code>)</code><var><a name="index-ut_005fmap_005funit_005fto_005fsymbol-90"></a></var><br>
<blockquote><p>Maps the unit <var>unit</var> to the symbol <var>symbol</var>, which is in character-set
<var>encoding</var>, in the unit-system that contains the unit.
This function returns one of the following:
<dl>
<dt><code>UT_SUCCESS</code><dd>Success.
<br><dt><code>UT_BAD_ARG</code><dd><var>unit</var> or <var>symbol</var> is <code>NULL</code>.
<br><dt><code>UT_BAD_ARG</code><dd>Symbol <var>symbol</var> is not in the character-set <var>encoding</var>.
<br><dt><code>UT_OS</code><dd>Operating-system failure. See <code>errno</code>.
<br><dt><code>UT_EXISTS</code><dd><var>unit</var> already maps to a different symbol.
</dl>
</p></blockquote></div>
<p><a name="ut_005funmap_005funit_005fto_005fsymbol_0028_0029"></a>
<div class="defun">
— Function: <code><a href="#ut_005fstatus">ut_status</a></code> <b>ut_unmap_unit_to_symbol</b> <code>(const ut_unit* </code><var>unit</var><code>, ut_encoding </code><var>encoding</var><code>)</code><var><a name="index-ut_005funmap_005funit_005fto_005fsymbol-91"></a></var><br>
<blockquote><p>Removes any mapping from unit <var>unit</var> to a symbol in character-set
<var>encoding</var> from the unit-system that contains the unit.
This function returns one of the following:
<dl>
<dt><code>UT_SUCCESS</code><dd>Success.
<br><dt><code>UT_BAD_ARG</code><dd><var>unit</var> is <code>NULL</code>.
</dl>
</p></blockquote></div>
<div class="node">
<a name="Time"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Errors">Errors</a>,
Previous: <a rel="previous" accesskey="p" href="#Mapping">Mapping</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">10 The Handling of Time</h2>
<p><a name="index-time_002c-handling-of-92"></a>
You should use a true calendar package rather than the UDUNITS-2 package
to handle time. Having said that, many people use the time-handling
capabilities of the UDUNITS-2 package because it supports "units" like
"<code>seconds since 1970-01-01</code>". You should be aware, however, that the
hybrid Gregorian/Julian calendar used by the UDUNITS-2 package <em>cannot be
changed</em>. Dates on or after 1582-10-15 are assumed to be Gregorian dates;
dates before that are assumed to be Julian dates. In particular,
the year 1 BCE is immediately followed by the year 1 CE.
<p>In general, the UDUNITS-2 package handles time by encoding it as
double-precision value, which can then be acted upon arithmetically.
<p><a name="ut_005fencode_005ftime_0028_0029"></a>
<div class="defun">
— Function: <code>double</code> <b>ut_encode_time</b> <code>(int </code><var>year</var><code>, int </code><var>month</var><code>, int </code><var>day</var><code>, int </code><var>hour</var><code>, int </code><var>minute</var><code>, double </code><var>second</var><code>)</code><var><a name="index-ut_005fencode_005ftime-93"></a></var><br>
<blockquote><p>Encodes a time as a double-precision value.
This convenience function is equivalent to
<pre class="example"> <a href="#ut_005fencode_005fdate_0028_0029">ut_encode_date</a>(<var>year</var>,<var>month</var>,<var>day</var>) + <a href="#ut_005fencode_005fclock_0028_0029">ut_encode_clock</a>(<var>hour</var>,<var>minute</var>,<var>second</var>)
</pre>
</blockquote></div>
<p><a name="ut_005fencode_005fdate_0028_0029"></a>
<div class="defun">
— Function: <code>double</code> <b>ut_encode_date</b> <code>(int </code><var>year</var><code>, int </code><var>month</var><code>, int </code><var>day</var><code>)</code><var><a name="index-ut_005fencode_005fdate-94"></a></var><br>
<blockquote><p>Encodes a date as a double-precision value.
You probably won't use this function.
Dates on or after 1582-10-15 are assumed to be Gregorian dates;
dates before that are assumed to be Julian dates. In particular,
the year 1 BCE is immediately followed by the year 1 CE.
</p></blockquote></div>
<p><a name="ut_005fencode_005fclock_0028_0029"></a>
<div class="defun">
— Function: <code>double</code> <b>ut_encode_clock</b> <code>(int </code><var>hour</var><code>, int </code><var>minute</var><code>, double </code><var>second</var><code>)</code><var><a name="index-ut_005fencode_005fclock-95"></a></var><br>
<blockquote><p>Encodes a clock-time as a double-precision value.
You probably won't use this function.
</p></blockquote></div>
<p><a name="ut_005fdecode_005ftime_0028_0029"></a>
<div class="defun">
— Function: <code>void</code> <b>ut_decode_time</b> <code>(double </code><var>time</var><code>, int* </code><var>year</var><code>, int* </code><var>month</var><code>, int* </code><var>day</var><code>, int* </code><var>hour</var><code>, int* </code><var>minute</var><code>, double* </code><var>second</var><code>, double* </code><var>resolution</var><code>)</code><var><a name="index-ut_005fdecode_005ftime-96"></a></var><br>
<blockquote><p>Decodes a time from a double-precision value into its individual components.
The variable referenced by <var>resolution</var> will be set to the resolution
(i.e., uncertainty) of the time in seconds.
</p></blockquote></div>
<div class="node">
<a name="Errors"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Database">Database</a>,
Previous: <a rel="previous" accesskey="p" href="#Time">Time</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">11 Error Handling</h2>
<p><a name="index-error-handling-97"></a>
Error-handling in the units module has two aspects: the status of
the last operation performed by the module and the handling of error-messages:
<ul class="menu">
<li><a accesskey="1" href="#Status">Status</a>: The status of the last operation.
<li><a accesskey="2" href="#Messages">Messages</a>: The handling of error-messages.
</ul>
<div class="node">
<a name="Status"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Messages">Messages</a>,
Up: <a rel="up" accesskey="u" href="#Errors">Errors</a>
</div>
<h3 class="section">11.1 Status of Last Operation</h3>
<p><a name="index-status-of-last-operation-98"></a><a name="index-module-status-99"></a>
UDUNITS-2 functions set their status by calling <code><a href="#ut_005fset_005fstatus_0028_0029">ut_set_status()</a></code>.
You can use the function <code><a href="#ut_005fget_005fstatus_0028_0029">ut_get_status()</a></code> to retrieve that
status.
<p><a name="ut_005fget_005fstatus_0028_0029"></a>
<div class="defun">
— Function: <code><a href="#ut_005fstatus">ut_status</a></code> <b>ut_get_status</b> <code>(void)</code><var><a name="index-ut_005fget_005fstatus-100"></a></var><br>
<blockquote><p>Returns the value specified in the last call to
<code><a href="#ut_005fset_005fstatus_0028_0029">ut_set_status()</a></code>
</p></blockquote></div>
<p><a name="ut_005fset_005fstatus_0028_0029"></a>
<div class="defun">
— Function: <code>void</code> <b>ut_set_status</b> <code>(<a href="#ut_005fstatus">ut_status</a> </code><var>status</var><code>)</code><var><a name="index-ut_005fset_005fstatus-101"></a></var><br>
<blockquote><p>Set the status of the units module to <var>status</var>.
</p></blockquote></div>
<p><a name="ut_005fstatus"></a>
<div class="defun">
— Data type: <b>ut_status</b><var><a name="index-ut_005fstatus-102"></a></var><br>
<blockquote><p>This enumeration has the following values:
<dl>
<dt><code>UT_SUCCESS</code><dd>Success
<br><dt><code>UT_BAD_ARG</code><dd>An argument violates the the function's contract (e.g., it's <code>NULL</code>).
<br><dt><code>UT_EXISTS</code><dd>Unit, prefix, or identifier already exists
<br><dt><code>UT_NO_UNIT</code><dd>No such unit exists
<br><dt><code>UT_OS</code><dd>Operating-system error. See <code>errno</code> for the reason.
<br><dt><code>UT_NOT_SAME_SYSTEM</code><dd>The units belong to different unit-systems
<br><dt><code>UT_MEANINGLESS</code><dd>The operation on the unit or units is meaningless
<br><dt><code>UT_NO_SECOND</code><dd>The unit-system doesn't have a unit named “second”
<br><dt><code>UT_VISIT_ERROR</code><dd>An error occurred while visiting a unit
<br><dt><code>UT_CANT_FORMAT</code><dd>A unit can't be formatted in the desired manner
<br><dt><code>UT_SYNTAX</code><dd>String unit representation contains syntax error
<br><dt><code>UT_UNKNOWN</code><dd>String unit representation contains unknown word
<br><dt><code>UT_OPEN_ARG</code><dd>Can't open argument-specified unit database
<br><dt><code>UT_OPEN_ENV</code><dd>Can't open environment-specified unit database
<br><dt><code>UT_OPEN_DEFAULT</code><dd>Can't open installed, default, unit database
<br><dt><code>UT_PARSE</code><dd>Error parsing unit database
</dl>
</p></blockquote></div>
<div class="node">
<a name="Messages"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Status">Status</a>,
Up: <a rel="up" accesskey="u" href="#Errors">Errors</a>
</div>
<h3 class="section">11.2 Error-Messages</h3>
<p><a name="index-messages_002c-error-103"></a><a name="index-error_002dmessages-104"></a>
<a name="ut_005fhandle_005ferror_005fmessage_0028_0029"></a>
<div class="defun">
— Function: <code>int</code> <b>ut_handle_error_message</b> <code>(const char* </code><var>fmt</var><code>, ...)</code><var><a name="index-ut_005fhandle_005ferror_005fmessage-105"></a></var><br>
<blockquote><p>Handles the error-message corresponding to the format-string <var>fmt</var> and
any subsequent arguments referenced by it.
The interpretation of the formatting-string is identical to that of
the UNIX function <code>printf()</code>.
On success, this function returns the number of bytes in the
error-message; otherwise, this function returns <code>-1</code>.
<p>Use the function <code><a href="#ut_005fset_005ferror_005fmessage_005fhandler_0028_0029">ut_set_error_message_handler()</a></code> to change how
error-messages are handled.
</p></blockquote></div>
<p><a name="ut_005fset_005ferror_005fmessage_005fhandler_0028_0029"></a>
<div class="defun">
— Function: <code><a href="#ut_005ferror_005fmessage_005fhandler">ut_error_message_handler</a></code> <b>ut_set_error_message_handler</b> <code>(<a href="#ut_005ferror_005fmessage_005fhandler">ut_error_message_handler</a> </code><var>handler</var><code>)</code><var><a name="index-ut_005fset_005ferror_005fmessage_005fhandler-106"></a></var><br>
<blockquote><p>Sets the function that handles error-messages and returns the previous
error-message handler.
The initial error-message handler is <code><a href="#ut_005fwrite_005fto_005fstderr_0028_0029">ut_write_to_stderr()</a></code>.
</p></blockquote></div>
<p><a name="ut_005fwrite_005fto_005fstderr_0028_0029"></a>
<div class="defun">
— Function: <code>int</code> <b>ut_write_to_stderr</b> <code>(const char* </code><var>fmt</var><code>, va_list </code><var>args</var><code>)</code><var><a name="index-ut_005fwrite_005fto_005fstderr-107"></a></var><br>
<blockquote><p>Writes the variadic error-message
corresponding to formatting-string <var>fmt</var> and arguments <var>args</var>
to the standard-error stream and appends a newline.
The interpretation of the formatting-string is identical to that of
the UNIX function <code>printf()</code>.
On success, this function returns the number of bytes in the
error-message; otherwise, this function returns <code>-1</code>.
</p></blockquote></div>
<p><a name="ut_005fignore_0028_0029"></a>
<div class="defun">
— Function: <code>int</code> <b>ut_ignore</b> <code>(const char* </code><var>fmt</var><code>, va_list </code><var>args</var><code>)</code><var><a name="index-ut_005fignore-108"></a></var><br>
<blockquote><p>Does nothing.
In particular, it ignores the variadic error-message
corresponding to formatting-string <var>fmt</var> and arguments <var>args</var>.
Pass this function to <code><a href="#ut_005fset_005ferror_005fmessage_005fhandler_0028_0029">ut_set_error_message_handler()</a></code>
when you don't want the unit module to print any error-messages.
</p></blockquote></div>
<p><a name="ut_005ferror_005fmessage_005fhandler"></a>
<div class="defun">
— Data type: <b>ut_error_message_handler</b><var><a name="index-ut_005ferror_005fmessage_005fhandler-109"></a></var><br>
<blockquote><p>This is the type of an error-message handler.
It's definition is
<pre class="example"> typedef int (*ut_error_message_handler)(const char* fmt, va_list args);
</pre>
</blockquote></div>
<div class="node">
<a name="Database"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Types">Types</a>,
Previous: <a rel="previous" accesskey="p" href="#Errors">Errors</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">12 The Units Database</h2>
<p><a name="index-units-database-110"></a><a name="index-database_002c-units-111"></a>
The database of units that comes with the UDUNITS-2 package is an
XML-formatted file that is based on the SI system of units.
It contains the names and symbols of most of the units that you will ever
encounter.
The pathname of the installed file is
<em>datadir</em><code>/udunits2.xml</code>, where <em>datadir</em> is the
installation-directory for read-only, architecture-independent data
(e.g., <code>/usr/local/share</code>).
This pathname is the default that <code><a href="#ut_005fread_005fxml_0028_0029">ut_read_xml()</a></code> uses.
<p>Naturally, because the database is a regular file, it can be edited
to add new units or remove existing ones.
Be very careful about doing this, however, because you might lose
the benefit of exchanging unit-based information with others who
haven't modified their database.
<div class="node">
<a name="Types"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Complete-Index">Complete Index</a>,
Previous: <a rel="previous" accesskey="p" href="#Database">Database</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">13 Data Types</h2>
<p><a name="index-data-types-112"></a><a name="index-types_002c-data-113"></a>
The data types <code><a href="#ut_005fvisitor">ut_visitor</a></code>, <code><a href="#ut_005fstatus">ut_status</a></code>, and
<code><a href="#ut_005ferror_005fmessage_005fhandler">ut_error_message_handler</a></code> are documented elsewhere.
<p><a name="ut_005fencoding"></a>
<div class="defun">
— Data type: <b>ut_encoding</b><var><a name="index-ut_005fencoding-114"></a></var><br>
<blockquote><p>This enumeration has the following values:
<dl>
<dt><code>UT_ASCII</code><dd><a href="http://en.wikipedia.org/wiki/Ascii">US ASCII</a> character-set.
<br><dt><code>UT_ISO_8859_1</code><dd>The <a href="http://en.wikipedia.org/wiki/Iso-8859-1">ISO-8859-1</a> character-set.
<br><dt><code>UT_LATIN1</code><dd>Synonym for <code>UT_ISO_8859_1</code>.
<br><dt><code>UT_UTF8</code><dd>The <a href="http://en.wikipedia.org/wiki/Utf-8">UTF-8</a> encoding of the Unicode
character-set.
</dl>
</p></blockquote></div>
<div class="node">
<a name="Complete-Index"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Types">Types</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="unnumbered">Index</h2>
<ul class="index-cp" compact>
<li><a href="#index-adding-prefixes-to-a-unit_002dsystem-27">adding prefixes to a unit-system</a>: <a href="#Prefixes">Prefixes</a></li>
<li><a href="#index-adding-units-to-a-unit_002dsystem-21">adding units to a unit-system</a>: <a href="#Adding">Adding</a></li>
<li><a href="#index-base-unit-5">base unit</a>: <a href="#Unit_002dSystems">Unit-Systems</a></li>
<li><a href="#index-binary-unit-operations-74">binary unit operations</a>: <a href="#Binary">Binary</a></li>
<li><a href="#index-converting-values-between-units-33">converting values between units</a>: <a href="#Value-Conversion">Value Conversion</a></li>
<li><a href="#index-cv_005fconvert_005fdouble-38"><code>cv_convert_double</code></a>: <a href="#Value-Conversion">Value Conversion</a></li>
<li><a href="#index-cv_005fconvert_005fdoubles-40"><code>cv_convert_doubles</code></a>: <a href="#Value-Conversion">Value Conversion</a></li>
<li><a href="#index-cv_005fconvert_005ffloat-37"><code>cv_convert_float</code></a>: <a href="#Value-Conversion">Value Conversion</a></li>
<li><a href="#index-cv_005fconvert_005ffloats-39"><code>cv_convert_floats</code></a>: <a href="#Value-Conversion">Value Conversion</a></li>
<li><a href="#index-cv_005ffree-41"><code>cv_free</code></a>: <a href="#Value-Conversion">Value Conversion</a></li>
<li><a href="#index-data-types-112">data types</a>: <a href="#Types">Types</a></li>
<li><a href="#index-database_002c-unit_002c-obtaining-predefined-6">database, unit, obtaining predefined</a>: <a href="#Obtaining">Obtaining</a></li>
<li><a href="#index-database_002c-units-111">database, units</a>: <a href="#Database">Database</a></li>
<li><a href="#index-error-handling-97">error handling</a>: <a href="#Errors">Errors</a></li>
<li><a href="#index-error_002dmessages-104">error-messages</a>: <a href="#Messages">Messages</a></li>
<li><a href="#index-examples_002c-unit-specification-49">examples, unit specification</a>: <a href="#Examples">Examples</a></li>
<li><a href="#index-formatting-a-unit-into-a-string-52">formatting a unit into a string</a>: <a href="#Formatting">Formatting</a></li>
<li><a href="#index-getting-a-unit-by-its-name-14">getting a unit by its name</a>: <a href="#Extracting">Extracting</a></li>
<li><a href="#index-getting-a-unit-by-its-symbol-17">getting a unit by its symbol</a>: <a href="#Extracting">Extracting</a></li>
<li><a href="#index-grammar_002c-unit-51">grammar, unit</a>: <a href="#Grammar">Grammar</a></li>
<li><a href="#index-mapping-identifiers-80">mapping identifiers</a>: <a href="#Mapping">Mapping</a></li>
<li><a href="#index-mapping-units-79">mapping units</a>: <a href="#Mapping">Mapping</a></li>
<li><a href="#index-messages_002c-error-103">messages, error</a>: <a href="#Messages">Messages</a></li>
<li><a href="#index-module-status-99">module status</a>: <a href="#Status">Status</a></li>
<li><a href="#index-names-82">names</a>: <a href="#Names">Names</a></li>
<li><a href="#index-operations_002c-unit-57">operations, unit</a>: <a href="#Operations">Operations</a></li>
<li><a href="#index-parsing-a-string-into-a-unit-42">parsing a string into a unit</a>: <a href="#Parsing">Parsing</a></li>
<li><a href="#index-prefixes_002c-adding-to-a-unit_002dsystem-26">prefixes, adding to a unit-system</a>: <a href="#Prefixes">Prefixes</a></li>
<li><a href="#index-status-of-last-operation-98">status of last operation</a>: <a href="#Status">Status</a></li>
<li><a href="#index-string_002c-formatting-a-unit-into-a-54">string, formatting a unit into a</a>: <a href="#Formatting">Formatting</a></li>
<li><a href="#index-string_002c-parsing-into-a-unit-43">string, parsing into a unit</a>: <a href="#Parsing">Parsing</a></li>
<li><a href="#index-symbols-87">symbols</a>: <a href="#Symbols">Symbols</a></li>
<li><a href="#index-synopsis-1">synopsis</a>: <a href="#Synopsis">Synopsis</a></li>
<li><a href="#index-syntax_002c-unit-47">syntax, unit</a>: <a href="#Syntax">Syntax</a></li>
<li><a href="#index-system-of-units-3">system of units</a>: <a href="#Unit_002dSystems">Unit-Systems</a></li>
<li><a href="#index-time_002c-handling-of-92">time, handling of</a>: <a href="#Time">Time</a></li>
<li><a href="#index-types_002c-data-113">types, data</a>: <a href="#Types">Types</a></li>
<li><a href="#index-unary-unit-operations-58">unary unit operations</a>: <a href="#Unary">Unary</a></li>
<li><a href="#index-unit-conversion-34">unit conversion</a>: <a href="#Value-Conversion">Value Conversion</a></li>
<li><a href="#index-unit-database_002c-obtaining-predefined-7">unit database, obtaining predefined</a>: <a href="#Obtaining">Obtaining</a></li>
<li><a href="#index-unit-grammar-50">unit grammar</a>: <a href="#Grammar">Grammar</a></li>
<li><a href="#index-unit-operations-56">unit operations</a>: <a href="#Operations">Operations</a></li>
<li><a href="#index-unit-specification-examples-48">unit specification examples</a>: <a href="#Examples">Examples</a></li>
<li><a href="#index-unit-syntax-46">unit syntax</a>: <a href="#Syntax">Syntax</a></li>
<li><a href="#index-unit_002c-adding-to-a-unit_002dsystem-22">unit, adding to a unit-system</a>: <a href="#Adding">Adding</a></li>
<li><a href="#index-unit_002c-base-4">unit, base</a>: <a href="#Unit_002dSystems">Unit-Systems</a></li>
<li><a href="#index-unit_002c-formatting-into-a-string-53">unit, formatting into a string</a>: <a href="#Formatting">Formatting</a></li>
<li><a href="#index-unit_002c-getting-by-name-15">unit, getting by name</a>: <a href="#Extracting">Extracting</a></li>
<li><a href="#index-unit_002c-getting-by-symbol-18">unit, getting by symbol</a>: <a href="#Extracting">Extracting</a></li>
<li><a href="#index-unit_002dsystem-2">unit-system</a>: <a href="#Unit_002dSystems">Unit-Systems</a></li>
<li><a href="#index-unit_002dsystem_002c-adding-a-unit-to-23">unit-system, adding a unit to</a>: <a href="#Adding">Adding</a></li>
<li><a href="#index-unit_002dsystem_002c-adding-prefixes-to-a-28">unit-system, adding prefixes to a</a>: <a href="#Prefixes">Prefixes</a></li>
<li><a href="#index-unit_002dsystem_002c-obtaining-predefined-8">unit-system, obtaining predefined</a>: <a href="#Obtaining">Obtaining</a></li>
<li><a href="#index-units-database-110">units database</a>: <a href="#Database">Database</a></li>
<li><a href="#index-units_002c-mapping-to-identifiers-81">units, mapping to identifiers</a>: <a href="#Mapping">Mapping</a></li>
<li><a href="#index-units_002c-obtaining-predefined-9">units, obtaining predefined</a>: <a href="#Obtaining">Obtaining</a></li>
<li><a href="#index-ut_005faccept_005fvisitor-72"><code>ut_accept_visitor</code></a>: <a href="#Unary">Unary</a></li>
<li><a href="#index-ut_005fadd_005fname_005fprefix-29"><code>ut_add_name_prefix</code></a>: <a href="#Prefixes">Prefixes</a></li>
<li><a href="#index-ut_005fadd_005fsymbol_005fprefix-30"><code>ut_add_symbol_prefix</code></a>: <a href="#Prefixes">Prefixes</a></li>
<li><a href="#index-ut_005fare_005fconvertible-35"><code>ut_are_convertible</code></a>: <a href="#Value-Conversion">Value Conversion</a></li>
<li><a href="#index-ut_005fclone-71"><code>ut_clone</code></a>: <a href="#Unary">Unary</a></li>
<li><a href="#index-ut_005fcompare-77"><code>ut_compare</code></a>: <a href="#Binary">Binary</a></li>
<li><a href="#index-ut_005fdecode_005ftime-96"><code>ut_decode_time</code></a>: <a href="#Time">Time</a></li>
<li><a href="#index-ut_005fdivide-76"><code>ut_divide</code></a>: <a href="#Binary">Binary</a></li>
<li><a href="#index-ut_005fencode_005fclock-95"><code>ut_encode_clock</code></a>: <a href="#Time">Time</a></li>
<li><a href="#index-ut_005fencode_005fdate-94"><code>ut_encode_date</code></a>: <a href="#Time">Time</a></li>
<li><a href="#index-ut_005fencode_005ftime-93"><code>ut_encode_time</code></a>: <a href="#Time">Time</a></li>
<li><a href="#index-ut_005fencoding-114"><code>ut_encoding</code></a>: <a href="#Types">Types</a></li>
<li><a href="#index-ut_005ferror_005fmessage_005fhandler-109"><code>ut_error_message_handler</code></a>: <a href="#Messages">Messages</a></li>
<li><a href="#index-ut_005fformat-55"><code>ut_format</code></a>: <a href="#Formatting">Formatting</a></li>
<li><a href="#index-ut_005ffree-59"><code>ut_free</code></a>: <a href="#Unary">Unary</a></li>
<li><a href="#index-ut_005ffree_005fsystem-31"><code>ut_free_system</code></a>: <a href="#Misc">Misc</a></li>
<li><a href="#index-ut_005fget_005fconverter-36"><code>ut_get_converter</code></a>: <a href="#Value-Conversion">Value Conversion</a></li>
<li><a href="#index-ut_005fget_005fdimensionless_005funit_005fone-20"><code>ut_get_dimensionless_unit_one</code></a>: <a href="#Extracting">Extracting</a></li>
<li><a href="#index-ut_005fget_005fname-67"><code>ut_get_name</code></a>: <a href="#Unary">Unary</a></li>
<li><a href="#index-ut_005fget_005fpath_005fxml-11"><code>ut_get_path_xml</code></a>: <a href="#Obtaining">Obtaining</a></li>
<li><a href="#index-ut_005fget_005fstatus-100"><code>ut_get_status</code></a>: <a href="#Status">Status</a></li>
<li><a href="#index-ut_005fget_005fsymbol-68"><code>ut_get_symbol</code></a>: <a href="#Unary">Unary</a></li>
<li><a href="#index-ut_005fget_005fsystem-69"><code>ut_get_system</code></a>: <a href="#Unary">Unary</a></li>
<li><a href="#index-ut_005fget_005funit_005fby_005fname-16"><code>ut_get_unit_by_name</code></a>: <a href="#Extracting">Extracting</a></li>
<li><a href="#index-ut_005fget_005funit_005fby_005fsymbol-19"><code>ut_get_unit_by_symbol</code></a>: <a href="#Extracting">Extracting</a></li>
<li><a href="#index-ut_005fhandle_005ferror_005fmessage-105"><code>ut_handle_error_message</code></a>: <a href="#Messages">Messages</a></li>
<li><a href="#index-ut_005fignore-108"><code>ut_ignore</code></a>: <a href="#Messages">Messages</a></li>
<li><a href="#index-ut_005finvert-63"><code>ut_invert</code></a>: <a href="#Unary">Unary</a></li>
<li><a href="#index-ut_005fis_005fdimensionless-70"><code>ut_is_dimensionless</code></a>: <a href="#Unary">Unary</a></li>
<li><a href="#index-ut_005flog-66"><code>ut_log</code></a>: <a href="#Unary">Unary</a></li>
<li><a href="#index-ut_005fmap_005fname_005fto_005funit-83"><code>ut_map_name_to_unit</code></a>: <a href="#Names">Names</a></li>
<li><a href="#index-ut_005fmap_005fsymbol_005fto_005funit-88"><code>ut_map_symbol_to_unit</code></a>: <a href="#Symbols">Symbols</a></li>
<li><a href="#index-ut_005fmap_005funit_005fto_005fname-85"><code>ut_map_unit_to_name</code></a>: <a href="#Names">Names</a></li>
<li><a href="#index-ut_005fmap_005funit_005fto_005fsymbol-90"><code>ut_map_unit_to_symbol</code></a>: <a href="#Symbols">Symbols</a></li>
<li><a href="#index-ut_005fmultiply-75"><code>ut_multiply</code></a>: <a href="#Binary">Binary</a></li>
<li><a href="#index-ut_005fnew_005fbase_005funit-24"><code>ut_new_base_unit</code></a>: <a href="#Adding">Adding</a></li>
<li><a href="#index-ut_005fnew_005fdimensionless_005funit-25"><code>ut_new_dimensionless_unit</code></a>: <a href="#Adding">Adding</a></li>
<li><a href="#index-ut_005fnew_005fsystem-13"><code>ut_new_system</code></a>: <a href="#Obtaining">Obtaining</a></li>
<li><a href="#index-ut_005foffset-61"><code>ut_offset</code></a>: <a href="#Unary">Unary</a></li>
<li><a href="#index-ut_005foffset_005fby_005ftime-62"><code>ut_offset_by_time</code></a>: <a href="#Unary">Unary</a></li>
<li><a href="#index-ut_005fparse-44"><code>ut_parse</code></a>: <a href="#Parsing">Parsing</a></li>
<li><a href="#index-ut_005fraise-64"><code>ut_raise</code></a>: <a href="#Unary">Unary</a></li>
<li><a href="#index-ut_005fread_005fxml-12"><code>ut_read_xml</code></a>: <a href="#Obtaining">Obtaining</a></li>
<li><a href="#index-g_t_0040code_007but_005fread_005fxml_0028_0029_007d_002c-discussion-of-10"><code>ut_read_xml()</code>, discussion of</a>: <a href="#Obtaining">Obtaining</a></li>
<li><a href="#index-ut_005froot-65"><code>ut_root</code></a>: <a href="#Unary">Unary</a></li>
<li><a href="#index-ut_005fsame_005fsystem-78"><code>ut_same_system</code></a>: <a href="#Binary">Binary</a></li>
<li><a href="#index-ut_005fscale-60"><code>ut_scale</code></a>: <a href="#Unary">Unary</a></li>
<li><a href="#index-ut_005fset_005ferror_005fmessage_005fhandler-106"><code>ut_set_error_message_handler</code></a>: <a href="#Messages">Messages</a></li>
<li><a href="#index-ut_005fset_005fsecond-32"><code>ut_set_second</code></a>: <a href="#Misc">Misc</a></li>
<li><a href="#index-ut_005fset_005fstatus-101"><code>ut_set_status</code></a>: <a href="#Status">Status</a></li>
<li><a href="#index-ut_005fstatus-102"><code>ut_status</code></a>: <a href="#Status">Status</a></li>
<li><a href="#index-ut_005ftrim-45"><code>ut_trim</code></a>: <a href="#Parsing">Parsing</a></li>
<li><a href="#index-ut_005funmap_005fname_005fto_005funit-84"><code>ut_unmap_name_to_unit</code></a>: <a href="#Names">Names</a></li>
<li><a href="#index-ut_005funmap_005fsymbol_005fto_005funit-89"><code>ut_unmap_symbol_to_unit</code></a>: <a href="#Symbols">Symbols</a></li>
<li><a href="#index-ut_005funmap_005funit_005fto_005fname-86"><code>ut_unmap_unit_to_name</code></a>: <a href="#Names">Names</a></li>
<li><a href="#index-ut_005funmap_005funit_005fto_005fsymbol-91"><code>ut_unmap_unit_to_symbol</code></a>: <a href="#Symbols">Symbols</a></li>
<li><a href="#index-ut_005fvisitor-73"><code>ut_visitor</code></a>: <a href="#Unary">Unary</a></li>
<li><a href="#index-ut_005fwrite_005fto_005fstderr-107"><code>ut_write_to_stderr</code></a>: <a href="#Messages">Messages</a></li>
</ul></body></html>
|