ugender.h File Reference

C API: The purpose of this API is to compute the gender of a list as a whole given the gender of each element. More...

#include "unicode/utypes.h"
#include "unicode/localpointer.h"

Go to the source code of this file.

Typedefs

typedef enum UGender UGender
typedef struct UGenderInfo UGenderInfo

Enumerations

enum  UGender { UGENDER_MALE, UGENDER_FEMALE, UGENDER_OTHER }
 

Genders.

More...

Functions

const UGenderInfo * ugender_getInstance (const char *locale, UErrorCode *status)
 Opens a new UGenderInfo object given locale.
UGender ugender_getListGender (const UGenderInfo *genderinfo, const UGender *genders, int32_t size, UErrorCode *status)
 Given a list, returns the gender of the list as a whole.

Detailed Description

C API: The purpose of this API is to compute the gender of a list as a whole given the gender of each element.

Definition in file ugender.h.


Typedef Documentation

typedef enum UGender UGender
Draft:
This API may be changed in the future versions and was introduced in ICU 50

Definition at line 48 of file ugender.h.


Enumeration Type Documentation

enum UGender

Genders.

Draft:
This API may be changed in the future versions and was introduced in ICU 50
Enumerator:
UGENDER_MALE 

Male gender.

Draft:
This API may be changed in the future versions and was introduced in ICU 50
UGENDER_FEMALE 

Female gender.

Draft:
This API may be changed in the future versions and was introduced in ICU 50
UGENDER_OTHER 

Neutral gender.

Draft:
This API may be changed in the future versions and was introduced in ICU 50

Definition at line 28 of file ugender.h.


Function Documentation

const UGenderInfo* ugender_getInstance ( const char *  locale,
UErrorCode status 
)

Opens a new UGenderInfo object given locale.

Parameters:
locale The locale for which the rules are desired.
Returns:
A UGenderInfo for the specified locale, or NULL if an error occurred.
Draft:
This API may be changed in the future versions and was introduced in ICU 50
UGender ugender_getListGender ( const UGenderInfo *  genderinfo,
const UGender genders,
int32_t  size,
UErrorCode status 
)

Given a list, returns the gender of the list as a whole.

Parameters:
genderInfo pointer that ugender_getInstance returns.
genders the gender of each element in the list.
size the size of the list.
status A pointer to a UErrorCode to receive any errors.
Returns:
The gender of the list.
Draft:
This API may be changed in the future versions and was introduced in ICU 50

Generated on 27 Mar 2014 for ICU 50.1.2 by  doxygen 1.6.1