All Frameworks Class Hierarchy This Framework Indexes
StructureInterfaces Interface CATIStrTypeESSObjectSettingAtt
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIStrTypeESSObjectSettingAtt
Describe the SFDctionality of your interface here.
Using this prefered syntax will enable mkdoc to document your class.
Method Index
- o
GetMemberTypesInfo(CATSettingInfo*)
- Retrieves the state of the MemberTypes parameter.
- o
GetMemberTypes(CATUnicodeString&)
- Retrieves the MemberTypes attribute.
- o
GetPlateTypesInfo(CATSettingInfo*)
- Retrieves the state of the PlateTypes parameter.
- o
GetPlateTypes(CATUnicodeString&)
- Retrieves the PlateTypes attribute.
- o
SetMemberTypesLock(unsigned char)
- Locks or unlocks the MemberTypes parameter.
- o
SetMemberTypes(CATUnicodeString&)
- Sets the MemberTypes attribute.
- o
SetPlateTypesLock(unsigned char)
- Locks or unlocks the PlateTypes parameter.
- o
SetPlateTypes(CATUnicodeString&)
- Sets the PlateTypes attribute.
Methods
o GetMemberTypesInfo
| public virtual GetMemberTypesInfo( | | oInfo) |
-
Retrieves the state of the MemberTypes parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetMemberTypes
| public virtual GetMemberTypes( | | oMemberTypes) |
-
Retrieves the MemberTypes attribute.
o GetPlateTypesInfo
| public virtual GetPlateTypesInfo( | | oInfo) |
-
Retrieves the state of the PlateTypes parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetPlateTypes
| public virtual GetPlateTypes( | | oPlateTypes) |
-
Retrieves the PlateTypes attribute.
o SetMemberTypesLock
| public virtual SetMemberTypesLock( | | iLocked) |
-
Locks or unlocks the MemberTypes parameter.
Role: Locks or unlocks the MemberTypes 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 SetMemberTypes
| public virtual SetMemberTypes( | | iMemberTypes) |
-
Sets the MemberTypes attribute.
o SetPlateTypesLock
| public virtual SetPlateTypesLock( | | iLocked) |
-
Locks or unlocks the PlateTypes parameter.
Role: Locks or unlocks the PlateTypes 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 SetPlateTypes
| public virtual SetPlateTypes( | | iPlateTypes) |
-
Sets the PlateTypes attribute.
This object is included in the file: CATIStrTypeESSObjectSettingAtt.h
If needed, your Imakefile.mk should include the module: CATStrSettingsItf