All Frameworks Class Hierarchy This Framework Next Indexes
StructureInterfaces Interface CATIStrColorESSObjectSettingAtt
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIStrColorESSObjectSettingAtt
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIStrColorESSObjectSettingAtt
Describe the ESSctionality of your interface here.
Using this prefered syntax will enable mkdoc to document your class.
Method Index
- o
GetMemberColor(unsigned int&,unsigned int&,unsigned int&)
- Retrieves the MemberColor attribute.
- o
GetMemberColorInfo(CATSettingInfo*)
- Retrieves the state of the MemberColor parameter.
- o
GetPlateColor(unsigned int&,unsigned int&,unsigned int&)
- Retrieves the PlateColor attribute.
- o
GetPlateColorInfo(CATSettingInfo*)
- Retrieves the state of the PlateColor parameter.
- o
SetMemberColor(unsigned int,unsigned int,unsigned int)
- Sets the MemberColor attribute.
- o
SetMemberColorLock(unsigned char)
- Locks or unlocks the MemberColor parameter.
- o
SetPlateColor(unsigned int,unsigned int,unsigned int)
- Sets the PlateColor attribute.
- o
SetPlateColorLock(unsigned char)
- Locks or unlocks the PlateColor parameter.
Methods
o GetMemberColor
public virtual HRESULT GetMemberColor( | unsigned int& | oMemberColorR, |
| unsigned int& | oMemberColorG, |
| unsigned int& | oMemberColorB)= 0 |
-
Retrieves the MemberColor attribute.
o GetMemberColorInfo
-
Retrieves the state of the MemberColor parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetPlateColor
public virtual HRESULT GetPlateColor( | unsigned int& | oPlateColorR, |
| unsigned int& | oPlateColorG, |
| unsigned int& | oPlateColorB)= 0 |
-
Retrieves the PlateColor attribute.
o GetPlateColorInfo
-
Retrieves the state of the PlateColor parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetMemberColor
public virtual HRESULT SetMemberColor( | unsigned int | iMemberColorR, |
| unsigned int | iMemberColorG, |
| unsigned int | iMemberColorB)= 0 |
-
Sets the MemberColor attribute.
o SetMemberColorLock
public virtual HRESULT SetMemberColorLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the MemberColor parameter.
Role: Locks or unlocks the MemberColor parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetPlateColor
public virtual HRESULT SetPlateColor( | unsigned int | iPlateColorR, |
| unsigned int | iPlateColorG, |
| unsigned int | iPlateColorB)= 0 |
-
Sets the PlateColor attribute.
o SetPlateColorLock
public virtual HRESULT SetPlateColorLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the PlateColor parameter.
Role: Locks or unlocks the PlateColor parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
This object is included in the file: CATIStrColorESSObjectSettingAtt.h
If needed, your Imakefile.mk should include the module: CATStrSettingsItf