LocaleIndex Class Reference

#include <LocaleIndex.h>

Public Member Functions
RsrcType	GetRsrcType () const
int32	GetLength () const
PMLocaleId	GetLocaleId (int32 index) const
RsrcID	GetRsrcId (int32 index) const
bool16	HasRsrcForLocale (const PMLocaleId &localeId) const
RsrcID	GetRsrcIdForLocale (const PMLocaleId &localeId) const

Detailed Description

This is the C++ definition for LocaleIndex resources, which allow us to load the proper localized resource depending on what Product FeatureSet + Language FeatureSet + UI language we're runing in.

See Also

PMLocaleId.h The layout of this class must match the layout of the resource declaration. NO VIRTUAL METHODS!

Member Function Documentation

int32 LocaleIndex::GetLength ( ) const

inline

Get the number of entries in this table

Returns

count of locale/resource entries

PMLocaleId LocaleIndex::GetLocaleId ( int32  index ) const

inline

Get locale id for a specific entry in the table

Parameters

the	requested index into the list

Returns

the requested locale id

RsrcID LocaleIndex::GetRsrcId ( int32  index ) const

inline

Get localized resource id for a specific entry in the table

Parameters

the	requested index into the list

Returns

the requested resource id

RsrcID LocaleIndex::GetRsrcIdForLocale

(

const PMLocaleId &

localeId

)

const

Get the localized resource id for the given locale. Does wildcard matching.

Parameters

the	locale we're interested in

Returns

the requested resource id

RsrcType LocaleIndex::GetRsrcType ( ) const

inline

Get the resource type, i.e. kStringTableRsrcType

Returns

the resource type

bool16 LocaleIndex::HasRsrcForLocale

(

const PMLocaleId &

localeId

)

const

Check if this locale index object has an entry for a localized resource id for the given locale. Does wildcard matching.

Parameters

the	locale we're interested in

Returns

kTrue if there is an entry in the list that matches the passed in locale.