Inheritance diagram for IGenericSettingsGroup:

Public Types
enum	{ kDefaultIID = IID_IGENERICSETTINGSGROUP }

Public Member Functions
virtual IGenericSettingsAttribute *	AddAttribute (const PMString pszName, const PMString pszValue, IGenericSettingsAttribute::AttributeFlags nFlags=IGenericSettingsAttribute::AttrTranslateBoth, bool16 bLocked=kFalse, bool16 bRelevant=kTrue)=0

virtual IGenericSettingsGroup *	AddGroup (const PMString pszName, const PMString pszValue, IGenericSettingsAttribute::AttributeFlags nFlags=IGenericSettingsAttribute::AttrTranslateBoth, bool16 bLocked=kFalse, bool16 bRelevant=kTrue)=0

virtual IGenericSettingsAttribute *	SetName (const PMString pszName, const PMString pszValue, IGenericSettingsAttribute::AttributeFlags nFlags=IGenericSettingsAttribute::AttrTranslateBoth, bool16 bLocked=kFalse, bool16 bRelevant=kTrue)=0

virtual IPMUnknownIterator *	GetAttributes ()=0

virtual IGenericSettingsAttribute *	GetName ()=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

IGenericSettingsGroup is used to describe a group of preset preference values.

Member Function Documentation

virtual IGenericSettingsAttribute* IGenericSettingsGroup::AddAttribute	(	const PMString	pszName,
		const PMString	pszValue,
		IGenericSettingsAttribute::AttributeFlags	nFlags = `IGenericSettingsAttribute::AttrTranslateBoth`,
		bool16	bLocked = `kFalse`,
		bool16	bRelevant = `kTrue`
	)

pure virtual

Add a preference value to the group.

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.

Returns: a pointer to an IGenericSettingsAttribute interface. It is is valid as long as this IGenericSettingsGroup interface is valid.

virtual IGenericSettingsGroup* IGenericSettingsGroup::AddGroup	(	const PMString	pszName,
		const PMString	pszValue,
		IGenericSettingsAttribute::AttributeFlags	nFlags = `IGenericSettingsAttribute::AttrTranslateBoth`,
		bool16	bLocked = `kFalse`,
		bool16	bRelevant = `kTrue`
	)

pure virtual

Create a sub group.

Parameters

pszName	is the name of the group.
pszValue	is the value of the group.
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.

Returns: a pointer to an IGenericSettingsGroup interface. The caller must release this interface when done.

virtual IPMUnknownIterator* IGenericSettingsGroup::GetAttributes ( )

pure virtual

Get an iterator to the list of attributes and sub-groups of this group.

Returns: a pointer to an IPMUnknownIterator interface. The caller must release this interface when done. The iterator returns IGenericSettingsAttribute interfaces. These are valid as long as this IGenericSettingsGroup interface is valid.

virtual IGenericSettingsAttribute* IGenericSettingsGroup::GetName ( )

pure virtual

Get the name of this group.

Returns: a pointer to an IGenericSettingsAttribute interface. It is is valid as long as this IGenericSettingsGroup interface is valid.

virtual IGenericSettingsAttribute* IGenericSettingsGroup::SetName	(	const PMString	pszName,
		const PMString	pszValue,
		IGenericSettingsAttribute::AttributeFlags	nFlags = `IGenericSettingsAttribute::AttrTranslateBoth`,
		bool16	bLocked = `kFalse`,
		bool16	bRelevant = `kTrue`
	)

pure virtual

Rename the group.

Parameters

pszName	is the name of the group.
pszValue	is the value of the group.
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.

Returns: a pointer to an IGenericSettingsAttribute interface. It is is valid as long as this IGenericSettingsGroup interface is valid.