Mac OS 9
Data Structures | Typedefs | Enumerations | Functions
MacLocales.h File Reference
System

Types & prototypes for locale functions. More...

#include <MacTypes.h>
#include <MacErrors.h>

Go to the source code of this file.

Data Structures

struct  LocaleAndVariant
 

Typedefs

typedef struct OpaqueLocaleRef * LocaleRef
 
typedef UInt32 LocalePartMask
 
typedef FourCharCode LocaleOperationClass
 
typedef FourCharCode LocaleOperationVariant
 
typedef struct LocaleAndVariant LocaleAndVariant
 
typedef UInt32 LocaleNameMask
 

Enumerations

enum  {
  kLocaleLanguageMask , kLocaleLanguageVariantMask = 1L << 1 , kLocaleScriptMask = 1L << 2 , kLocaleScriptVariantMask = 1L << 3 ,
  kLocaleRegionMask = 1L << 4 , kLocaleRegionVariantMask = 1L << 5 , kLocaleAllPartsMask = 0x0000003F
}
 
enum  { kLocaleNameMask = 1L << 0 , kLocaleOperationVariantNameMask , kLocaleAndVariantNameMask = 0x00000003 }
 

Functions

OSStatus LocaleRefFromLangOrRegionCode (LangCode lang, RegionCode region, LocaleRef *locale)
 
OSStatus LocaleRefFromLocaleString (const char localeString[], LocaleRef *locale)
 
OSStatus LocaleRefGetPartString (LocaleRef locale, LocalePartMask partMask, ByteCount maxStringLen, char partString[])
 
OSStatus LocaleStringToLangAndRegionCodes (const char localeString[], LangCode *lang, RegionCode *region)
 
OSStatus LocaleOperationCountLocales (LocaleOperationClass opClass, ItemCount *localeCount)
 
OSStatus LocaleOperationGetLocales (LocaleOperationClass opClass, ItemCount maxLocaleCount, ItemCount *actualLocaleCount, LocaleAndVariant localeVariantList[])
 
OSStatus LocaleGetName (LocaleRef locale, LocaleOperationVariant opVariant, LocaleNameMask nameMask, LocaleRef displayLocale, UniCharCount maxNameLen, UniCharCount *actualNameLen, UniChar displayName[])
 
OSStatus LocaleCountNames (LocaleRef locale, LocaleOperationVariant opVariant, LocaleNameMask nameMask, ItemCount *nameCount)
 
OSStatus LocaleGetIndName (LocaleRef locale, LocaleOperationVariant opVariant, LocaleNameMask nameMask, ItemCount nameIndex, UniCharCount maxNameLen, UniCharCount *actualNameLen, UniChar displayName[], LocaleRef *displayLocale)
 
OSStatus LocaleGetRegionLanguageName (RegionCode region, Str255 languageName)
 
OSStatus LocaleOperationGetName (LocaleOperationClass opClass, LocaleRef displayLocale, UniCharCount maxNameLen, UniCharCount *actualNameLen, UniChar displayName[])
 
OSStatus LocaleOperationCountNames (LocaleOperationClass opClass, ItemCount *nameCount)
 
OSStatus LocaleOperationGetIndName (LocaleOperationClass opClass, ItemCount nameIndex, UniCharCount maxNameLen, UniCharCount *actualNameLen, UniChar displayName[], LocaleRef *displayLocale)
 

Detailed Description

Types & prototypes for locale functions.

Introduced In: Mac OS 9.0
Avaliable From: Universal Interfaces 3.4.1
Copyright: © 1998-2001 by Apple Computer, Inc., all rights reserved.

For bug reports, consult the following page on the World Wide Web: 

http://developer.apple.com/bugreporter/

Typedef Documentation

◆ LocaleOperationVariant

typedef FourCharCode LocaleOperationVariant

constants for LocaleOperationClass are in UnicodeUtilities interfaces

◆ LocaleRef

typedef struct OpaqueLocaleRef* LocaleRef

TYPES & CONSTANTS

Enumeration Type Documentation

◆ anonymous enum

anonymous enum
Enumerator
kLocaleLanguageMask 

bit set requests the following:

kLocaleLanguageVariantMask 

ISO 639-1 or -2 language code (2 or 3 letters)

kLocaleScriptMask 

custom string for language variant

kLocaleScriptVariantMask 

ISO 15924 script code (2 letters)

kLocaleRegionMask 

custom string for script variant

kLocaleRegionVariantMask 

ISO 3166 country/region code (2 letters)

kLocaleAllPartsMask 

custom string for region variant

◆ anonymous enum

anonymous enum
Enumerator
kLocaleNameMask 

bit set requests the following:

kLocaleOperationVariantNameMask 

name of locale

kLocaleAndVariantNameMask 

name of LocaleOperationVariant

Function Documentation

◆ LocaleCountNames()

OSStatus LocaleCountNames ( LocaleRef  locale,
LocaleOperationVariant  opVariant,
LocaleNameMask  nameMask,
ItemCount *  nameCount 
)

LocaleCountNames()

Non-Carbon CFM: in LocalesLib 8.6 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ LocaleGetIndName()

OSStatus LocaleGetIndName ( LocaleRef  locale,
LocaleOperationVariant  opVariant,
LocaleNameMask  nameMask,
ItemCount  nameIndex,
UniCharCount  maxNameLen,
UniCharCount *  actualNameLen,
UniChar  displayName[],
LocaleRef *  displayLocale 
)

LocaleGetIndName()

Non-Carbon CFM: in LocalesLib 8.6 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ LocaleGetName()

OSStatus LocaleGetName ( LocaleRef  locale,
LocaleOperationVariant  opVariant,
LocaleNameMask  nameMask,
LocaleRef  displayLocale,
UniCharCount  maxNameLen,
UniCharCount *  actualNameLen,
UniChar  displayName[] 
)

Get names for a locale (or a region's language) LocaleGetName()

Non-Carbon CFM: in LocalesLib 8.6 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ LocaleGetRegionLanguageName()

OSStatus LocaleGetRegionLanguageName ( RegionCode  region,
Str255  languageName 
)

LocaleGetRegionLanguageName()

Non-Carbon CFM: in LocalesLib 9.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ LocaleOperationCountLocales()

OSStatus LocaleOperationCountLocales ( LocaleOperationClass  opClass,
ItemCount *  localeCount 
)

Enumerate locales for a LocaleOperationClass LocaleOperationCountLocales()

Non-Carbon CFM: in LocalesLib 8.6 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ LocaleOperationCountNames()

OSStatus LocaleOperationCountNames ( LocaleOperationClass  opClass,
ItemCount *  nameCount 
)

LocaleOperationCountNames()

Non-Carbon CFM: in LocalesLib 8.6 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ LocaleOperationGetIndName()

OSStatus LocaleOperationGetIndName ( LocaleOperationClass  opClass,
ItemCount  nameIndex,
UniCharCount  maxNameLen,
UniCharCount *  actualNameLen,
UniChar  displayName[],
LocaleRef *  displayLocale 
)

LocaleOperationGetIndName()

Non-Carbon CFM: in LocalesLib 8.6 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ LocaleOperationGetLocales()

OSStatus LocaleOperationGetLocales ( LocaleOperationClass  opClass,
ItemCount  maxLocaleCount,
ItemCount *  actualLocaleCount,
LocaleAndVariant  localeVariantList[] 
)

LocaleOperationGetLocales()

Non-Carbon CFM: in LocalesLib 8.6 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ LocaleOperationGetName()

OSStatus LocaleOperationGetName ( LocaleOperationClass  opClass,
LocaleRef  displayLocale,
UniCharCount  maxNameLen,
UniCharCount *  actualNameLen,
UniChar  displayName[] 
)

Get names for a LocaleOperationClass LocaleOperationGetName()

Non-Carbon CFM: in LocalesLib 8.6 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ LocaleRefFromLangOrRegionCode()

OSStatus LocaleRefFromLangOrRegionCode ( LangCode  lang,
RegionCode  region,
LocaleRef *  locale 
)

FUNCTION PROTOTYPES

Convert to or from LocaleRefs (and related utilities) LocaleRefFromLangOrRegionCode()

Non-Carbon CFM: in LocalesLib 8.6 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ LocaleRefFromLocaleString()

OSStatus LocaleRefFromLocaleString ( const char  localeString[],
LocaleRef *  locale 
)

LocaleRefFromLocaleString()

Non-Carbon CFM: in LocalesLib 8.6 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ LocaleRefGetPartString()

OSStatus LocaleRefGetPartString ( LocaleRef  locale,
LocalePartMask  partMask,
ByteCount  maxStringLen,
char  partString[] 
)

LocaleRefGetPartString()

Non-Carbon CFM: in LocalesLib 8.6 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ LocaleStringToLangAndRegionCodes()

OSStatus LocaleStringToLangAndRegionCodes ( const char  localeString[],
LangCode *  lang,
RegionCode *  region 
)

LocaleStringToLangAndRegionCodes()

Non-Carbon CFM: in LocalesLib 9.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later