<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>ICU 4.4: ulocdata.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.6.1 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<img id="MSearchSelect" src="search/search.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</div>
</li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>ulocdata.h File Reference</h1>
<p>C API: Provides access to locale data.
<a href="#_details">More...</a></p>
<code>#include "<a class="el" href="ures_8h_source.html">unicode/ures.h</a>"</code><br/>
<code>#include "<a class="el" href="uloc_8h_source.html">unicode/uloc.h</a>"</code><br/>
<code>#include "<a class="el" href="uset_8h_source.html">unicode/uset.h</a>"</code><br/>
<code>#include "<a class="el" href="localpointer_8h_source.html">unicode/localpointer.h</a>"</code><br/>
<p><a href="ulocdata_8h_source.html">Go to the source code of this file.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="ulocdata_8h.html#a11b0b31a90a3f88fe6cf285f549365ac">ULocaleData</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ulocdata_8h.html#a11b0b31a90a3f88fe6cf285f549365ac">ULocaleData</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A locale data object. <a href="#a11b0b31a90a3f88fe6cf285f549365ac"></a><br/></td></tr>
<tr><td colspan="2"><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="ulocdata_8h.html#ab4e9cbcc23972244e20d4d6f599fc8d3">ULocaleDataExemplarSetType</a> { <b>ULOCDATA_ES_STANDARD</b> = 0,
<b>ULOCDATA_ES_AUXILIARY</b> = 1,
<b>ULOCDATA_ES_COUNT</b> = 2
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>The possible types of exemplar character sets. </p>
<a href="ulocdata_8h.html#ab4e9cbcc23972244e20d4d6f599fc8d3">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="ulocdata_8h.html#a2de6cb7db4865c46fd28fdd1d31fbfdf">ULocaleDataDelimiterType</a> { <br/>
<b>ULOCDATA_QUOTATION_START</b> = 0,
<b>ULOCDATA_QUOTATION_END</b> = 1,
<b>ULOCDATA_ALT_QUOTATION_START</b> = 2,
<b>ULOCDATA_ALT_QUOTATION_END</b> = 3,
<br/>
<b>ULOCDATA_DELIMITER_COUNT</b> = 4
<br/>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>The possible types of delimiters. </p>
<a href="ulocdata_8h.html#a2de6cb7db4865c46fd28fdd1d31fbfdf">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="ulocdata_8h.html#a4e0915410e83194840c04a67909c9690">UMeasurementSystem</a> { <b>UMS_SI</b>,
<a class="el" href="ulocdata_8h.html#a4e0915410e83194840c04a67909c9690a8c9afbdc89682e1e9f8da106a266b90b">UMS_US</a>,
<a class="el" href="ulocdata_8h.html#a4e0915410e83194840c04a67909c9690ad1d78d4e783b7f47e43d3caf52870d5f">UMS_LIMIT</a>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Enumeration for representing the measurement systems. </p>
<a href="ulocdata_8h.html#a4e0915410e83194840c04a67909c9690">More...</a><br/></td></tr>
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="ulocdata_8h.html#a11b0b31a90a3f88fe6cf285f549365ac">ULocaleData</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="ulocdata_8h.html#aea69205230937829cc6c7bea014be082">ulocdata_open</a> (const char *localeID, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Opens a locale data object for the given locale. <a href="#aea69205230937829cc6c7bea014be082"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ulocdata_8h.html#a0a6caec3e82bfb44fac63f2001d212e3">ulocdata_close</a> (<a class="el" href="ulocdata_8h.html#a11b0b31a90a3f88fe6cf285f549365ac">ULocaleData</a> *uld)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Closes a locale data object. <a href="#a0a6caec3e82bfb44fac63f2001d212e3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ulocdata_8h.html#a981dc2b89f2762c0a4bfb915e6eed7c1">ulocdata_setNoSubstitute</a> (<a class="el" href="ulocdata_8h.html#a11b0b31a90a3f88fe6cf285f549365ac">ULocaleData</a> *uld, <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> setting)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the "no Substitute" attribute of the locale data object. <a href="#a981dc2b89f2762c0a4bfb915e6eed7c1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ulocdata_8h.html#abd240a9bedda031ff8427adb1595d881">ulocdata_getNoSubstitute</a> (<a class="el" href="ulocdata_8h.html#a11b0b31a90a3f88fe6cf285f549365ac">ULocaleData</a> *uld)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the current "no Substitute" value of the locale data object. <a href="#abd240a9bedda031ff8427adb1595d881"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="uset_8h.html#adce3fef7c15d7c78196bf977ac96ec9c">USet</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="ulocdata_8h.html#ae8930500be4571878f16aef1cf731cc1">ulocdata_getExemplarSet</a> (<a class="el" href="ulocdata_8h.html#a11b0b31a90a3f88fe6cf285f549365ac">ULocaleData</a> *uld, <a class="el" href="uset_8h.html#adce3fef7c15d7c78196bf977ac96ec9c">USet</a> *fillIn, uint32_t options, <a class="el" href="ulocdata_8h.html#ab4e9cbcc23972244e20d4d6f599fc8d3">ULocaleDataExemplarSetType</a> extype, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the set of exemplar characters for a locale. <a href="#ae8930500be4571878f16aef1cf731cc1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ulocdata_8h.html#aed210881dffb9872c379b50c54681495">ulocdata_getDelimiter</a> (<a class="el" href="ulocdata_8h.html#a11b0b31a90a3f88fe6cf285f549365ac">ULocaleData</a> *uld, <a class="el" href="ulocdata_8h.html#a2de6cb7db4865c46fd28fdd1d31fbfdf">ULocaleDataDelimiterType</a> type, <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *result, int32_t resultLength, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns one of the delimiter strings associated with a locale. <a href="#aed210881dffb9872c379b50c54681495"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="ulocdata_8h.html#a4e0915410e83194840c04a67909c9690">UMeasurementSystem</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ulocdata_8h.html#a7abb69df19b1080b76fcc26ec0ea0978">ulocdata_getMeasurementSystem</a> (const char *localeID, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the measurement system used in the locale specified by the localeID. <a href="#a7abb69df19b1080b76fcc26ec0ea0978"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ulocdata_8h.html#ac15cb36151248a1e0376380dea8bd722">ulocdata_getPaperSize</a> (const char *localeID, int32_t *height, int32_t *width, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the element gives the normal business letter size, and customary units. <a href="#ac15cb36151248a1e0376380dea8bd722"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ulocdata_8h.html#af50ca74fc2c0a249cd280f47c217dc88">ulocdata_getCLDRVersion</a> (<a class="el" href="uversion_8h.html#a61caef96ba86d8e86a4031925ea44e94">UVersionInfo</a> versionArray, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the current CLDR version used by the library. <a href="#af50ca74fc2c0a249cd280f47c217dc88"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ulocdata_8h.html#af34138299c7b30537e410b284db88c8e">ulocdata_getLocaleDisplayPattern</a> (<a class="el" href="ulocdata_8h.html#a11b0b31a90a3f88fe6cf285f549365ac">ULocaleData</a> *uld, <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *pattern, int32_t patternCapacity, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns locale display pattern associated with a locale. <a href="#af34138299c7b30537e410b284db88c8e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ulocdata_8h.html#a277f2bcec4a598b3c55af715ea9c06b5">ulocdata_getLocaleSeparator</a> (<a class="el" href="ulocdata_8h.html#a11b0b31a90a3f88fe6cf285f549365ac">ULocaleData</a> *uld, <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *separator, int32_t separatorCapacity, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns locale separator associated with a locale. <a href="#a277f2bcec4a598b3c55af715ea9c06b5"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>C API: Provides access to locale data. </p>
<p>Definition in file <a class="el" href="ulocdata_8h_source.html">ulocdata.h</a>.</p>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="a11b0b31a90a3f88fe6cf285f549365ac"></a><!-- doxytag: member="ulocdata.h::ULocaleData" ref="a11b0b31a90a3f88fe6cf285f549365ac" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="ulocdata_8h.html#a11b0b31a90a3f88fe6cf285f549365ac">ULocaleData</a> <a class="el" href="ulocdata_8h.html#a11b0b31a90a3f88fe6cf285f549365ac">ULocaleData</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A locale data object. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003709">Stable:</a></b></dt><dd>ICU 3.6 </dd></dl>
<p>Definition at line <a class="el" href="ulocdata_8h_source.html#l00034">34</a> of file <a class="el" href="ulocdata_8h_source.html">ulocdata.h</a>.</p>
</div>
</div>
<hr/><h2>Enumeration Type Documentation</h2>
<a class="anchor" id="a2de6cb7db4865c46fd28fdd1d31fbfdf"></a><!-- doxytag: member="ulocdata.h::ULocaleDataDelimiterType" ref="a2de6cb7db4865c46fd28fdd1d31fbfdf" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="ulocdata_8h.html#a2de6cb7db4865c46fd28fdd1d31fbfdf">ULocaleDataDelimiterType</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The possible types of delimiters. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003711">Stable:</a></b></dt><dd>ICU 3.4 </dd></dl>
<p>Definition at line <a class="el" href="ulocdata_8h_source.html#l00050">50</a> of file <a class="el" href="ulocdata_8h_source.html">ulocdata.h</a>.</p>
</div>
</div>
<a class="anchor" id="ab4e9cbcc23972244e20d4d6f599fc8d3"></a><!-- doxytag: member="ulocdata.h::ULocaleDataExemplarSetType" ref="ab4e9cbcc23972244e20d4d6f599fc8d3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="ulocdata_8h.html#ab4e9cbcc23972244e20d4d6f599fc8d3">ULocaleDataExemplarSetType</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The possible types of exemplar character sets. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003710">Stable:</a></b></dt><dd>ICU 3.4 </dd></dl>
<p>Definition at line <a class="el" href="ulocdata_8h_source.html#l00041">41</a> of file <a class="el" href="ulocdata_8h_source.html">ulocdata.h</a>.</p>
</div>
</div>
<a class="anchor" id="a4e0915410e83194840c04a67909c9690"></a><!-- doxytag: member="ulocdata.h::UMeasurementSystem" ref="a4e0915410e83194840c04a67909c9690" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="ulocdata_8h.html#a4e0915410e83194840c04a67909c9690">UMeasurementSystem</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Enumeration for representing the measurement systems. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003718">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a4e0915410e83194840c04a67909c9690a8c9afbdc89682e1e9f8da106a266b90b"></a><!-- doxytag: member="UMS_US" ref="a4e0915410e83194840c04a67909c9690a8c9afbdc89682e1e9f8da106a266b90b" args="" -->UMS_US</em> </td><td>
<p>Measurement system specified by SI otherwise known as Metric system. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a4e0915410e83194840c04a67909c9690ad1d78d4e783b7f47e43d3caf52870d5f"></a><!-- doxytag: member="UMS_LIMIT" ref="a4e0915410e83194840c04a67909c9690ad1d78d4e783b7f47e43d3caf52870d5f" args="" -->UMS_LIMIT</em> </td><td>
<p>Measurement system followed in the United States of America. </p>
</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="ulocdata_8h_source.html#l00174">174</a> of file <a class="el" href="ulocdata_8h_source.html">ulocdata.h</a>.</p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a0a6caec3e82bfb44fac63f2001d212e3"></a><!-- doxytag: member="ulocdata.h::ulocdata_close" ref="a0a6caec3e82bfb44fac63f2001d212e3" args="(ULocaleData *uld)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ulocdata_close </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ulocdata_8h.html#a11b0b31a90a3f88fe6cf285f549365ac">ULocaleData</a> * </td>
<td class="paramname"> <em>uld</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Closes a locale data object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>uld</em> </td><td>The locale data object to close </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003713">Stable:</a></b></dt><dd>ICU 3.4 </dd></dl>
</div>
</div>
<a class="anchor" id="af50ca74fc2c0a249cd280f47c217dc88"></a><!-- doxytag: member="ulocdata.h::ulocdata_getCLDRVersion" ref="af50ca74fc2c0a249cd280f47c217dc88" args="(UVersionInfo versionArray, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ulocdata_getCLDRVersion </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uversion_8h.html#a61caef96ba86d8e86a4031925ea44e94">UVersionInfo</a> </td>
<td class="paramname"> <em>versionArray</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the current CLDR version used by the library. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>versionArray</em> </td><td>fillin that will recieve the version number </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>error code - could be U_MISSING_RESOURCE_ERROR if the version was not found. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003721">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>
</div>
</div>
<a class="anchor" id="aed210881dffb9872c379b50c54681495"></a><!-- doxytag: member="ulocdata.h::ulocdata_getDelimiter" ref="aed210881dffb9872c379b50c54681495" args="(ULocaleData *uld, ULocaleDataDelimiterType type, UChar *result, int32_t resultLength, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ulocdata_getDelimiter </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ulocdata_8h.html#a11b0b31a90a3f88fe6cf285f549365ac">ULocaleData</a> * </td>
<td class="paramname"> <em>uld</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="ulocdata_8h.html#a2de6cb7db4865c46fd28fdd1d31fbfdf">ULocaleDataDelimiterType</a> </td>
<td class="paramname"> <em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"> <em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>resultLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns one of the delimiter strings associated with a locale. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>uld</em> </td><td>Pointer to the locale data object from which the delimiter string is to be retrieved. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>the type of delimiter to be retrieved. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>result</em> </td><td>A pointer to a buffer to receive the result. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>resultLength</em> </td><td>The maximum size of result. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Pointer to an error code value </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>int32_t The total buffer size needed; if greater than resultLength, the output was truncated. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003717">Stable:</a></b></dt><dd>ICU 3.4 </dd></dl>
</div>
</div>
<a class="anchor" id="ae8930500be4571878f16aef1cf731cc1"></a><!-- doxytag: member="ulocdata.h::ulocdata_getExemplarSet" ref="ae8930500be4571878f16aef1cf731cc1" args="(ULocaleData *uld, USet *fillIn, uint32_t options, ULocaleDataExemplarSetType extype, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="uset_8h.html#adce3fef7c15d7c78196bf977ac96ec9c">USet</a>* ulocdata_getExemplarSet </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ulocdata_8h.html#a11b0b31a90a3f88fe6cf285f549365ac">ULocaleData</a> * </td>
<td class="paramname"> <em>uld</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="uset_8h.html#adce3fef7c15d7c78196bf977ac96ec9c">USet</a> * </td>
<td class="paramname"> <em>fillIn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"> <em>options</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="ulocdata_8h.html#ab4e9cbcc23972244e20d4d6f599fc8d3">ULocaleDataExemplarSetType</a> </td>
<td class="paramname"> <em>extype</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the set of exemplar characters for a locale. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>uld</em> </td><td>Pointer to the locale data object from which the exemplar character set is to be retrieved. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>fillIn</em> </td><td>Pointer to a USet object to receive the exemplar character set for the given locale. Previous contents of fillIn are lost. <em>If fillIn is NULL, then a new USet is created and returned. The caller owns the result and must dispose of it by calling uset_close.</em> </td></tr>
<tr><td valign="top"></td><td valign="top"><em>options</em> </td><td>Bitmask for options to apply to the exemplar pattern. Specify zero to retrieve the exemplar set as it is defined in the locale data. Specify USET_CASE_INSENSITIVE to retrieve a case-folded exemplar set. See uset_applyPattern for a complete list of valid options. The USET_IGNORE_SPACE bit is always set, regardless of the value of 'options'. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>extype</em> </td><td>Specifies the type of exemplar set to be retrieved. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Pointer to an input-output error code value; must not be NULL. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>USet* Either fillIn, or if fillIn is NULL, a pointer to a newly-allocated USet that the user must close. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003716">Stable:</a></b></dt><dd>ICU 3.4 </dd></dl>
</div>
</div>
<a class="anchor" id="af34138299c7b30537e410b284db88c8e"></a><!-- doxytag: member="ulocdata.h::ulocdata_getLocaleDisplayPattern" ref="af34138299c7b30537e410b284db88c8e" args="(ULocaleData *uld, UChar *pattern, int32_t patternCapacity, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ulocdata_getLocaleDisplayPattern </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ulocdata_8h.html#a11b0b31a90a3f88fe6cf285f549365ac">ULocaleData</a> * </td>
<td class="paramname"> <em>uld</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"> <em>pattern</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>patternCapacity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns locale display pattern associated with a locale. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>uld</em> </td><td>Pointer to the locale data object from which the exemplar character set is to be retrieved. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pattern</em> </td><td>locale display pattern for locale. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>patternCapacity</em> </td><td>the size of the buffer to store the locale display pattern with. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Must be a valid pointer to an error code value, which must not indicate a failure before the function call. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the actual buffer size needed for localeDisplayPattern. If it's greater than patternCapacity, the returned pattern will be truncated.</dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003722">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>
</div>
</div>
<a class="anchor" id="a277f2bcec4a598b3c55af715ea9c06b5"></a><!-- doxytag: member="ulocdata.h::ulocdata_getLocaleSeparator" ref="a277f2bcec4a598b3c55af715ea9c06b5" args="(ULocaleData *uld, UChar *separator, int32_t separatorCapacity, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ulocdata_getLocaleSeparator </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ulocdata_8h.html#a11b0b31a90a3f88fe6cf285f549365ac">ULocaleData</a> * </td>
<td class="paramname"> <em>uld</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"> <em>separator</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>separatorCapacity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns locale separator associated with a locale. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>uld</em> </td><td>Pointer to the locale data object from which the exemplar character set is to be retrieved. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>separator</em> </td><td>locale separator for locale. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>separatorCapacity</em> </td><td>the size of the buffer to store the locale separator with. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Must be a valid pointer to an error code value, which must not indicate a failure before the function call. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the actual buffer size needed for localeSeparator. If it's greater than separatorCapacity, the returned separator will be truncated.</dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003723">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>
</div>
</div>
<a class="anchor" id="a7abb69df19b1080b76fcc26ec0ea0978"></a><!-- doxytag: member="ulocdata.h::ulocdata_getMeasurementSystem" ref="a7abb69df19b1080b76fcc26ec0ea0978" args="(const char *localeID, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ulocdata_8h.html#a4e0915410e83194840c04a67909c9690">UMeasurementSystem</a> ulocdata_getMeasurementSystem </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>localeID</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the measurement system used in the locale specified by the localeID. </p>
<p>Please note that this API will change in ICU 3.6 and will use an ulocdata object.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>localeID</em> </td><td>The id of the locale for which the measurement system to be retrieved. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Must be a valid pointer to an error code value, which must not indicate a failure before the function call. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>UMeasurementSystem the measurement system used in the locale. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003719">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
</div>
</div>
<a class="anchor" id="abd240a9bedda031ff8427adb1595d881"></a><!-- doxytag: member="ulocdata.h::ulocdata_getNoSubstitute" ref="abd240a9bedda031ff8427adb1595d881" args="(ULocaleData *uld)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> ulocdata_getNoSubstitute </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ulocdata_8h.html#a11b0b31a90a3f88fe6cf285f549365ac">ULocaleData</a> * </td>
<td class="paramname"> <em>uld</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieves the current "no Substitute" value of the locale data object. </p>
<p>If true, then any methods associated with the locale data object will return null when there is no data available for that method, given the locale ID supplied to <a class="el" href="ulocdata_8h.html#aea69205230937829cc6c7bea014be082" title="Opens a locale data object for the given locale.">ulocdata_open()</a>.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>uld</em> </td><td>Pointer to the The locale data object to set. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>UBool Value of the "no substitute" attribute. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003715">Stable:</a></b></dt><dd>ICU 3.4 </dd></dl>
</div>
</div>
<a class="anchor" id="ac15cb36151248a1e0376380dea8bd722"></a><!-- doxytag: member="ulocdata.h::ulocdata_getPaperSize" ref="ac15cb36151248a1e0376380dea8bd722" args="(const char *localeID, int32_t *height, int32_t *width, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ulocdata_getPaperSize </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>localeID</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t * </td>
<td class="paramname"> <em>height</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t * </td>
<td class="paramname"> <em>width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the element gives the normal business letter size, and customary units. </p>
<p>The units for the numbers are always in <em>milli-meters</em>. For US since 8.5 and 11 do not yeild an integral value when converted to milli-meters, the values are rounded off. So for A4 size paper the height and width are 297 mm and 210 mm repectively, and for US letter size the height and width are 279 mm and 216 mm respectively. Please note that this API will change in ICU 3.6 and will use an ulocdata object.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>localeID</em> </td><td>The id of the locale for which the paper size information to be retrieved. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>height</em> </td><td>A pointer to int to recieve the height information. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>width</em> </td><td>A pointer to int to recieve the width information. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Must be a valid pointer to an error code value, which must not indicate a failure before the function call. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003720">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
</div>
</div>
<a class="anchor" id="aea69205230937829cc6c7bea014be082"></a><!-- doxytag: member="ulocdata.h::ulocdata_open" ref="aea69205230937829cc6c7bea014be082" args="(const char *localeID, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ulocdata_8h.html#a11b0b31a90a3f88fe6cf285f549365ac">ULocaleData</a>* ulocdata_open </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>localeID</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Opens a locale data object for the given locale. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>localeID</em> </td><td>Specifies the locale associated with this locale data object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Pointer to error status code. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003712">Stable:</a></b></dt><dd>ICU 3.4 </dd></dl>
</div>
</div>
<a class="anchor" id="a981dc2b89f2762c0a4bfb915e6eed7c1"></a><!-- doxytag: member="ulocdata.h::ulocdata_setNoSubstitute" ref="a981dc2b89f2762c0a4bfb915e6eed7c1" args="(ULocaleData *uld, UBool setting)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ulocdata_setNoSubstitute </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ulocdata_8h.html#a11b0b31a90a3f88fe6cf285f549365ac">ULocaleData</a> * </td>
<td class="paramname"> <em>uld</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td>
<td class="paramname"> <em>setting</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the "no Substitute" attribute of the locale data object. </p>
<p>If true, then any methods associated with the locale data object will return null when there is no data available for that method, given the locale ID supplied to <a class="el" href="ulocdata_8h.html#aea69205230937829cc6c7bea014be082" title="Opens a locale data object for the given locale.">ulocdata_open()</a>.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>uld</em> </td><td>The locale data object to set. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>setting</em> </td><td>Value of the "no substitute" attribute. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003714">Stable:</a></b></dt><dd>ICU 3.4 </dd></dl>
</div>
</div>
</div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 16 Mar 2010 for ICU 4.4 by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
f51238514e2abe817779ad2fe01b0759
>
files
>
727
