<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.11"/> <title>ICU 58.2: icu::TimeZoneNames::MatchInfoCollection Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">ICU 58.2  <span id="projectnumber">58.2</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.11 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <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="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="classes.html"><span>Data Structure Index</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Data Fields</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespaceicu.html">icu</a></li><li class="navelem"><a class="el" href="classicu_1_1TimeZoneNames.html">TimeZoneNames</a></li><li class="navelem"><a class="el" href="classicu_1_1TimeZoneNames_1_1MatchInfoCollection.html">MatchInfoCollection</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> </div> <div class="headertitle"> <div class="title">icu::TimeZoneNames::MatchInfoCollection Class Reference</div> </div> </div><!--header--> <div class="contents"> <p><code><a class="el" href="classicu_1_1TimeZoneNames_1_1MatchInfoCollection.html" title="MatchInfoCollection represents a collection of time zone name matches used by TimeZoneNames#find. ">MatchInfoCollection</a></code> represents a collection of time zone name matches used by <a class="el" href="classicu_1_1TimeZoneNames.html#a19fb3fa67a9b3d9fbedf293a2b2de120">TimeZoneNames#find</a>. <a href="classicu_1_1TimeZoneNames_1_1MatchInfoCollection.html#details">More...</a></p> <p><code>#include <<a class="el" href="tznames_8h_source.html">tznames.h</a>></code></p> <div class="dynheader"> Inheritance diagram for icu::TimeZoneNames::MatchInfoCollection:</div> <div class="dyncontent"> <div class="center"> <img src="classicu_1_1TimeZoneNames_1_1MatchInfoCollection.png" usemap="#icu::TimeZoneNames::MatchInfoCollection_map" alt=""/> <map id="icu::TimeZoneNames::MatchInfoCollection_map" name="icu::TimeZoneNames::MatchInfoCollection_map"> <area href="classicu_1_1UMemory.html" title="UMemory is the common ICU base class. " alt="icu::UMemory" shape="rect" coords="0,0,247,24"/> </map> </div></div> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:aabeba2075496d1454bcd2045e42c46df"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1TimeZoneNames_1_1MatchInfoCollection.html#aabeba2075496d1454bcd2045e42c46df">MatchInfoCollection</a> ()</td></tr> <tr class="memdesc:aabeba2075496d1454bcd2045e42c46df"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#aabeba2075496d1454bcd2045e42c46df">More...</a><br /></td></tr> <tr class="separator:aabeba2075496d1454bcd2045e42c46df"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a9f477e6bb7e3c71aca0fc932ecc9146e"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1TimeZoneNames_1_1MatchInfoCollection.html#a9f477e6bb7e3c71aca0fc932ecc9146e">~MatchInfoCollection</a> ()</td></tr> <tr class="memdesc:a9f477e6bb7e3c71aca0fc932ecc9146e"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a9f477e6bb7e3c71aca0fc932ecc9146e">More...</a><br /></td></tr> <tr class="separator:a9f477e6bb7e3c71aca0fc932ecc9146e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a88c919ad50f2581374f207f0d9a30229"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1TimeZoneNames_1_1MatchInfoCollection.html#a88c919ad50f2581374f207f0d9a30229">addZone</a> (<a class="el" href="tznames_8h.html#a8fbf9ebf198c9ad6a217b010b5b75878">UTimeZoneNameType</a> nameType, int32_t matchLength, const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &tzID, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr> <tr class="memdesc:a88c919ad50f2581374f207f0d9a30229"><td class="mdescLeft"> </td><td class="mdescRight">Adds a zone match. <a href="#a88c919ad50f2581374f207f0d9a30229">More...</a><br /></td></tr> <tr class="separator:a88c919ad50f2581374f207f0d9a30229"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8687eb34cdcb03824790afc16fb7cccd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1TimeZoneNames_1_1MatchInfoCollection.html#a8687eb34cdcb03824790afc16fb7cccd">addMetaZone</a> (<a class="el" href="tznames_8h.html#a8fbf9ebf198c9ad6a217b010b5b75878">UTimeZoneNameType</a> nameType, int32_t matchLength, const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &mzID, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr> <tr class="memdesc:a8687eb34cdcb03824790afc16fb7cccd"><td class="mdescLeft"> </td><td class="mdescRight">Adds a meata zone match. <a href="#a8687eb34cdcb03824790afc16fb7cccd">More...</a><br /></td></tr> <tr class="separator:a8687eb34cdcb03824790afc16fb7cccd"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a77f71ddc464426f9f7bd311f5f7e3260"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1TimeZoneNames_1_1MatchInfoCollection.html#a77f71ddc464426f9f7bd311f5f7e3260">size</a> () const </td></tr> <tr class="memdesc:a77f71ddc464426f9f7bd311f5f7e3260"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of entries available in this object. <a href="#a77f71ddc464426f9f7bd311f5f7e3260">More...</a><br /></td></tr> <tr class="separator:a77f71ddc464426f9f7bd311f5f7e3260"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad1e60673b42c33a95a278a7c77838886"><td class="memItemLeft" align="right" valign="top"><a class="el" href="tznames_8h.html#a8fbf9ebf198c9ad6a217b010b5b75878">UTimeZoneNameType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1TimeZoneNames_1_1MatchInfoCollection.html#ad1e60673b42c33a95a278a7c77838886">getNameTypeAt</a> (int32_t idx) const </td></tr> <tr class="memdesc:ad1e60673b42c33a95a278a7c77838886"><td class="mdescLeft"> </td><td class="mdescRight">Returns the time zone name type of a match at the specified index. <a href="#ad1e60673b42c33a95a278a7c77838886">More...</a><br /></td></tr> <tr class="separator:ad1e60673b42c33a95a278a7c77838886"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a610288e7eaaccb3bce17e3ef0b11451c"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1TimeZoneNames_1_1MatchInfoCollection.html#a610288e7eaaccb3bce17e3ef0b11451c">getMatchLengthAt</a> (int32_t idx) const </td></tr> <tr class="memdesc:a610288e7eaaccb3bce17e3ef0b11451c"><td class="mdescLeft"> </td><td class="mdescRight">Returns the match length of a match at the specified index. <a href="#a610288e7eaaccb3bce17e3ef0b11451c">More...</a><br /></td></tr> <tr class="separator:a610288e7eaaccb3bce17e3ef0b11451c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a3dfe268a574e3952d21781996dc5885a"><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="classicu_1_1TimeZoneNames_1_1MatchInfoCollection.html#a3dfe268a574e3952d21781996dc5885a">getTimeZoneIDAt</a> (int32_t idx, <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &tzID) const </td></tr> <tr class="memdesc:a3dfe268a574e3952d21781996dc5885a"><td class="mdescLeft"> </td><td class="mdescRight">Gets the zone ID of a match at the specified index. <a href="#a3dfe268a574e3952d21781996dc5885a">More...</a><br /></td></tr> <tr class="separator:a3dfe268a574e3952d21781996dc5885a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a987a6c3e7ea625a8631a36ea74884977"><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="classicu_1_1TimeZoneNames_1_1MatchInfoCollection.html#a987a6c3e7ea625a8631a36ea74884977">getMetaZoneIDAt</a> (int32_t idx, <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &mzID) const </td></tr> <tr class="memdesc:a987a6c3e7ea625a8631a36ea74884977"><td class="mdescLeft"> </td><td class="mdescRight">Gets the metazone ID of a match at the specified index. <a href="#a987a6c3e7ea625a8631a36ea74884977">More...</a><br /></td></tr> <tr class="separator:a987a6c3e7ea625a8631a36ea74884977"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p><code><a class="el" href="classicu_1_1TimeZoneNames_1_1MatchInfoCollection.html" title="MatchInfoCollection represents a collection of time zone name matches used by TimeZoneNames#find. ">MatchInfoCollection</a></code> represents a collection of time zone name matches used by <a class="el" href="classicu_1_1TimeZoneNames.html#a19fb3fa67a9b3d9fbedf293a2b2de120">TimeZoneNames#find</a>. </p> <dl class="internal"><dt><b><a class="el" href="internal.html#_internal000457">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl> <p>Definition at line <a class="el" href="tznames_8h_source.html#l00310">310</a> of file <a class="el" href="tznames_8h_source.html">tznames.h</a>.</p> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a class="anchor" id="aabeba2075496d1454bcd2045e42c46df"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">icu::TimeZoneNames::MatchInfoCollection::MatchInfoCollection </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Constructor. </p> <dl class="internal"><dt><b><a class="el" href="internal.html#_internal000459">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl> </div> </div> <a class="anchor" id="a9f477e6bb7e3c71aca0fc932ecc9146e"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual icu::TimeZoneNames::MatchInfoCollection::~MatchInfoCollection </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Destructor. </p> <dl class="internal"><dt><b><a class="el" href="internal.html#_internal000460">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="a8687eb34cdcb03824790afc16fb7cccd"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void icu::TimeZoneNames::MatchInfoCollection::addMetaZone </td> <td>(</td> <td class="paramtype"><a class="el" href="tznames_8h.html#a8fbf9ebf198c9ad6a217b010b5b75878">UTimeZoneNameType</a> </td> <td class="paramname"><em>nameType</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int32_t </td> <td class="paramname"><em>matchLength</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td> <td class="paramname"><em>mzID</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> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Adds a meata zone match. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">nameType</td><td>The name type. </td></tr> <tr><td class="paramname">matchLength</td><td>The match length. </td></tr> <tr><td class="paramname">mzID</td><td>The metazone ID. </td></tr> <tr><td class="paramname">status</td><td>Receives the status </td></tr> </table> </dd> </dl> <dl class="internal"><dt><b><a class="el" href="internal.html#_internal000462">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl> </div> </div> <a class="anchor" id="a88c919ad50f2581374f207f0d9a30229"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void icu::TimeZoneNames::MatchInfoCollection::addZone </td> <td>(</td> <td class="paramtype"><a class="el" href="tznames_8h.html#a8fbf9ebf198c9ad6a217b010b5b75878">UTimeZoneNameType</a> </td> <td class="paramname"><em>nameType</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int32_t </td> <td class="paramname"><em>matchLength</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td> <td class="paramname"><em>tzID</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> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Adds a zone match. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">nameType</td><td>The name type. </td></tr> <tr><td class="paramname">matchLength</td><td>The match length. </td></tr> <tr><td class="paramname">tzID</td><td>The time zone ID. </td></tr> <tr><td class="paramname">status</td><td>Receives the status </td></tr> </table> </dd> </dl> <dl class="internal"><dt><b><a class="el" href="internal.html#_internal000461">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl> </div> </div> <a class="anchor" id="a610288e7eaaccb3bce17e3ef0b11451c"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int32_t icu::TimeZoneNames::MatchInfoCollection::getMatchLengthAt </td> <td>(</td> <td class="paramtype">int32_t </td> <td class="paramname"><em>idx</em></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Returns the match length of a match at the specified index. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">idx</td><td>The index </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>The match length. If the specified idx is out of range, it returns 0. </dd></dl> <dl class="internal"><dt><b><a class="el" href="internal.html#_internal000465">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl> </div> </div> <a class="anchor" id="a987a6c3e7ea625a8631a36ea74884977"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> icu::TimeZoneNames::MatchInfoCollection::getMetaZoneIDAt </td> <td>(</td> <td class="paramtype">int32_t </td> <td class="paramname"><em>idx</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td> <td class="paramname"><em>mzID</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td> const</td> </tr> </table> </div><div class="memdoc"> <p>Gets the metazone ID of a match at the specified index. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">idx</td><td>The index </td></tr> <tr><td class="paramname">mzID</td><td>Receives the metazone ID </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>TRUE if the meta zone ID was set to mzID. </dd></dl> <dl class="internal"><dt><b><a class="el" href="internal.html#_internal000467">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl> </div> </div> <a class="anchor" id="ad1e60673b42c33a95a278a7c77838886"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="tznames_8h.html#a8fbf9ebf198c9ad6a217b010b5b75878">UTimeZoneNameType</a> icu::TimeZoneNames::MatchInfoCollection::getNameTypeAt </td> <td>(</td> <td class="paramtype">int32_t </td> <td class="paramname"><em>idx</em></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Returns the time zone name type of a match at the specified index. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">idx</td><td>The index </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>The time zone name type. If the specified idx is out of range, it returns UTZNM_UNKNOWN. </dd></dl> <dl class="section see"><dt>See also</dt><dd><a class="el" href="tznames_8h.html#a43e50ce952077b55b335c6559d64fc20" title="Constants for time zone display name types. ">UTimeZoneNameType</a> </dd></dl> <dl class="internal"><dt><b><a class="el" href="internal.html#_internal000464">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl> </div> </div> <a class="anchor" id="a3dfe268a574e3952d21781996dc5885a"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> icu::TimeZoneNames::MatchInfoCollection::getTimeZoneIDAt </td> <td>(</td> <td class="paramtype">int32_t </td> <td class="paramname"><em>idx</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td> <td class="paramname"><em>tzID</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td> const</td> </tr> </table> </div><div class="memdoc"> <p>Gets the zone ID of a match at the specified index. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">idx</td><td>The index </td></tr> <tr><td class="paramname">tzID</td><td>Receives the zone ID. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>TRUE if the zone ID was set to tzID. </dd></dl> <dl class="internal"><dt><b><a class="el" href="internal.html#_internal000466">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl> </div> </div> <a class="anchor" id="a77f71ddc464426f9f7bd311f5f7e3260"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int32_t icu::TimeZoneNames::MatchInfoCollection::size </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Returns the number of entries available in this object. </p> <dl class="section return"><dt>Returns</dt><dd>The number of entries. </dd></dl> <dl class="internal"><dt><b><a class="el" href="internal.html#_internal000463">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="tznames_8h_source.html">tznames.h</a></li> </ul> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.11 </small></address> </body> </html>