IEnvironment Class Reference

#include <IEnvironment.h>

Inheritance diagram for IEnvironment:

Public Types
enum	{ kDefaultIID = IID_IENVIRONMENT }

Public Member Functions
virtual int32	GetMajorSystemVersion () const =0
virtual int32	GetMinorSystemVersion () const =0
virtual int32	GetNumberOfScripts () const =0
virtual IDataBase::ByteSwapOrder	GetPlatformSwap () const =0
virtual PMString	GetCurrentDecimalPt () const =0
virtual PMString	GetCurrentThousandsSep () const =0
virtual PMString	GetSystemUserName () const =0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

Interface containing information about system configuration

Member Function Documentation

virtual PMString IEnvironment::GetCurrentDecimalPt ( ) const

pure virtual

Get the current OS level user setting for what character should be used for the decimal point. This is typically '.' for US english, and often ',' for european users. If you're tempted to use this function please look first at IWidgetUtils::FormatUserDecimal() and IWidgetUtils::StripUserDecimal(), which probably does what you want already.

Returns

a string consisting of the current decimal point as set by the user at the OS level.

virtual PMString IEnvironment::GetCurrentThousandsSep ( ) const

pure virtual

Get the current OS level user setting for what character should be used for the thousands character. This is typically ',' for US English users, and often '.' for European users.

Returns

a string consisting of the current thousands seperator as set by the user at the OS level.

virtual int32 IEnvironment::GetMajorSystemVersion ( ) const

pure virtual

Get OS major version information

Returns

major OS version number. i.e. on OS X 10.3.1 this will return 10

virtual int32 IEnvironment::GetMinorSystemVersion ( ) const

pure virtual

Get OS minor version information

Returns

minor OS version number. i.e. on OS X 10.3.1 this will return 31

virtual int32 IEnvironment::GetNumberOfScripts ( ) const

pure virtual

Get number of writing scripts supported by the OS

Returns

count of supported writing scripts

virtual IDataBase::ByteSwapOrder IEnvironment::GetPlatformSwap ( ) const

pure virtual

Get the byteswap order for the current platform

Returns

platform's native byte order. Should be either IDataBase::kMotorolaOrder or IDataBase::kIntelOrder

virtual PMString IEnvironment::GetSystemUserName ( ) const

pure virtual

Get the current OS level user setting for the current user's login name.

Returns

a string consisting of the user's name