Inheritance diagram for IGenericSettingsAttribute:

Public Types
enum	{ kDefaultIID = IID_IGENERICSETTINGSATTRIBUTE }

enum	AttributeFlags { AttrTranslateNone = 0x00, AttrTranslateName = 0x01, AttrTranslateValue = 0x02, AttrTranslateBoth = 0x03 }

Public Member Functions
virtual void	Initialize (const PMString pszName, const PMString strValue, AttributeFlags nFlags=AttrTranslateBoth, bool16 bLocked=kFalse, bool16 bRelevant=kTrue)=0

virtual void	SetRelevant (bool16 bRelevant)=0

virtual void	SetLocked (bool16 bLocked)=0

virtual void	GetName (PMString &strName)=0

virtual void	GetValue (PMString &strValue)=0

virtual bool16	GetLocked ()=0

virtual bool16	GetRelevant ()=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

This holds the name, value and other state of a preset preference.

Member Function Documentation

virtual bool16 IGenericSettingsAttribute::GetLocked ( )

pure virtual

Get the preference's locked state.

virtual void IGenericSettingsAttribute::GetName ( PMString & strName )

pure virtual

Get the preference's name.

Parameters

pszName filled in with the name.

virtual bool16 IGenericSettingsAttribute::GetRelevant ( )

pure virtual

Get the preference's relevant state.

virtual void IGenericSettingsAttribute::GetValue ( PMString & strValue )

pure virtual

Get the preference's value.

Parameters

strValue filled in with the value string.

virtual void IGenericSettingsAttribute::Initialize	(	const PMString	pszName,
		const PMString	strValue,
		AttributeFlags	nFlags = `AttrTranslateBoth`,
		bool16	bLocked = `kFalse`,
		bool16	bRelevant = `kTrue`
	)

pure virtual

Initialize the name, value and state of this preference.

Parameters

pszName	is the name of the preference.
pszValue	is the value of the preference.
nFlags	is an optional parameter whether to translate the name or value or both. The default is both.
bLocked	is an optional parameter of the preference's locked state. The default is kFalse.
bRelevant	is an optional parameter whether the preference is relevant. The default is kTrue.

virtual void IGenericSettingsAttribute::SetLocked ( bool16 bLocked )

pure virtual

Set the locked flag of this preference.

Parameters

bLocked is the preference's is locked state.

virtual void IGenericSettingsAttribute::SetRelevant ( bool16 bRelevant )

pure virtual

Set the relevant flag of this preference.

Parameters

bRelevant is the preference's is relevant state.