<!-- 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: ures.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>ures.h File Reference</h1>
<p>C API: Resource Bundle.
<a href="#_details">More...</a></p>
<code>#include "<a class="el" href="utypes_8h_source.html">unicode/utypes.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="localpointer_8h_source.html">unicode/localpointer.h</a>"</code><br/>
<p><a href="ures_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="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a></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="ures_8h.html#a3f1197bf41a6228c38e3fddb58bf96fb">UResType</a> { <br/>
<a class="el" href="ures_8h.html#a3f1197bf41a6228c38e3fddb58bf96fbab73cbea3085f99defd0538171d343f03">URES_NONE</a> = -1,
<a class="el" href="ures_8h.html#a3f1197bf41a6228c38e3fddb58bf96fbac4db2a063c1c73cc363b0e21891bc480">URES_STRING</a> = 0,
<a class="el" href="ures_8h.html#a3f1197bf41a6228c38e3fddb58bf96fba7220aa0da13f4d7a1e62a1856026c271">URES_BINARY</a> = 1,
<a class="el" href="ures_8h.html#a3f1197bf41a6228c38e3fddb58bf96fba2cfd36db6917951f177723df3a58e2b4">URES_TABLE</a> = 2,
<br/>
<a class="el" href="ures_8h.html#a3f1197bf41a6228c38e3fddb58bf96fba6890eb4a8669521aace76b4c854d304e">URES_ALIAS</a> = 3,
<a class="el" href="ures_8h.html#a3f1197bf41a6228c38e3fddb58bf96fbac71be9c52845b8404c84610320b550ba">URES_INT</a> = 7,
<a class="el" href="ures_8h.html#a3f1197bf41a6228c38e3fddb58bf96fbaa2e7a87c3c144d7df2abd973b86512ca">URES_ARRAY</a> = 8,
<a class="el" href="ures_8h.html#a3f1197bf41a6228c38e3fddb58bf96fba6c6b406d49cebed764c515d49dcf73b3">URES_INT_VECTOR</a> = 14,
<br/>
<a class="el" href="ures_8h.html#a3f1197bf41a6228c38e3fddb58bf96fba78e3758a381e62148cc4b0438f3c0777">RES_NONE</a> = URES_NONE,
<a class="el" href="ures_8h.html#a3f1197bf41a6228c38e3fddb58bf96fbad6c0349cb0484769c040d660de1c7445">RES_STRING</a> = URES_STRING,
<a class="el" href="ures_8h.html#a3f1197bf41a6228c38e3fddb58bf96fba2ad74e7a8c734f374bf8b786617fb212">RES_BINARY</a> = URES_BINARY,
<a class="el" href="ures_8h.html#a3f1197bf41a6228c38e3fddb58bf96fbac93b5478e79d51b10747d617765069af">RES_TABLE</a> = URES_TABLE,
<br/>
<a class="el" href="ures_8h.html#a3f1197bf41a6228c38e3fddb58bf96fbae4f137b23dcc82d1b7c5b19d5453b3a1">RES_ALIAS</a> = URES_ALIAS,
<a class="el" href="ures_8h.html#a3f1197bf41a6228c38e3fddb58bf96fbaf1f3ced984a5ff062dae837b00769e9f">RES_INT</a> = URES_INT,
<a class="el" href="ures_8h.html#a3f1197bf41a6228c38e3fddb58bf96fba2eeb630d6cacdd4cdeae5ae05edfc8bd">RES_ARRAY</a> = URES_ARRAY,
<a class="el" href="ures_8h.html#a3f1197bf41a6228c38e3fddb58bf96fbac5f51dba6417cd88750d7fb32c1cfb7e">RES_INT_VECTOR</a> = URES_INT_VECTOR,
<br/>
<a class="el" href="ures_8h.html#a3f1197bf41a6228c38e3fddb58bf96fbabb8f79bd6e07400f6870fe51ae24fcef">RES_RESERVED</a> = 15,
<b>URES_LIMIT</b> = 16
<br/>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Numeric constants for types of resource items. </p>
<a href="ures_8h.html#a3f1197bf41a6228c38e3fddb58bf96fb">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="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="ures_8h.html#ac4d72fc9f7cc63a05f646cabee4be167">ures_open</a> (const char *packageName, const char *locale, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Opens a UResourceBundle, from which users can extract strings by using their corresponding keys. <a href="#ac4d72fc9f7cc63a05f646cabee4be167"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="ures_8h.html#a261fcbb263bbe48b13d2b3e2fc2470a0">ures_openDirect</a> (const char *packageName, const char *locale, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This function does not care what kind of localeID is passed in. <a href="#a261fcbb263bbe48b13d2b3e2fc2470a0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="ures_8h.html#a73d8f9711d915ef1888a7e149f64a9ae">ures_openU</a> (const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *packageName, const char *locale, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Same as <a class="el" href="ures_8h.html#ac4d72fc9f7cc63a05f646cabee4be167" title="Opens a UResourceBundle, from which users can extract strings by using their corresponding...">ures_open()</a> but takes a const UChar *path. <a href="#a73d8f9711d915ef1888a7e149f64a9ae"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ures_8h.html#a09607e48125e46397a843f255640fe2e">ures_countArrayItems</a> (const <a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> *resourceBundle, const char *resourceKey, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *err)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of strings/arrays in resource bundles. <a href="#a09607e48125e46397a843f255640fe2e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ures_8h.html#addb8be0af245c0f745458e7ad925a490">ures_close</a> (<a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> *resourceBundle)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Close a resource bundle, all pointers returned from the various ures_getXXX calls on this particular bundle should be considered invalid henceforth. <a href="#addb8be0af245c0f745458e7ad925a490"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="ures_8h.html#a33679a8207b84dda51bff3e30c04174f">ures_getVersionNumber</a> (const <a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> *resourceBundle)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the version number associated with this <a class="el" href="classResourceBundle.html" title="A class representing a collection of resource information pertaining to a given locale...">ResourceBundle</a> as a string. <a href="#a33679a8207b84dda51bff3e30c04174f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ures_8h.html#a2edd739dcbf0062e0c344b4a4e0a26d2">ures_getVersion</a> (const <a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> *resB, <a class="el" href="uversion_8h.html#a61caef96ba86d8e86a4031925ea44e94">UVersionInfo</a> versionInfo)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the version number associated with this <a class="el" href="classResourceBundle.html" title="A class representing a collection of resource information pertaining to a given locale...">ResourceBundle</a> as an UVersionInfo array. <a href="#a2edd739dcbf0062e0c344b4a4e0a26d2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="ures_8h.html#a82bdc1bb4f0afdb2d263c3589eaa9b62">ures_getLocale</a> (const <a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> *resourceBundle, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the name of the <a class="el" href="classLocale.html" title="A Locale object represents a specific geographical, political, or cultural region...">Locale</a> associated with this <a class="el" href="classResourceBundle.html" title="A class representing a collection of resource information pertaining to a given locale...">ResourceBundle</a>. <a href="#a82bdc1bb4f0afdb2d263c3589eaa9b62"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="ures_8h.html#a39d1e5c7a265c24ebaa684b55a74c0e0">ures_getLocaleByType</a> (const <a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> *resourceBundle, <a class="el" href="uloc_8h.html#adf053345d343f8d82ae080f7a5871f34">ULocDataLocaleType</a> type, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the name of the <a class="el" href="classLocale.html" title="A Locale object represents a specific geographical, political, or cultural region...">Locale</a> associated with this <a class="el" href="classResourceBundle.html" title="A class representing a collection of resource information pertaining to a given locale...">ResourceBundle</a>. <a href="#a39d1e5c7a265c24ebaa684b55a74c0e0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ures_8h.html#a41dc0b7aa46942d3034ffce73adf9aea">ures_openFillIn</a> (<a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> *r, const char *packageName, const char *localeID, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Same as <a class="el" href="ures_8h.html#ac4d72fc9f7cc63a05f646cabee4be167" title="Opens a UResourceBundle, from which users can extract strings by using their corresponding...">ures_open()</a> but uses the fill-in parameter instead of allocating a bundle, if r!=NULL. <a href="#a41dc0b7aa46942d3034ffce73adf9aea"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="ures_8h.html#a088b560881f84521caefc1513efc45af">ures_getString</a> (const <a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> *resourceBundle, int32_t *len, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a string from a string resource type. <a href="#a088b560881f84521caefc1513efc45af"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="ures_8h.html#a1dd8d20a524c70ef8ec9943221f82021">ures_getUTF8String</a> (const <a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> *resB, char *dest, int32_t *length, <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> forceCopy, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a UTF-8 string from a string resource. <a href="#a1dd8d20a524c70ef8ec9943221f82021"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="ures_8h.html#a3d29628c77fb9c5fffa412257aa743cc">ures_getBinary</a> (const <a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> *resourceBundle, int32_t *len, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a binary data from a binary resource. <a href="#a3d29628c77fb9c5fffa412257aa743cc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const int32_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="ures_8h.html#ae89d1bc77281a8a61896f6615cd506ea">ures_getIntVector</a> (const <a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> *resourceBundle, int32_t *len, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a 32 bit integer array from a resource. <a href="#ae89d1bc77281a8a61896f6615cd506ea"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ures_8h.html#aa21170067cf90e1d492b4806f31c6a9c">ures_getUInt</a> (const <a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> *resourceBundle, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns an unsigned integer from a resource. <a href="#aa21170067cf90e1d492b4806f31c6a9c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ures_8h.html#ab718b0e9c6e06a2bbcce9a71e04b185e">ures_getInt</a> (const <a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> *resourceBundle, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a signed integer from a resource. <a href="#ab718b0e9c6e06a2bbcce9a71e04b185e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ures_8h.html#a4eb5d79c3799ee8cfe0cbd96322581bd">ures_getSize</a> (const <a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> *resourceBundle)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the size of a resource. <a href="#a4eb5d79c3799ee8cfe0cbd96322581bd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="ures_8h.html#a3f1197bf41a6228c38e3fddb58bf96fb">UResType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ures_8h.html#a77ac531cd4bdc588efd21b2d9b7e2471">ures_getType</a> (const <a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> *resourceBundle)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the type of a resource. <a href="#a77ac531cd4bdc588efd21b2d9b7e2471"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="ures_8h.html#a9c391e946d5d4bc204c1cc7798de6668">ures_getKey</a> (const <a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> *resourceBundle)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the key associated with a given resource. <a href="#a9c391e946d5d4bc204c1cc7798de6668"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ures_8h.html#ab0755e4d54d950e32acc785cbc46c431">ures_resetIterator</a> (<a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> *resourceBundle)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Resets the internal context of a resource so that iteration starts from the first element. <a href="#ab0755e4d54d950e32acc785cbc46c431"></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="ures_8h.html#a787089fdc0669fe3ec7f5023b628a642">ures_hasNext</a> (const <a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> *resourceBundle)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks whether the given resource has another element to iterate over. <a href="#a787089fdc0669fe3ec7f5023b628a642"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="ures_8h.html#a04ad67a1b8feaca7b817ce51e4878d1d">ures_getNextResource</a> (<a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> *resourceBundle, <a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> *fillIn, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the next resource in a given resource or NULL if there are no more resources to iterate over. <a href="#a04ad67a1b8feaca7b817ce51e4878d1d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="ures_8h.html#ab3c74eb748adde7d83bd8a9ac52bb58e">ures_getNextString</a> (<a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> *resourceBundle, int32_t *len, const char **key, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the next string in a given resource or NULL if there are no more resources to iterate over. <a href="#ab3c74eb748adde7d83bd8a9ac52bb58e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="ures_8h.html#aae9284d2a6a4c8169cc2e7c7d89a29e6">ures_getByIndex</a> (const <a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> *resourceBundle, int32_t indexR, <a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> *fillIn, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the resource in a given resource at the specified index. <a href="#aae9284d2a6a4c8169cc2e7c7d89a29e6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="ures_8h.html#a1ac2f42ee782365ab291f6135e5b0073">ures_getStringByIndex</a> (const <a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> *resourceBundle, int32_t indexS, int32_t *len, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the string in a given resource at the specified index. <a href="#a1ac2f42ee782365ab291f6135e5b0073"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="ures_8h.html#af692a3738524bbf6c30bfa56a2135b5b">ures_getUTF8StringByIndex</a> (const <a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> *resB, int32_t stringIndex, char *dest, int32_t *pLength, <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> forceCopy, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a UTF-8 string from a resource at the specified index. <a href="#af692a3738524bbf6c30bfa56a2135b5b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="ures_8h.html#a9cffc29afd81c60f4a3ce2c8dadf8e98">ures_getByKey</a> (const <a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> *resourceBundle, const char *key, <a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> *fillIn, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a resource in a given resource that has a given key. <a href="#a9cffc29afd81c60f4a3ce2c8dadf8e98"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="ures_8h.html#a59b808cfa2bdd08497219849cdeff140">ures_getStringByKey</a> (const <a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> *resB, const char *key, int32_t *len, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a string in a given resource that has a given key. <a href="#a59b808cfa2bdd08497219849cdeff140"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="ures_8h.html#a7fbb24a527a74807dded377ca0ecd41c">ures_getUTF8StringByKey</a> (const <a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> *resB, const char *key, char *dest, int32_t *pLength, <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> forceCopy, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a UTF-8 string from a resource and a key. <a href="#a7fbb24a527a74807dded377ca0ecd41c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="uenum_8h.html#a32b7253b2148022535be36a9fcdb5a8d">UEnumeration</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="ures_8h.html#af546de139ec4fc9fba12a9fa1debcfac">ures_openAvailableLocales</a> (const char *packageName, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a string enumerator, owned by the caller, of all locales located within the specified resource tree. <a href="#af546de139ec4fc9fba12a9fa1debcfac"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>C API: Resource Bundle. </p>
<h2>C API: Resource Bundle</h2>
<p>C API representing a collection of resource information pertaining to a given locale. A resource bundle provides a way of accessing locale- specific information in a data file. You create a resource bundle that manages the resources for a given locale and then ask it for individual resources. </p>
<p>Resource bundles in ICU4C are currently defined using text files which conform to the following <a href="http://source.icu-project.org/repos/icu/icuhtml/trunk/design/bnf_rb.txt">BNF definition</a>. More on resource bundle concepts and syntax can be found in the <a href="http://icu-project.org/userguide/ResourceManagement.html">Users Guide</a>. </p>
<p>Definition in file <a class="el" href="ures_8h_source.html">ures.h</a>.</p>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="a7391119e9274be9ba2e6892b48a2bbbe"></a><!-- doxytag: member="ures.h::UResourceBundle" ref="a7391119e9274be9ba2e6892b48a2bbbe" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> <a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001680">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Definition at line <a class="el" href="ures_8h_source.html#l00057">57</a> of file <a class="el" href="ures_8h_source.html">ures.h</a>.</p>
</div>
</div>
<hr/><h2>Enumeration Type Documentation</h2>
<a class="anchor" id="a3f1197bf41a6228c38e3fddb58bf96fb"></a><!-- doxytag: member="ures.h::UResType" ref="a3f1197bf41a6228c38e3fddb58bf96fb" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="ures_8h.html#a3f1197bf41a6228c38e3fddb58bf96fb">UResType</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Numeric constants for types of resource items. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="ures_8h.html#a77ac531cd4bdc588efd21b2d9b7e2471" title="Returns the type of a resource.">ures_getType</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001681">Stable:</a></b></dt><dd>ICU 2.0 </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="a3f1197bf41a6228c38e3fddb58bf96fbab73cbea3085f99defd0538171d343f03"></a><!-- doxytag: member="URES_NONE" ref="a3f1197bf41a6228c38e3fddb58bf96fbab73cbea3085f99defd0538171d343f03" args="" -->URES_NONE</em> </td><td>
<p>Resource type constant for "no resource". </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001708">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a3f1197bf41a6228c38e3fddb58bf96fbac4db2a063c1c73cc363b0e21891bc480"></a><!-- doxytag: member="URES_STRING" ref="a3f1197bf41a6228c38e3fddb58bf96fbac4db2a063c1c73cc363b0e21891bc480" args="" -->URES_STRING</em> </td><td>
<p>Resource type constant for 16-bit Unicode strings. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001709">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a3f1197bf41a6228c38e3fddb58bf96fba7220aa0da13f4d7a1e62a1856026c271"></a><!-- doxytag: member="URES_BINARY" ref="a3f1197bf41a6228c38e3fddb58bf96fba7220aa0da13f4d7a1e62a1856026c271" args="" -->URES_BINARY</em> </td><td>
<p>Resource type constant for binary data. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001710">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a3f1197bf41a6228c38e3fddb58bf96fba2cfd36db6917951f177723df3a58e2b4"></a><!-- doxytag: member="URES_TABLE" ref="a3f1197bf41a6228c38e3fddb58bf96fba2cfd36db6917951f177723df3a58e2b4" args="" -->URES_TABLE</em> </td><td>
<p>Resource type constant for tables of key-value pairs. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001711">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a3f1197bf41a6228c38e3fddb58bf96fba6890eb4a8669521aace76b4c854d304e"></a><!-- doxytag: member="URES_ALIAS" ref="a3f1197bf41a6228c38e3fddb58bf96fba6890eb4a8669521aace76b4c854d304e" args="" -->URES_ALIAS</em> </td><td>
<p>Resource type constant for aliases; internally stores a string which identifies the actual resource storing the data (can be in a different resource bundle). </p>
<p>Resolved internally before delivering the actual resource through the API. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001712">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a3f1197bf41a6228c38e3fddb58bf96fbac71be9c52845b8404c84610320b550ba"></a><!-- doxytag: member="URES_INT" ref="a3f1197bf41a6228c38e3fddb58bf96fbac71be9c52845b8404c84610320b550ba" args="" -->URES_INT</em> </td><td>
<p>Resource type constant for a single 28-bit integer, interpreted as signed or unsigned by the <a class="el" href="ures_8h.html#ab718b0e9c6e06a2bbcce9a71e04b185e" title="Returns a signed integer from a resource.">ures_getInt()</a> or <a class="el" href="ures_8h.html#aa21170067cf90e1d492b4806f31c6a9c" title="Returns an unsigned integer from a resource.">ures_getUInt()</a> function. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="ures_8h.html#ab718b0e9c6e06a2bbcce9a71e04b185e" title="Returns a signed integer from a resource.">ures_getInt</a> </dd>
<dd>
<a class="el" href="ures_8h.html#aa21170067cf90e1d492b4806f31c6a9c" title="Returns an unsigned integer from a resource.">ures_getUInt</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001713">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a3f1197bf41a6228c38e3fddb58bf96fbaa2e7a87c3c144d7df2abd973b86512ca"></a><!-- doxytag: member="URES_ARRAY" ref="a3f1197bf41a6228c38e3fddb58bf96fbaa2e7a87c3c144d7df2abd973b86512ca" args="" -->URES_ARRAY</em> </td><td>
<p>Resource type constant for arrays of resources. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001714">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a3f1197bf41a6228c38e3fddb58bf96fba6c6b406d49cebed764c515d49dcf73b3"></a><!-- doxytag: member="URES_INT_VECTOR" ref="a3f1197bf41a6228c38e3fddb58bf96fba6c6b406d49cebed764c515d49dcf73b3" args="" -->URES_INT_VECTOR</em> </td><td>
<p>Resource type constant for vectors of 32-bit integers. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="ures_8h.html#ae89d1bc77281a8a61896f6615cd506ea" title="Returns a 32 bit integer array from a resource.">ures_getIntVector</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001715">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a3f1197bf41a6228c38e3fddb58bf96fba78e3758a381e62148cc4b0438f3c0777"></a><!-- doxytag: member="RES_NONE" ref="a3f1197bf41a6228c38e3fddb58bf96fba78e3758a381e62148cc4b0438f3c0777" args="" -->RES_NONE</em> </td><td>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000008">Deprecated:</a></b></dt><dd>ICU 2.6 Use the URES_ constant instead. </dd></dl>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a3f1197bf41a6228c38e3fddb58bf96fbad6c0349cb0484769c040d660de1c7445"></a><!-- doxytag: member="RES_STRING" ref="a3f1197bf41a6228c38e3fddb58bf96fbad6c0349cb0484769c040d660de1c7445" args="" -->RES_STRING</em> </td><td>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000009">Deprecated:</a></b></dt><dd>ICU 2.6 Use the URES_ constant instead. </dd></dl>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a3f1197bf41a6228c38e3fddb58bf96fba2ad74e7a8c734f374bf8b786617fb212"></a><!-- doxytag: member="RES_BINARY" ref="a3f1197bf41a6228c38e3fddb58bf96fba2ad74e7a8c734f374bf8b786617fb212" args="" -->RES_BINARY</em> </td><td>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000010">Deprecated:</a></b></dt><dd>ICU 2.6 Use the URES_ constant instead. </dd></dl>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a3f1197bf41a6228c38e3fddb58bf96fbac93b5478e79d51b10747d617765069af"></a><!-- doxytag: member="RES_TABLE" ref="a3f1197bf41a6228c38e3fddb58bf96fbac93b5478e79d51b10747d617765069af" args="" -->RES_TABLE</em> </td><td>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000011">Deprecated:</a></b></dt><dd>ICU 2.6 Use the URES_ constant instead. </dd></dl>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a3f1197bf41a6228c38e3fddb58bf96fbae4f137b23dcc82d1b7c5b19d5453b3a1"></a><!-- doxytag: member="RES_ALIAS" ref="a3f1197bf41a6228c38e3fddb58bf96fbae4f137b23dcc82d1b7c5b19d5453b3a1" args="" -->RES_ALIAS</em> </td><td>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000012">Deprecated:</a></b></dt><dd>ICU 2.6 Use the URES_ constant instead. </dd></dl>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a3f1197bf41a6228c38e3fddb58bf96fbaf1f3ced984a5ff062dae837b00769e9f"></a><!-- doxytag: member="RES_INT" ref="a3f1197bf41a6228c38e3fddb58bf96fbaf1f3ced984a5ff062dae837b00769e9f" args="" -->RES_INT</em> </td><td>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000013">Deprecated:</a></b></dt><dd>ICU 2.6 Use the URES_ constant instead. </dd></dl>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a3f1197bf41a6228c38e3fddb58bf96fba2eeb630d6cacdd4cdeae5ae05edfc8bd"></a><!-- doxytag: member="RES_ARRAY" ref="a3f1197bf41a6228c38e3fddb58bf96fba2eeb630d6cacdd4cdeae5ae05edfc8bd" args="" -->RES_ARRAY</em> </td><td>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000014">Deprecated:</a></b></dt><dd>ICU 2.6 Use the URES_ constant instead. </dd></dl>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a3f1197bf41a6228c38e3fddb58bf96fbac5f51dba6417cd88750d7fb32c1cfb7e"></a><!-- doxytag: member="RES_INT_VECTOR" ref="a3f1197bf41a6228c38e3fddb58bf96fbac5f51dba6417cd88750d7fb32c1cfb7e" args="" -->RES_INT_VECTOR</em> </td><td>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000015">Deprecated:</a></b></dt><dd>ICU 2.6 Use the URES_ constant instead. </dd></dl>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a3f1197bf41a6228c38e3fddb58bf96fbabb8f79bd6e07400f6870fe51ae24fcef"></a><!-- doxytag: member="RES_RESERVED" ref="a3f1197bf41a6228c38e3fddb58bf96fbabb8f79bd6e07400f6870fe51ae24fcef" args="" -->RES_RESERVED</em> </td><td>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000016">Deprecated:</a></b></dt><dd>ICU 2.6 Not used. </dd></dl>
</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="ures_8h_source.html#l00064">64</a> of file <a class="el" href="ures_8h_source.html">ures.h</a>.</p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="addb8be0af245c0f745458e7ad925a490"></a><!-- doxytag: member="ures.h::ures_close" ref="addb8be0af245c0f745458e7ad925a490" args="(UResourceBundle *resourceBundle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ures_close </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> * </td>
<td class="paramname"> <em>resourceBundle</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Close a resource bundle, all pointers returned from the various ures_getXXX calls on this particular bundle should be considered invalid henceforth. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>resourceBundle</em> </td><td>a pointer to a resourceBundle struct. Can be NULL. </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="ures_8h.html#ac4d72fc9f7cc63a05f646cabee4be167" title="Opens a UResourceBundle, from which users can extract strings by using their corresponding...">ures_open</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001685">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a09607e48125e46397a843f255640fe2e"></a><!-- doxytag: member="ures.h::ures_countArrayItems" ref="a09607e48125e46397a843f255640fe2e" args="(const UResourceBundle *resourceBundle, const char *resourceKey, UErrorCode *err)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ures_countArrayItems </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> * </td>
<td class="paramname"> <em>resourceBundle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>resourceKey</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>err</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 number of strings/arrays in resource bundles. </p>
<p>Better to use ures_getSize, as this function will be deprecated.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>resourceBundle</em> </td><td>resource bundle containing the desired strings </td></tr>
<tr><td valign="top"></td><td valign="top"><em>resourceKey</em> </td><td>key tagging the resource </td></tr>
<tr><td valign="top"></td><td valign="top"><em>err</em> </td><td>fills in the outgoing error code could be <code>U_MISSING_RESOURCE_ERROR</code> if the key is not found could be a non-failing error e.g.: <code>U_USING_FALLBACK_WARNING</code>,<code>U_USING_FALLBACK_WARNING </code> </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>: for <b>Arrays</b>: returns the number of resources in the array <b>Tables</b>: returns the number of resources in the table <b>single string</b>: returns 1 </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="ures_8h.html#a4eb5d79c3799ee8cfe0cbd96322581bd" title="Returns the size of a resource.">ures_getSize</a> </dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000005">Deprecated:</a></b></dt><dd>ICU 2.8 User ures_getSize instead </dd></dl>
</div>
</div>
<a class="anchor" id="a3d29628c77fb9c5fffa412257aa743cc"></a><!-- doxytag: member="ures.h::ures_getBinary" ref="a3d29628c77fb9c5fffa412257aa743cc" args="(const UResourceBundle *resourceBundle, int32_t *len, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const uint8_t* ures_getBinary </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> * </td>
<td class="paramname"> <em>resourceBundle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t * </td>
<td class="paramname"> <em>len</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 a binary data from a binary resource. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>resourceBundle</em> </td><td>a string resource </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>fills in the length of resulting byte chunk </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>fills in the outgoing error code could be <code>U_MISSING_RESOURCE_ERROR</code> if the key is not found Always check the value of status. Don't count on returning NULL. could be a non-failing error e.g.: <code>U_USING_FALLBACK_WARNING</code>,<code>U_USING_DEFAULT_WARNING </code> </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to a chunk of unsigned bytes which live in a memory mapped/DLL file. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="ures_8h.html#a088b560881f84521caefc1513efc45af" title="Returns a string from a string resource type.">ures_getString</a> </dd>
<dd>
<a class="el" href="ures_8h.html#ae89d1bc77281a8a61896f6615cd506ea" title="Returns a 32 bit integer array from a resource.">ures_getIntVector</a> </dd>
<dd>
<a class="el" href="ures_8h.html#ab718b0e9c6e06a2bbcce9a71e04b185e" title="Returns a signed integer from a resource.">ures_getInt</a> </dd>
<dd>
<a class="el" href="ures_8h.html#aa21170067cf90e1d492b4806f31c6a9c" title="Returns an unsigned integer from a resource.">ures_getUInt</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001690">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="aae9284d2a6a4c8169cc2e7c7d89a29e6"></a><!-- doxytag: member="ures.h::ures_getByIndex" ref="aae9284d2a6a4c8169cc2e7c7d89a29e6" args="(const UResourceBundle *resourceBundle, int32_t indexR, UResourceBundle *fillIn, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a>* ures_getByIndex </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> * </td>
<td class="paramname"> <em>resourceBundle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>indexR</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> * </td>
<td class="paramname"> <em>fillIn</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 resource in a given resource at the specified index. </p>
<p>Features a fill-in parameter.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>resourceBundle</em> </td><td>the resource bundle from which to get a sub-resource </td></tr>
<tr><td valign="top"></td><td valign="top"><em>indexR</em> </td><td>an index to the wanted resource. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>fillIn</em> </td><td>if NULL a new UResourceBundle struct is allocated and must be closed by the caller. Alternatively, you can supply a struct to be filled by this function. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>fills in the outgoing error code. Don't count on NULL being returned if an error has occured. Check status instead. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to a UResourceBundle struct. If fill in param was NULL, caller must close it </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001701">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a9cffc29afd81c60f4a3ce2c8dadf8e98"></a><!-- doxytag: member="ures.h::ures_getByKey" ref="a9cffc29afd81c60f4a3ce2c8dadf8e98" args="(const UResourceBundle *resourceBundle, const char *key, UResourceBundle *fillIn, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a>* ures_getByKey </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> * </td>
<td class="paramname"> <em>resourceBundle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> * </td>
<td class="paramname"> <em>fillIn</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 a resource in a given resource that has a given key. </p>
<p>This procedure works only with table resources. Features a fill-in parameter.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>resourceBundle</em> </td><td>a resource </td></tr>
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>a key associated with the wanted resource </td></tr>
<tr><td valign="top"></td><td valign="top"><em>fillIn</em> </td><td>if NULL a new UResourceBundle struct is allocated and must be closed by the caller. Alternatively, you can supply a struct to be filled by this function. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>fills in the outgoing error code. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to a UResourceBundle struct. If fill in param was NULL, caller must close it </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001704">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="ab718b0e9c6e06a2bbcce9a71e04b185e"></a><!-- doxytag: member="ures.h::ures_getInt" ref="ab718b0e9c6e06a2bbcce9a71e04b185e" args="(const UResourceBundle *resourceBundle, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ures_getInt </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> * </td>
<td class="paramname"> <em>resourceBundle</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 a signed integer from a resource. </p>
<p>This integer is originally 28 bit and the sign gets propagated.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>resourceBundle</em> </td><td>a string resource </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>fills in the outgoing error code could be <code>U_MISSING_RESOURCE_ERROR</code> if the key is not found could be a non-failing error e.g.: <code>U_USING_FALLBACK_WARNING</code>,<code>U_USING_DEFAULT_WARNING </code> </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>an integer value </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="ures_8h.html#aa21170067cf90e1d492b4806f31c6a9c" title="Returns an unsigned integer from a resource.">ures_getUInt</a> </dd>
<dd>
<a class="el" href="ures_8h.html#ae89d1bc77281a8a61896f6615cd506ea" title="Returns a 32 bit integer array from a resource.">ures_getIntVector</a> </dd>
<dd>
<a class="el" href="ures_8h.html#a3d29628c77fb9c5fffa412257aa743cc" title="Returns a binary data from a binary resource.">ures_getBinary</a> </dd>
<dd>
<a class="el" href="ures_8h.html#a088b560881f84521caefc1513efc45af" title="Returns a string from a string resource type.">ures_getString</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001693">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="ae89d1bc77281a8a61896f6615cd506ea"></a><!-- doxytag: member="ures.h::ures_getIntVector" ref="ae89d1bc77281a8a61896f6615cd506ea" args="(const UResourceBundle *resourceBundle, int32_t *len, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const int32_t* ures_getIntVector </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> * </td>
<td class="paramname"> <em>resourceBundle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t * </td>
<td class="paramname"> <em>len</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 a 32 bit integer array from a resource. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>resourceBundle</em> </td><td>an int vector resource </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>fills in the length of resulting byte chunk </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>fills in the outgoing error code could be <code>U_MISSING_RESOURCE_ERROR</code> if the key is not found Always check the value of status. Don't count on returning NULL. could be a non-failing error e.g.: <code>U_USING_FALLBACK_WARNING</code>,<code>U_USING_DEFAULT_WARNING </code> </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to a chunk of integers which live in a memory mapped/DLL file. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="ures_8h.html#a3d29628c77fb9c5fffa412257aa743cc" title="Returns a binary data from a binary resource.">ures_getBinary</a> </dd>
<dd>
<a class="el" href="ures_8h.html#a088b560881f84521caefc1513efc45af" title="Returns a string from a string resource type.">ures_getString</a> </dd>
<dd>
<a class="el" href="ures_8h.html#ab718b0e9c6e06a2bbcce9a71e04b185e" title="Returns a signed integer from a resource.">ures_getInt</a> </dd>
<dd>
<a class="el" href="ures_8h.html#aa21170067cf90e1d492b4806f31c6a9c" title="Returns an unsigned integer from a resource.">ures_getUInt</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001691">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a9c391e946d5d4bc204c1cc7798de6668"></a><!-- doxytag: member="ures.h::ures_getKey" ref="a9c391e946d5d4bc204c1cc7798de6668" args="(const UResourceBundle *resourceBundle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* ures_getKey </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> * </td>
<td class="paramname"> <em>resourceBundle</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the key associated with a given resource. </p>
<p>Not all the resources have a key - only those that are members of a table.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>resourceBundle</em> </td><td>a resource </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a key associated to this resource, or NULL if it doesn't have a key </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001696">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a82bdc1bb4f0afdb2d263c3589eaa9b62"></a><!-- doxytag: member="ures.h::ures_getLocale" ref="a82bdc1bb4f0afdb2d263c3589eaa9b62" args="(const UResourceBundle *resourceBundle, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* ures_getLocale </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> * </td>
<td class="paramname"> <em>resourceBundle</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 name of the <a class="el" href="classLocale.html" title="A Locale object represents a specific geographical, political, or cultural region...">Locale</a> associated with this <a class="el" href="classResourceBundle.html" title="A class representing a collection of resource information pertaining to a given locale...">ResourceBundle</a>. </p>
<p>This API allows you to query for the real locale of the resource. For example, if you requested "en_US_CALIFORNIA" and only "en_US" bundle exists, "en_US" will be returned. For subresources, the locale where this resource comes from will be returned. If fallback has occured, getLocale will reflect this.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>resourceBundle</em> </td><td>resource bundle in question </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>just for catching illegal arguments </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A <a class="el" href="classLocale.html" title="A Locale object represents a specific geographical, political, or cultural region...">Locale</a> name </dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000007">Deprecated:</a></b></dt><dd>ICU 2.8 Use ures_getLocaleByType instead. </dd></dl>
</div>
</div>
<a class="anchor" id="a39d1e5c7a265c24ebaa684b55a74c0e0"></a><!-- doxytag: member="ures.h::ures_getLocaleByType" ref="a39d1e5c7a265c24ebaa684b55a74c0e0" args="(const UResourceBundle *resourceBundle, ULocDataLocaleType type, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* ures_getLocaleByType </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> * </td>
<td class="paramname"> <em>resourceBundle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="uloc_8h.html#adf053345d343f8d82ae080f7a5871f34">ULocDataLocaleType</a> </td>
<td class="paramname"> <em>type</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 name of the <a class="el" href="classLocale.html" title="A Locale object represents a specific geographical, political, or cultural region...">Locale</a> associated with this <a class="el" href="classResourceBundle.html" title="A class representing a collection of resource information pertaining to a given locale...">ResourceBundle</a>. </p>
<p>You can choose between requested, valid and real 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>resourceBundle</em> </td><td>resource bundle in question </td></tr>
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>You can choose between requested, valid and actual locale. For description see the definition of ULocDataLocaleType in <a class="el" href="uloc_8h.html" title="C API: Locale.">uloc.h</a> </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>just for catching illegal arguments </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A <a class="el" href="classLocale.html" title="A Locale object represents a specific geographical, political, or cultural region...">Locale</a> name </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001687">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
</div>
</div>
<a class="anchor" id="a04ad67a1b8feaca7b817ce51e4878d1d"></a><!-- doxytag: member="ures.h::ures_getNextResource" ref="a04ad67a1b8feaca7b817ce51e4878d1d" args="(UResourceBundle *resourceBundle, UResourceBundle *fillIn, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a>* ures_getNextResource </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> * </td>
<td class="paramname"> <em>resourceBundle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> * </td>
<td class="paramname"> <em>fillIn</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 next resource in a given resource or NULL if there are no more resources to iterate over. </p>
<p>Features a fill-in parameter.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>resourceBundle</em> </td><td>a resource </td></tr>
<tr><td valign="top"></td><td valign="top"><em>fillIn</em> </td><td>if NULL a new UResourceBundle struct is allocated and must be closed by the caller. Alternatively, you can supply a struct to be filled by this function. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>fills in the outgoing error code. You may still get a non NULL result even if an error occured. Check status instead. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to a UResourceBundle struct. If fill in param was NULL, caller must close it </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001699">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="ab3c74eb748adde7d83bd8a9ac52bb58e"></a><!-- doxytag: member="ures.h::ures_getNextString" ref="ab3c74eb748adde7d83bd8a9ac52bb58e" args="(UResourceBundle *resourceBundle, int32_t *len, const char **key, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a>* ures_getNextString </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> * </td>
<td class="paramname"> <em>resourceBundle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t * </td>
<td class="paramname"> <em>len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char ** </td>
<td class="paramname"> <em>key</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 next string in a given resource or NULL if there are no more resources to iterate over. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>resourceBundle</em> </td><td>a resource </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>fill in length of the string </td></tr>
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>fill in for key associated with this string. NULL if no key </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>fills in the outgoing error code. If an error occured, we may return NULL, but don't count on it. Check status instead! </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to a zero-terminated UChar array which lives in a memory mapped/DLL file. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001700">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a4eb5d79c3799ee8cfe0cbd96322581bd"></a><!-- doxytag: member="ures.h::ures_getSize" ref="a4eb5d79c3799ee8cfe0cbd96322581bd" args="(const UResourceBundle *resourceBundle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ures_getSize </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> * </td>
<td class="paramname"> <em>resourceBundle</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the size of a resource. </p>
<p>Size for scalar types is always 1, and for vector/table types is the number of child resources. </p>
<dl class="warning"><dt><b>Warning:</b></dt><dd>Integer array is treated as a scalar type. There are no APIs to access individual members of an integer array. It is always returned as a whole. </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>resourceBundle</em> </td><td>a resource </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>number of resources in a given resource. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001694">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a088b560881f84521caefc1513efc45af"></a><!-- doxytag: member="ures.h::ures_getString" ref="a088b560881f84521caefc1513efc45af" args="(const UResourceBundle *resourceBundle, int32_t *len, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a>* ures_getString </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> * </td>
<td class="paramname"> <em>resourceBundle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t * </td>
<td class="paramname"> <em>len</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 a string from a string resource type. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>resourceBundle</em> </td><td>a string resource </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>fills in the length of resulting string </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>fills in the outgoing error code could be <code>U_MISSING_RESOURCE_ERROR</code> if the key is not found Always check the value of status. Don't count on returning NULL. could be a non-failing error e.g.: <code>U_USING_FALLBACK_WARNING</code>,<code>U_USING_DEFAULT_WARNING </code> </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to a zero-terminated UChar array which lives in a memory mapped/DLL file. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="ures_8h.html#a3d29628c77fb9c5fffa412257aa743cc" title="Returns a binary data from a binary resource.">ures_getBinary</a> </dd>
<dd>
<a class="el" href="ures_8h.html#ae89d1bc77281a8a61896f6615cd506ea" title="Returns a 32 bit integer array from a resource.">ures_getIntVector</a> </dd>
<dd>
<a class="el" href="ures_8h.html#ab718b0e9c6e06a2bbcce9a71e04b185e" title="Returns a signed integer from a resource.">ures_getInt</a> </dd>
<dd>
<a class="el" href="ures_8h.html#aa21170067cf90e1d492b4806f31c6a9c" title="Returns an unsigned integer from a resource.">ures_getUInt</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001688">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a1ac2f42ee782365ab291f6135e5b0073"></a><!-- doxytag: member="ures.h::ures_getStringByIndex" ref="a1ac2f42ee782365ab291f6135e5b0073" args="(const UResourceBundle *resourceBundle, int32_t indexS, int32_t *len, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a>* ures_getStringByIndex </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> * </td>
<td class="paramname"> <em>resourceBundle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>indexS</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t * </td>
<td class="paramname"> <em>len</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 string in a given resource at the specified index. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>resourceBundle</em> </td><td>a resource </td></tr>
<tr><td valign="top"></td><td valign="top"><em>indexS</em> </td><td>an index to the wanted string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>fill in length of the string </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>fills in the outgoing error code. If an error occured, we may return NULL, but don't count on it. Check status instead! </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to a zero-terminated UChar array which lives in a memory mapped/DLL file. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001702">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a59b808cfa2bdd08497219849cdeff140"></a><!-- doxytag: member="ures.h::ures_getStringByKey" ref="a59b808cfa2bdd08497219849cdeff140" args="(const UResourceBundle *resB, const char *key, int32_t *len, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a>* ures_getStringByKey </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> * </td>
<td class="paramname"> <em>resB</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t * </td>
<td class="paramname"> <em>len</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 a string in a given resource that has a given key. </p>
<p>This procedure works only with table resources.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>resB</em> </td><td>a resource </td></tr>
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>a key associated with the wanted string </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>fill in length of the string </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>fills in the outgoing error code. If an error occured, we may return NULL, but don't count on it. Check status instead! </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to a zero-terminated UChar array which lives in a memory mapped/DLL file. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001705">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a77ac531cd4bdc588efd21b2d9b7e2471"></a><!-- doxytag: member="ures.h::ures_getType" ref="a77ac531cd4bdc588efd21b2d9b7e2471" args="(const UResourceBundle *resourceBundle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ures_8h.html#a3f1197bf41a6228c38e3fddb58bf96fb">UResType</a> ures_getType </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> * </td>
<td class="paramname"> <em>resourceBundle</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the type of a resource. </p>
<p>Available types are defined in enum UResType</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>resourceBundle</em> </td><td>a resource </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>type of the given resource. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="ures_8h.html#a3f1197bf41a6228c38e3fddb58bf96fb" title="Numeric constants for types of resource items.">UResType</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001695">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="aa21170067cf90e1d492b4806f31c6a9c"></a><!-- doxytag: member="ures.h::ures_getUInt" ref="aa21170067cf90e1d492b4806f31c6a9c" args="(const UResourceBundle *resourceBundle, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t ures_getUInt </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> * </td>
<td class="paramname"> <em>resourceBundle</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 an unsigned integer from a resource. </p>
<p>This integer is originally 28 bits.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>resourceBundle</em> </td><td>a string resource </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>fills in the outgoing error code could be <code>U_MISSING_RESOURCE_ERROR</code> if the key is not found could be a non-failing error e.g.: <code>U_USING_FALLBACK_WARNING</code>,<code>U_USING_DEFAULT_WARNING </code> </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>an integer value </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="ures_8h.html#ab718b0e9c6e06a2bbcce9a71e04b185e" title="Returns a signed integer from a resource.">ures_getInt</a> </dd>
<dd>
<a class="el" href="ures_8h.html#ae89d1bc77281a8a61896f6615cd506ea" title="Returns a 32 bit integer array from a resource.">ures_getIntVector</a> </dd>
<dd>
<a class="el" href="ures_8h.html#a3d29628c77fb9c5fffa412257aa743cc" title="Returns a binary data from a binary resource.">ures_getBinary</a> </dd>
<dd>
<a class="el" href="ures_8h.html#a088b560881f84521caefc1513efc45af" title="Returns a string from a string resource type.">ures_getString</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001692">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a1dd8d20a524c70ef8ec9943221f82021"></a><!-- doxytag: member="ures.h::ures_getUTF8String" ref="a1dd8d20a524c70ef8ec9943221f82021" args="(const UResourceBundle *resB, char *dest, int32_t *length, UBool forceCopy, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* ures_getUTF8String </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> * </td>
<td class="paramname"> <em>resB</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t * </td>
<td class="paramname"> <em>length</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>forceCopy</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 a UTF-8 string from a string resource. </p>
<p>The UTF-8 string may be returnable directly as a pointer, or it may need to be copied, or transformed from UTF-16 using <a class="el" href="ustring_8h.html#a0ca7af2cf47b116454eed92331594afa" title="Convert a UTF-16 string to UTF-8.">u_strToUTF8()</a> or equivalent.</p>
<p>If forceCopy==TRUE, then the string is always written to the dest buffer and dest is returned.</p>
<p>If forceCopy==FALSE, then the string is returned as a pointer if possible, without needing a dest buffer (it can be NULL). If the string needs to be copied or transformed, then it may be placed into dest at an arbitrary offset.</p>
<p>If the string is to be written to dest, then U_BUFFER_OVERFLOW_ERROR and U_STRING_NOT_TERMINATED_WARNING are set if appropriate, as usual.</p>
<p>If the string is transformed from UTF-16, then a conversion error may occur if an unpaired surrogate is encountered. If the function is successful, then the output UTF-8 string is always well-formed.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>resB</em> </td><td>Resource bundle. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>Destination buffer. Can be NULL only if capacity=*length==0. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>length</em> </td><td>Input: Capacity of destination buffer. Output: Actual length of the UTF-8 string, not counting the terminating NUL, even in case of U_BUFFER_OVERFLOW_ERROR. Can be NULL, meaning capacity=0 and the string length is not returned to the caller. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>forceCopy</em> </td><td>If TRUE, then the output string will always be written to dest, with U_BUFFER_OVERFLOW_ERROR and U_STRING_NOT_TERMINATED_WARNING set if appropriate. If FALSE, then the dest buffer may or may not contain a copy of the string. dest may or may not be modified. If a copy needs to be written, then the UErrorCode parameter indicates overflow etc. as usual. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Pointer to a standard ICU error code. Its input value must pass the <a class="el" href="utypes_8h.html#a527f2c69e6b2e3b2c53ad8a99fb36711" title="Does the error code indicate success?">U_SUCCESS()</a> test, or else the function returns immediately. Check for <a class="el" href="utypes_8h.html#a4d202200b6aa6f3c965ea370e0c8155f" title="Does the error code indicate a failure?">U_FAILURE()</a> on output or use with function chaining. (See User Guide for details.) </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The pointer to the UTF-8 string. It may be dest, or at some offset from dest (only if !forceCopy), or in unrelated memory. Always NUL-terminated unless the string was written to dest and length==capacity (in which case U_STRING_NOT_TERMINATED_WARNING is set).</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="ures_8h.html#a088b560881f84521caefc1513efc45af" title="Returns a string from a string resource type.">ures_getString</a> </dd>
<dd>
<a class="el" href="ustring_8h.html#a0ca7af2cf47b116454eed92331594afa" title="Convert a UTF-16 string to UTF-8.">u_strToUTF8</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001689">Stable:</a></b></dt><dd>ICU 3.6 </dd></dl>
</div>
</div>
<a class="anchor" id="af692a3738524bbf6c30bfa56a2135b5b"></a><!-- doxytag: member="ures.h::ures_getUTF8StringByIndex" ref="af692a3738524bbf6c30bfa56a2135b5b" args="(const UResourceBundle *resB, int32_t stringIndex, char *dest, int32_t *pLength, UBool forceCopy, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* ures_getUTF8StringByIndex </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> * </td>
<td class="paramname"> <em>resB</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>stringIndex</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t * </td>
<td class="paramname"> <em>pLength</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>forceCopy</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 a UTF-8 string from a resource at the specified index. </p>
<p>The UTF-8 string may be returnable directly as a pointer, or it may need to be copied, or transformed from UTF-16 using <a class="el" href="ustring_8h.html#a0ca7af2cf47b116454eed92331594afa" title="Convert a UTF-16 string to UTF-8.">u_strToUTF8()</a> or equivalent.</p>
<p>If forceCopy==TRUE, then the string is always written to the dest buffer and dest is returned.</p>
<p>If forceCopy==FALSE, then the string is returned as a pointer if possible, without needing a dest buffer (it can be NULL). If the string needs to be copied or transformed, then it may be placed into dest at an arbitrary offset.</p>
<p>If the string is to be written to dest, then U_BUFFER_OVERFLOW_ERROR and U_STRING_NOT_TERMINATED_WARNING are set if appropriate, as usual.</p>
<p>If the string is transformed from UTF-16, then a conversion error may occur if an unpaired surrogate is encountered. If the function is successful, then the output UTF-8 string is always well-formed.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>resB</em> </td><td>Resource bundle. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>stringIndex</em> </td><td>An index to the wanted string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>Destination buffer. Can be NULL only if capacity=*length==0. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pLength</em> </td><td>Input: Capacity of destination buffer. Output: Actual length of the UTF-8 string, not counting the terminating NUL, even in case of U_BUFFER_OVERFLOW_ERROR. Can be NULL, meaning capacity=0 and the string length is not returned to the caller. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>forceCopy</em> </td><td>If TRUE, then the output string will always be written to dest, with U_BUFFER_OVERFLOW_ERROR and U_STRING_NOT_TERMINATED_WARNING set if appropriate. If FALSE, then the dest buffer may or may not contain a copy of the string. dest may or may not be modified. If a copy needs to be written, then the UErrorCode parameter indicates overflow etc. as usual. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Pointer to a standard ICU error code. Its input value must pass the <a class="el" href="utypes_8h.html#a527f2c69e6b2e3b2c53ad8a99fb36711" title="Does the error code indicate success?">U_SUCCESS()</a> test, or else the function returns immediately. Check for <a class="el" href="utypes_8h.html#a4d202200b6aa6f3c965ea370e0c8155f" title="Does the error code indicate a failure?">U_FAILURE()</a> on output or use with function chaining. (See User Guide for details.) </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The pointer to the UTF-8 string. It may be dest, or at some offset from dest (only if !forceCopy), or in unrelated memory. Always NUL-terminated unless the string was written to dest and length==capacity (in which case U_STRING_NOT_TERMINATED_WARNING is set).</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="ures_8h.html#a1ac2f42ee782365ab291f6135e5b0073" title="Returns the string in a given resource at the specified index.">ures_getStringByIndex</a> </dd>
<dd>
<a class="el" href="ustring_8h.html#a0ca7af2cf47b116454eed92331594afa" title="Convert a UTF-16 string to UTF-8.">u_strToUTF8</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001703">Stable:</a></b></dt><dd>ICU 3.6 </dd></dl>
</div>
</div>
<a class="anchor" id="a7fbb24a527a74807dded377ca0ecd41c"></a><!-- doxytag: member="ures.h::ures_getUTF8StringByKey" ref="a7fbb24a527a74807dded377ca0ecd41c" args="(const UResourceBundle *resB, const char *key, char *dest, int32_t *pLength, UBool forceCopy, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* ures_getUTF8StringByKey </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> * </td>
<td class="paramname"> <em>resB</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t * </td>
<td class="paramname"> <em>pLength</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>forceCopy</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 a UTF-8 string from a resource and a key. </p>
<p>This function works only with table resources.</p>
<p>The UTF-8 string may be returnable directly as a pointer, or it may need to be copied, or transformed from UTF-16 using <a class="el" href="ustring_8h.html#a0ca7af2cf47b116454eed92331594afa" title="Convert a UTF-16 string to UTF-8.">u_strToUTF8()</a> or equivalent.</p>
<p>If forceCopy==TRUE, then the string is always written to the dest buffer and dest is returned.</p>
<p>If forceCopy==FALSE, then the string is returned as a pointer if possible, without needing a dest buffer (it can be NULL). If the string needs to be copied or transformed, then it may be placed into dest at an arbitrary offset.</p>
<p>If the string is to be written to dest, then U_BUFFER_OVERFLOW_ERROR and U_STRING_NOT_TERMINATED_WARNING are set if appropriate, as usual.</p>
<p>If the string is transformed from UTF-16, then a conversion error may occur if an unpaired surrogate is encountered. If the function is successful, then the output UTF-8 string is always well-formed.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>resB</em> </td><td>Resource bundle. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>A key associated with the wanted resource </td></tr>
<tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>Destination buffer. Can be NULL only if capacity=*length==0. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pLength</em> </td><td>Input: Capacity of destination buffer. Output: Actual length of the UTF-8 string, not counting the terminating NUL, even in case of U_BUFFER_OVERFLOW_ERROR. Can be NULL, meaning capacity=0 and the string length is not returned to the caller. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>forceCopy</em> </td><td>If TRUE, then the output string will always be written to dest, with U_BUFFER_OVERFLOW_ERROR and U_STRING_NOT_TERMINATED_WARNING set if appropriate. If FALSE, then the dest buffer may or may not contain a copy of the string. dest may or may not be modified. If a copy needs to be written, then the UErrorCode parameter indicates overflow etc. as usual. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Pointer to a standard ICU error code. Its input value must pass the <a class="el" href="utypes_8h.html#a527f2c69e6b2e3b2c53ad8a99fb36711" title="Does the error code indicate success?">U_SUCCESS()</a> test, or else the function returns immediately. Check for <a class="el" href="utypes_8h.html#a4d202200b6aa6f3c965ea370e0c8155f" title="Does the error code indicate a failure?">U_FAILURE()</a> on output or use with function chaining. (See User Guide for details.) </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The pointer to the UTF-8 string. It may be dest, or at some offset from dest (only if !forceCopy), or in unrelated memory. Always NUL-terminated unless the string was written to dest and length==capacity (in which case U_STRING_NOT_TERMINATED_WARNING is set).</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="ures_8h.html#a59b808cfa2bdd08497219849cdeff140" title="Returns a string in a given resource that has a given key.">ures_getStringByKey</a> </dd>
<dd>
<a class="el" href="ustring_8h.html#a0ca7af2cf47b116454eed92331594afa" title="Convert a UTF-16 string to UTF-8.">u_strToUTF8</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001706">Stable:</a></b></dt><dd>ICU 3.6 </dd></dl>
</div>
</div>
<a class="anchor" id="a2edd739dcbf0062e0c344b4a4e0a26d2"></a><!-- doxytag: member="ures.h::ures_getVersion" ref="a2edd739dcbf0062e0c344b4a4e0a26d2" args="(const UResourceBundle *resB, UVersionInfo versionInfo)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ures_getVersion </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> * </td>
<td class="paramname"> <em>resB</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="uversion_8h.html#a61caef96ba86d8e86a4031925ea44e94">UVersionInfo</a> </td>
<td class="paramname"> <em>versionInfo</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 version number associated with this <a class="el" href="classResourceBundle.html" title="A class representing a collection of resource information pertaining to a given locale...">ResourceBundle</a> as an UVersionInfo array. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>resB</em> </td><td>The resource bundle for which the version is checked. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>versionInfo</em> </td><td>A UVersionInfo array that is filled with the version number as specified in the resource bundle or its parent. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001686">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a33679a8207b84dda51bff3e30c04174f"></a><!-- doxytag: member="ures.h::ures_getVersionNumber" ref="a33679a8207b84dda51bff3e30c04174f" args="(const UResourceBundle *resourceBundle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* ures_getVersionNumber </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> * </td>
<td class="paramname"> <em>resourceBundle</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the version number associated with this <a class="el" href="classResourceBundle.html" title="A class representing a collection of resource information pertaining to a given locale...">ResourceBundle</a> as a string. </p>
<p>Please use ures_getVersion as this function is going to be deprecated.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>resourceBundle</em> </td><td>The resource bundle for which the version is checked. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A version number string as specified in the resource bundle or its parent. The caller does not own this string. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="ures_8h.html#a2edd739dcbf0062e0c344b4a4e0a26d2" title="Return the version number associated with this ResourceBundle as an UVersionInfo...">ures_getVersion</a> </dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000006">Deprecated:</a></b></dt><dd>ICU 2.8 Use ures_getVersion instead. </dd></dl>
</div>
</div>
<a class="anchor" id="a787089fdc0669fe3ec7f5023b628a642"></a><!-- doxytag: member="ures.h::ures_hasNext" ref="a787089fdc0669fe3ec7f5023b628a642" args="(const UResourceBundle *resourceBundle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> ures_hasNext </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> * </td>
<td class="paramname"> <em>resourceBundle</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Checks whether the given resource has another element to iterate over. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>resourceBundle</em> </td><td>a resource </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>TRUE if there are more elements, FALSE if there is no more elements </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001698">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="ac4d72fc9f7cc63a05f646cabee4be167"></a><!-- doxytag: member="ures.h::ures_open" ref="ac4d72fc9f7cc63a05f646cabee4be167" args="(const char *packageName, const char *locale, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a>* ures_open </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>packageName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>locale</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 UResourceBundle, from which users can extract strings by using their corresponding keys. </p>
<p>Note that the caller is responsible of calling <code>ures_close</code> on each succesfully opened resource bundle. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>packageName</em> </td><td>The packageName and locale together point to an ICU udata object, as defined by <code> udata_open( packageName, "res", locale, err) </code> or equivalent. Typically, packageName will refer to a (.dat) file, or to a package registered with <a class="el" href="udata_8h.html#a406559067e309c05fb90b2d532f11835" title="This function bypasses the normal ICU data loading process for application-specific...">udata_setAppData()</a>. Using a full file or directory pathname for packageName is deprecated. If NULL, ICU data will be used. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>locale</em> </td><td>specifies the locale for which we want to open the resource if NULL, the default locale will be used. If strlen(locale) == 0 root locale will be used.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>fills in the outgoing error code. The UErrorCode err parameter is used to return status information to the user. To check whether the construction succeeded or not, you should check the value of <a class="el" href="utypes_8h.html#a527f2c69e6b2e3b2c53ad8a99fb36711" title="Does the error code indicate success?">U_SUCCESS(err)</a>. If you wish more detailed information, you can check for informational status results which still indicate success. U_USING_FALLBACK_WARNING indicates that a fall back locale was used. For example, 'de_CH' was requested, but nothing was found there, so 'de' was used. U_USING_DEFAULT_WARNING indicates that the default locale data or root locale data was used; neither the requested locale nor any of its fall back locales could be found. Please see the users guide for more information on this topic. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a newly allocated resource bundle. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="ures_8h.html#addb8be0af245c0f745458e7ad925a490" title="Close a resource bundle, all pointers returned from the various ures_getXXX calls...">ures_close</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001682">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="af546de139ec4fc9fba12a9fa1debcfac"></a><!-- doxytag: member="ures.h::ures_openAvailableLocales" ref="af546de139ec4fc9fba12a9fa1debcfac" args="(const char *packageName, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="uenum_8h.html#a32b7253b2148022535be36a9fcdb5a8d">UEnumeration</a>* ures_openAvailableLocales </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>packageName</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>Create a string enumerator, owned by the caller, of all locales located within the specified resource tree. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>packageName</em> </td><td>name of the tree, such as (NULL) or U_ICUDATA_ALIAS or or "ICUDATA-coll" This call is similar to <a class="el" href="uloc_8h.html#a75df9657cc46472afa94e4cbd4a1529b" title="Gets the specified locale from a list of all available locales.">uloc_getAvailable()</a>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>error code </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001707">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl>
</div>
</div>
<a class="anchor" id="a261fcbb263bbe48b13d2b3e2fc2470a0"></a><!-- doxytag: member="ures.h::ures_openDirect" ref="a261fcbb263bbe48b13d2b3e2fc2470a0" args="(const char *packageName, const char *locale, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a>* ures_openDirect </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>packageName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>locale</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>This function does not care what kind of localeID is passed in. </p>
<p>It simply opens a bundle with that name. Fallback mechanism is disabled for the new bundle. If the requested bundle contains an %ALIAS directive, the results are undefined. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>packageName</em> </td><td>The packageName and locale together point to an ICU udata object, as defined by <code> udata_open( packageName, "res", locale, err) </code> or equivalent. Typically, packageName will refer to a (.dat) file, or to a package registered with <a class="el" href="udata_8h.html#a406559067e309c05fb90b2d532f11835" title="This function bypasses the normal ICU data loading process for application-specific...">udata_setAppData()</a>. Using a full file or directory pathname for packageName is deprecated. If NULL, ICU data will be used. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>locale</em> </td><td>specifies the locale for which we want to open the resource if NULL, the default locale will be used. If strlen(locale) == 0 root locale will be used.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>fills in the outgoing error code. Either U_ZERO_ERROR or U_MISSING_RESOURCE_ERROR </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a newly allocated resource bundle or NULL if it doesn't exist. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="ures_8h.html#addb8be0af245c0f745458e7ad925a490" title="Close a resource bundle, all pointers returned from the various ures_getXXX calls...">ures_close</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001683">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a41dc0b7aa46942d3034ffce73adf9aea"></a><!-- doxytag: member="ures.h::ures_openFillIn" ref="a41dc0b7aa46942d3034ffce73adf9aea" args="(UResourceBundle *r, const char *packageName, const char *localeID, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ures_openFillIn </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> * </td>
<td class="paramname"> <em>r</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>packageName</em>, </td>
</tr>
<tr>
<td class="paramkey"></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>Same as <a class="el" href="ures_8h.html#ac4d72fc9f7cc63a05f646cabee4be167" title="Opens a UResourceBundle, from which users can extract strings by using their corresponding...">ures_open()</a> but uses the fill-in parameter instead of allocating a bundle, if r!=NULL. </p>
<p>TODO need to revisit usefulness of this function and usage model for fillIn parameters without knowing sizeof(UResourceBundle) </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>r</em> </td><td>The resourcebundle to open </td></tr>
<tr><td valign="top"></td><td valign="top"><em>packageName</em> </td><td>The packageName and locale together point to an ICU udata object, as defined by <code> udata_open( packageName, "res", locale, err) </code> or equivalent. Typically, packageName will refer to a (.dat) file, or to a package registered with <a class="el" href="udata_8h.html#a406559067e309c05fb90b2d532f11835" title="This function bypasses the normal ICU data loading process for application-specific...">udata_setAppData()</a>. Using a full file or directory pathname for packageName is deprecated. If NULL, ICU data will be used. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>localeID</em> </td><td>specifies the locale for which we want to open the resource </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>The error code </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a newly allocated resource bundle or NULL if it doesn't exist. </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000102">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
</div>
</div>
<a class="anchor" id="a73d8f9711d915ef1888a7e149f64a9ae"></a><!-- doxytag: member="ures.h::ures_openU" ref="a73d8f9711d915ef1888a7e149f64a9ae" args="(const UChar *packageName, const char *locale, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a>* ures_openU </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"> <em>packageName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>locale</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>Same as <a class="el" href="ures_8h.html#ac4d72fc9f7cc63a05f646cabee4be167" title="Opens a UResourceBundle, from which users can extract strings by using their corresponding...">ures_open()</a> but takes a const UChar *path. </p>
<p>This path will be converted to char * using the default converter, then <a class="el" href="ures_8h.html#ac4d72fc9f7cc63a05f646cabee4be167" title="Opens a UResourceBundle, from which users can extract strings by using their corresponding...">ures_open()</a> is called.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>packageName</em> </td><td>The packageName and locale together point to an ICU udata object, as defined by <code> udata_open( packageName, "res", locale, err) </code> or equivalent. Typically, packageName will refer to a (.dat) file, or to a package registered with <a class="el" href="udata_8h.html#a406559067e309c05fb90b2d532f11835" title="This function bypasses the normal ICU data loading process for application-specific...">udata_setAppData()</a>. Using a full file or directory pathname for packageName is deprecated. If NULL, ICU data will be used. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>locale</em> </td><td>specifies the locale for which we want to open the resource if NULL, the default locale will be used. If strlen(locale) == 0 root locale will be used. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>fills in the outgoing error code. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a newly allocated resource bundle. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="ures_8h.html#ac4d72fc9f7cc63a05f646cabee4be167" title="Opens a UResourceBundle, from which users can extract strings by using their corresponding...">ures_open</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001684">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="ab0755e4d54d950e32acc785cbc46c431"></a><!-- doxytag: member="ures.h::ures_resetIterator" ref="ab0755e4d54d950e32acc785cbc46c431" args="(UResourceBundle *resourceBundle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ures_resetIterator </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ures_8h.html#a7391119e9274be9ba2e6892b48a2bbbe">UResourceBundle</a> * </td>
<td class="paramname"> <em>resourceBundle</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Resets the internal context of a resource so that iteration starts from the first element. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>resourceBundle</em> </td><td>a resource </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001697">Stable:</a></b></dt><dd>ICU 2.0 </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
>
760
