All Frameworks Class Hierarchy This Framework Indexes
StructureInterfaces Interface CATIStrMaterialESSObjectSettingAtt
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIStrMaterialESSObjectSettingAtt
Describe the ESSctionality of your interface here.
Using this prefered syntax will enable mkdoc to document your class.
Method Index
- o
GetMemberMaterialInfo(CATSettingInfo*)
- Retrieves the state of the MemberMaterial parameter.
- o
GetMemberMaterial(CATUnicodeString&)
- Retrieves the MemberMaterial attribute.
- o
GetPlateMaterialInfo(CATSettingInfo*)
- Retrieves the state of the PlateMaterial parameter.
- o
GetPlateMaterial(CATUnicodeString&)
- Retrieves the PlateMaterial attribute.
- o
SetMemberMaterialLock(unsigned char)
- Locks or unlocks the MemberMaterial parameter.
- o
SetMemberMaterial(CATUnicodeString&)
- Sets the MemberMaterial attribute.
- o
SetPlateMaterialLock(unsigned char)
- Locks or unlocks the PlateMaterial parameter.
- o
SetPlateMaterial(CATUnicodeString&)
- Sets the PlateMaterial attribute.
Methods
o GetMemberMaterialInfo
| public virtual GetMemberMaterialInfo( | | oInfo) |
-
Retrieves the state of the MemberMaterial parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetMemberMaterial
| public virtual GetMemberMaterial( | | oMemberMaterial) |
-
Retrieves the MemberMaterial attribute.
o GetPlateMaterialInfo
| public virtual GetPlateMaterialInfo( | | oInfo) |
-
Retrieves the state of the PlateMaterial parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetPlateMaterial
| public virtual GetPlateMaterial( | | oPlateMaterial) |
-
Retrieves the PlateMaterial attribute.
o SetMemberMaterialLock
| public virtual SetMemberMaterialLock( | | iLocked) |
-
Locks or unlocks the MemberMaterial parameter.
Role: Locks or unlocks the MemberMaterial 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 SetMemberMaterial
| public virtual SetMemberMaterial( | | iMemberMaterial) |
-
Sets the MemberMaterial attribute.
o SetPlateMaterialLock
| public virtual SetPlateMaterialLock( | | iLocked) |
-
Locks or unlocks the PlateMaterial parameter.
Role: Locks or unlocks the PlateMaterial 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 SetPlateMaterial
| public virtual SetPlateMaterial( | | iPlateMaterial) |
-
Sets the PlateMaterial attribute.
This object is included in the file: CATIStrMaterialESSObjectSettingAtt.h
If needed, your Imakefile.mk should include the module: CATStrSettingsItf