IDSSLocale Interface Reference

List of all members.

---

Detailed Description

A DSSLocale object describes a locale which is either a language or a language in combination with a country.

DSSLocale is first-class object. At the core, it is presented by an integer ID (LCID) which is unique in the locale space. The LCID mapping follows the Microsoft convention.

Public Member Functions
HRESULT	BaseLocale ([in] IDSSLocale *ipLocale)
	Set the base locale object of this instance.
HRESULT	BaseLocale ([out, retval] IDSSLocale oppLocale)
	Return the base locale object of this instance.
HRESULT	Info ([out, retval] IDSSObjectInfo oppObjectInfo)
	The IDSSObjectInfo interface associated with this locale.
HRESULT	LocaleID ([in] Int32 iLocaleID)
	Set the locale ID this instance is representing.
HRESULT	LocaleID ([out, retval] Int32 *opLocaleID)
	Return the locale ID this instance is representing.
HRESULT	Populate ([in] IDSSLocale *ipLocale)
	Populate the contents of this instance from another.

---

Member Function Documentation

HRESULT IDSSLocale::BaseLocale (  [in] IDSSLocale *  ipLocale  )

Set the base locale object of this instance. Parameters: ipLocale  The base locale object of this instance. Returns: Usual COM result code: S_OK

HRESULT IDSSLocale::BaseLocale (  [out, retval] IDSSLocale   oppLocale  )

Return the base locale object of this instance. Parameters: oppLocale  The base locale object of this instance. Returns: Usual COM result code: S_OK

HRESULT IDSSLocale::Info (  [out, retval] IDSSObjectInfo   oppObjectInfo  )

The IDSSObjectInfo interface associated with this locale. This property returns the IDSSObjectInfo interface associated with this object. This interface contains many standard properties and methods. For example, it contains a Name property and a Comments property. It contains methods to save the object. Parameters: oppObjectInfo  The standard IDSSObjectInfo interface on this object. Returns: Usual COM result code: S_OK

HRESULT IDSSLocale::LocaleID (  [in] Int32  iLocaleID  )

Set the locale ID this instance is representing. Parameters: iLocaleID  The locale ID this instance is representing. Returns: Usual COM result code: S_OK

HRESULT IDSSLocale::LocaleID (  [out, retval] Int32 *  opLocaleID  )

Return the locale ID this instance is representing. One should be able to find out what this language is by looking up this ID in Microsoft Windows LCID code table. Parameters: opLocaleID  The locale ID this instance is representing. Returns: Usual COM result code: S_OK

HRESULT IDSSLocale::Populate (  [in] IDSSLocale *  ipLocale  )

Populate the contents of this instance from another. Parameters: ipLocale  The instance from which to populate this one. Returns: Usual COM result code: S_OK

---