File: //opt/alt/alt-nodejs18/root/usr/share/doc/alt-nodejs18-libicu-doc/ugender_8h.html
<!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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ICU 74.2: i18n/unicode/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 74.2
 <span id="projectnumber">74.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_73bc6a9bb617ea1bc89a10aa59ce84e4.html">i18n</a></li><li class="navelem"><a class="el" href="dir_0119ce638985e8a1561a00fdb5f76ff6.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">typedef struct <a class="el" href="ugender_8h.html#a14e446305ac789f24186e162f2f1a9f3">UGenderInfo</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ugender_8h.html#a14e446305ac789f24186e162f2f1a9f3">UGenderInfo</a></td></tr>
<tr class="memdesc:a14e446305ac789f24186e162f2f1a9f3"><td class="mdescLeft"> </td><td class="mdescRight">Opaque UGenderInfo object for use in C programs. <a href="#a14e446305ac789f24186e162f2f1a9f3">More...</a><br /></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>
}</td></tr>
<tr class="memdesc:a9506d61caf22a74908fc8fcbea31c748"><td class="mdescLeft"> </td><td class="mdescRight">Genders. <a href="ugender_8h.html#a9506d61caf22a74908fc8fcbea31c748">More...</a><br /></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:a44f759c78394ddc21fdbd65741d43014"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> const <a class="el" href="ugender_8h.html#a14e446305ac789f24186e162f2f1a9f3">UGenderInfo</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="ugender_8h.html#a44f759c78394ddc21fdbd65741d43014">ugender_getInstance</a> (const char *locale, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a44f759c78394ddc21fdbd65741d43014"><td class="mdescLeft"> </td><td class="mdescRight">Opens a new UGenderInfo object given locale. <a href="#a44f759c78394ddc21fdbd65741d43014">More...</a><br /></td></tr>
<tr class="separator:a44f759c78394ddc21fdbd65741d43014"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:add1b806deed811f122261e435e3a73f6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> <a class="el" href="ugender_8h.html#a9506d61caf22a74908fc8fcbea31c748">UGender</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ugender_8h.html#add1b806deed811f122261e435e3a73f6">ugender_getListGender</a> (const <a class="el" href="ugender_8h.html#a14e446305ac789f24186e162f2f1a9f3">UGenderInfo</a> *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:add1b806deed811f122261e435e3a73f6"><td class="mdescLeft"> </td><td class="mdescRight">Given a list, returns the gender of the list as a whole. <a href="#add1b806deed811f122261e435e3a73f6">More...</a><br /></td></tr>
<tr class="separator:add1b806deed811f122261e435e3a73f6"><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 class="definition">Definition in file <a class="el" href="ugender_8h_source.html">ugender.h</a>.</p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a id="a0f8a690953a44132afdfdf0105432afe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0f8a690953a44132afdfdf0105432afe">◆ </a></span>UGender</h2>
<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#_stable006396">Stable:</a></b></dt><dd>ICU 50 </dd></dl>
<p class="definition">Definition at line <a class="el" href="ugender_8h_source.html#l00052">52</a> of file <a class="el" href="ugender_8h_source.html">ugender.h</a>.</p>
</div>
</div>
<a id="a14e446305ac789f24186e162f2f1a9f3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a14e446305ac789f24186e162f2f1a9f3">◆ </a></span>UGenderInfo</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="ugender_8h.html#a14e446305ac789f24186e162f2f1a9f3">UGenderInfo</a> <a class="el" href="ugender_8h.html#a14e446305ac789f24186e162f2f1a9f3">UGenderInfo</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Opaque UGenderInfo object for use in C programs. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006397">Stable:</a></b></dt><dd>ICU 50 </dd></dl>
<p class="definition">Definition at line <a class="el" href="ugender_8h_source.html#l00059">59</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 id="a9506d61caf22a74908fc8fcbea31c748"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9506d61caf22a74908fc8fcbea31c748">◆ </a></span>UGender</h2>
<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#_stable006395">Stable:</a></b></dt><dd>ICU 50 </dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a9506d61caf22a74908fc8fcbea31c748aac64e9bd4823d6e06ebd61802b64c946"></a>UGENDER_MALE </td><td class="fielddoc"><p>Male gender. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006400">Stable:</a></b></dt><dd>ICU 50 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a9506d61caf22a74908fc8fcbea31c748a413473fae84c2d060c5ef5e712284006"></a>UGENDER_FEMALE </td><td class="fielddoc"><p>Female gender. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006401">Stable:</a></b></dt><dd>ICU 50 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a9506d61caf22a74908fc8fcbea31c748abeef9bd190d99481ba8a6a15e80614ba"></a>UGENDER_OTHER </td><td class="fielddoc"><p>Neutral gender. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006402">Stable:</a></b></dt><dd>ICU 50 </dd></dl>
</td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="ugender_8h_source.html#l00032">32</a> of file <a class="el" href="ugender_8h_source.html">ugender.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a44f759c78394ddc21fdbd65741d43014"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a44f759c78394ddc21fdbd65741d43014">◆ </a></span>ugender_getInstance()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> const <a class="el" href="ugender_8h.html#a14e446305ac789f24186e162f2f1a9f3">UGenderInfo</a>* 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#_stable006398">Stable:</a></b></dt><dd>ICU 50 </dd></dl>
</div>
</div>
<a id="add1b806deed811f122261e435e3a73f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#add1b806deed811f122261e435e3a73f6">◆ </a></span>ugender_getListGender()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> <a class="el" href="ugender_8h.html#a9506d61caf22a74908fc8fcbea31c748">UGender</a> ugender_getListGender </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ugender_8h.html#a14e446305ac789f24186e162f2f1a9f3">UGenderInfo</a> * </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#_stable006399">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.14
</small></address>
</body>
</html>