<!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: ugender.h File Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">ICU 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><a href="annotated.html"><span>Data Structures</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>Globals</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_b2f33c71d4aa5e7af42a1ca61ff5af1b.html">source</a></li><li class="navelem"><a class="el" href="dir_3c42bef9a3e7804b3d74ebb2809ebf86.html">i18n</a></li><li class="navelem"><a class="el" href="dir_fa4147b4d9cbc9ae7619e21b25239322.html">unicode</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#typedef-members">Typedefs</a> | <a href="#enum-members">Enumerations</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">ugender.h File Reference</div> </div> </div><!--header--> <div class="contents"> <p>C API: The purpose of this API is to compute the gender of a list as a whole given the gender of each element. <a href="#details">More...</a></p> <div class="textblock"><code>#include "<a class="el" href="utypes_8h_source.html">unicode/utypes.h</a>"</code><br /> <code>#include "<a class="el" href="localpointer_8h_source.html">unicode/localpointer.h</a>"</code><br /> </div> <p><a href="ugender_8h_source.html">Go to the source code of this file.</a></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> Typedefs</h2></td></tr> <tr class="memitem:a0f8a690953a44132afdfdf0105432afe"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="ugender_8h.html#a9506d61caf22a74908fc8fcbea31c748">UGender</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ugender_8h.html#a0f8a690953a44132afdfdf0105432afe">UGender</a></td></tr> <tr class="separator:a0f8a690953a44132afdfdf0105432afe"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a14e446305ac789f24186e162f2f1a9f3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a14e446305ac789f24186e162f2f1a9f3"></a> typedef struct UGenderInfo </td><td class="memItemRight" valign="bottom"><b>UGenderInfo</b></td></tr> <tr class="separator:a14e446305ac789f24186e162f2f1a9f3"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> Enumerations</h2></td></tr> <tr class="memitem:a9506d61caf22a74908fc8fcbea31c748"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="ugender_8h.html#a9506d61caf22a74908fc8fcbea31c748">UGender</a> { <a class="el" href="ugender_8h.html#a9506d61caf22a74908fc8fcbea31c748aac64e9bd4823d6e06ebd61802b64c946">UGENDER_MALE</a>, <a class="el" href="ugender_8h.html#a9506d61caf22a74908fc8fcbea31c748a413473fae84c2d060c5ef5e712284006">UGENDER_FEMALE</a>, <a class="el" href="ugender_8h.html#a9506d61caf22a74908fc8fcbea31c748abeef9bd190d99481ba8a6a15e80614ba">UGENDER_OTHER</a> }<tr class="memdesc:a9506d61caf22a74908fc8fcbea31c748"><td class="mdescLeft"> </td><td class="mdescRight">Genders. <a href="ugender_8h.html#a9506d61caf22a74908fc8fcbea31c748">More...</a><br /></td></tr> </td></tr> <tr class="separator:a9506d61caf22a74908fc8fcbea31c748"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> Functions</h2></td></tr> <tr class="memitem:ae8dcaa5a7bcfe59fcf243cbaed56ff5a"><td class="memItemLeft" align="right" valign="top">const UGenderInfo * </td><td class="memItemRight" valign="bottom"><a class="el" href="ugender_8h.html#ae8dcaa5a7bcfe59fcf243cbaed56ff5a">ugender_getInstance</a> (const char *locale, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr> <tr class="memdesc:ae8dcaa5a7bcfe59fcf243cbaed56ff5a"><td class="mdescLeft"> </td><td class="mdescRight">Opens a new UGenderInfo object given locale. <a href="#ae8dcaa5a7bcfe59fcf243cbaed56ff5a">More...</a><br /></td></tr> <tr class="separator:ae8dcaa5a7bcfe59fcf243cbaed56ff5a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa2f721416a386c9ebad044f5e7789fe7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="ugender_8h.html#a9506d61caf22a74908fc8fcbea31c748">UGender</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ugender_8h.html#aa2f721416a386c9ebad044f5e7789fe7">ugender_getListGender</a> (const UGenderInfo *genderinfo, const <a class="el" href="ugender_8h.html#a9506d61caf22a74908fc8fcbea31c748">UGender</a> *genders, int32_t size, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr> <tr class="memdesc:aa2f721416a386c9ebad044f5e7789fe7"><td class="mdescLeft"> </td><td class="mdescRight">Given a list, returns the gender of the list as a whole. <a href="#aa2f721416a386c9ebad044f5e7789fe7">More...</a><br /></td></tr> <tr class="separator:aa2f721416a386c9ebad044f5e7789fe7"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>C API: The purpose of this API is to compute the gender of a list as a whole given the gender of each element. </p> <p>Definition in file <a class="el" href="ugender_8h_source.html">ugender.h</a>.</p> </div><h2 class="groupheader">Typedef Documentation</h2> <a class="anchor" id="a0f8a690953a44132afdfdf0105432afe"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef enum <a class="el" href="ugender_8h.html#a9506d61caf22a74908fc8fcbea31c748">UGender</a> <a class="el" href="ugender_8h.html#a9506d61caf22a74908fc8fcbea31c748">UGender</a></td> </tr> </table> </div><div class="memdoc"> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable005221">Stable:</a></b></dt><dd>ICU 50 </dd></dl> <p>Definition at line <a class="el" href="ugender_8h_source.html#l00050">50</a> of file <a class="el" href="ugender_8h_source.html">ugender.h</a>.</p> </div> </div> <h2 class="groupheader">Enumeration Type Documentation</h2> <a class="anchor" id="a9506d61caf22a74908fc8fcbea31c748"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">enum <a class="el" href="ugender_8h.html#a9506d61caf22a74908fc8fcbea31c748">UGender</a></td> </tr> </table> </div><div class="memdoc"> <p>Genders. </p> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable005220">Stable:</a></b></dt><dd>ICU 50 </dd></dl> <table class="fieldtable"> <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="a9506d61caf22a74908fc8fcbea31c748aac64e9bd4823d6e06ebd61802b64c946"></a>UGENDER_MALE </td><td class="fielddoc"> <p>Male gender. </p> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable005225">Stable:</a></b></dt><dd>ICU 50 </dd></dl> </td></tr> <tr><td class="fieldname"><a class="anchor" id="a9506d61caf22a74908fc8fcbea31c748a413473fae84c2d060c5ef5e712284006"></a>UGENDER_FEMALE </td><td class="fielddoc"> <p>Female gender. </p> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable005226">Stable:</a></b></dt><dd>ICU 50 </dd></dl> </td></tr> <tr><td class="fieldname"><a class="anchor" id="a9506d61caf22a74908fc8fcbea31c748abeef9bd190d99481ba8a6a15e80614ba"></a>UGENDER_OTHER </td><td class="fielddoc"> <p>Neutral gender. </p> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable005227">Stable:</a></b></dt><dd>ICU 50 </dd></dl> </td></tr> </table> <p>Definition at line <a class="el" href="ugender_8h_source.html#l00030">30</a> of file <a class="el" href="ugender_8h_source.html">ugender.h</a>.</p> </div> </div> <h2 class="groupheader">Function Documentation</h2> <a class="anchor" id="ae8dcaa5a7bcfe59fcf243cbaed56ff5a"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const UGenderInfo* ugender_getInstance </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> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Opens a new UGenderInfo object given locale. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">locale</td><td>The locale for which the rules are desired. </td></tr> <tr><td class="paramname">status</td><td>UErrorCode pointer </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>A UGenderInfo for the specified locale, or NULL if an error occurred. </dd></dl> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable005223">Stable:</a></b></dt><dd>ICU 50 </dd></dl> </div> </div> <a class="anchor" id="aa2f721416a386c9ebad044f5e7789fe7"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="ugender_8h.html#a9506d61caf22a74908fc8fcbea31c748">UGender</a> ugender_getListGender </td> <td>(</td> <td class="paramtype">const UGenderInfo * </td> <td class="paramname"><em>genderinfo</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="ugender_8h.html#a9506d61caf22a74908fc8fcbea31c748">UGender</a> * </td> <td class="paramname"><em>genders</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int32_t </td> <td class="paramname"><em>size</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>Given a list, returns the gender of the list as a whole. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">genderInfo</td><td>pointer that ugender_getInstance returns. </td></tr> <tr><td class="paramname">genders</td><td>the gender of each element in the list. </td></tr> <tr><td class="paramname">size</td><td>the size of the list. </td></tr> <tr><td class="paramname">status</td><td>A pointer to a UErrorCode to receive any errors. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>The gender of the list. </dd></dl> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable005224">Stable:</a></b></dt><dd>ICU 50 </dd></dl> </div> </div> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.11 </small></address> </body> </html>