All Frameworks Class Hierarchy This Framework Previous Next Indexes
StructureInterfaces Interface CATIStrMaterialESSObjectSettingAtt
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---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
GetMemberMaterial(CATUnicodeString&)
- Retrieves the MemberMaterial attribute.
- o
GetMemberMaterialInfo(CATSettingInfo*)
- Retrieves the state of the MemberMaterial parameter.
- o
GetPlateMaterial(CATUnicodeString&)
- Retrieves the PlateMaterial attribute.
- o
GetPlateMaterialInfo(CATSettingInfo*)
- Retrieves the state of the PlateMaterial parameter.
- o
SetMemberMaterial(CATUnicodeString&)
- Sets the MemberMaterial attribute.
- o
SetMemberMaterialLock(unsigned char)
- Locks or unlocks the MemberMaterial parameter.
- o
SetPlateMaterial(CATUnicodeString&)
- Sets the PlateMaterial attribute.
- o
SetPlateMaterialLock(unsigned char)
- Locks or unlocks the PlateMaterial parameter.
Methods
o GetMemberMaterial
-
Retrieves the MemberMaterial attribute.
o GetMemberMaterialInfo
-
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 GetPlateMaterial
-
Retrieves the PlateMaterial attribute.
o GetPlateMaterialInfo
-
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 SetMemberMaterial
-
Sets the MemberMaterial attribute.
o SetMemberMaterialLock
public virtual HRESULT SetMemberMaterialLock( | unsigned char | iLocked)= 0 |
-
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 SetPlateMaterial
-
Sets the PlateMaterial attribute.
o SetPlateMaterialLock
public virtual HRESULT SetPlateMaterialLock( | unsigned char | iLocked)= 0 |
-
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
This object is included in the file: CATIStrMaterialESSObjectSettingAtt.h
If needed, your Imakefile.mk should include the module: CATStrSettingsItf