All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

StructureInterfaces Interface CATIStrColorSTDObjectSettingAtt

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIStrColorSTDObjectSettingAtt
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATIStrColorSTDObjectSettingAtt

Describe the STDctionality of your interface here.

Using this prefered syntax will enable mkdoc to document your class.


Method Index


o GetPlateColor(unsigned int&,unsigned int&,unsigned int&)
Retrieves the PlateColor attribute.
o GetPlateColorInfo(CATSettingInfo*)
Retrieves the state of the PlateColor parameter.
o GetShapeColor(unsigned int&,unsigned int&,unsigned int&)
Retrieves the ShapeColor attribute.
o GetShapeColorInfo(CATSettingInfo*)
Retrieves the state of the ShapeColor parameter.
o SetPlateColor(unsigned int,unsigned int,unsigned int)
Sets the PlateColor attribute.
o SetPlateColorLock(unsigned char)
Locks or unlocks the PlateColor parameter.
o SetShapeColor(unsigned int,unsigned int,unsigned int)
Sets the ShapeColor attribute.
o SetShapeColorLock(unsigned char)
Locks or unlocks the ShapeColor parameter.

Methods


o GetPlateColor
public virtual HRESULT GetPlateColor(unsigned int& oPlateColorR,
unsigned int& oPlateColorG,
unsigned int& oPlateColorB)= 0
Retrieves the PlateColor attribute.
o GetPlateColorInfo
public virtual HRESULT GetPlateColorInfo(CATSettingInfo* oInfo)= 0
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 GetShapeColor
public virtual HRESULT GetShapeColor(unsigned int& oShapeColorR,
unsigned int& oShapeColorG,
unsigned int& oShapeColorB)= 0
Retrieves the ShapeColor attribute.
o GetShapeColorInfo
public virtual HRESULT GetShapeColorInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the ShapeColor parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
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
o SetShapeColor
public virtual HRESULT SetShapeColor(unsigned int iShapeColorR,
unsigned int iShapeColorG,
unsigned int iShapeColorB)= 0
Sets the ShapeColor attribute.
o SetShapeColorLock
public virtual HRESULT SetShapeColorLock(unsigned char iLocked)= 0
Locks or unlocks the ShapeColor parameter.
Role: Locks or unlocks the ShapeColor 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: CATIStrColorSTDObjectSettingAtt.h
If needed, your Imakefile.mk should include the module: CATStrSettingsItf

Copyright © 2003, Dassault Systèmes. All rights reserved.