All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

StructureInterfaces Interface CATIStrTypeESSObjectSettingAtt

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---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 GetMemberTypes(CATUnicodeString&)
Retrieves the MemberTypes attribute.
o GetMemberTypesInfo(CATSettingInfo*)
Retrieves the state of the MemberTypes parameter.
o GetPlateTypes(CATUnicodeString&)
Retrieves the PlateTypes attribute.
o GetPlateTypesInfo(CATSettingInfo*)
Retrieves the state of the PlateTypes parameter.
o SetMemberTypes(CATUnicodeString&)
Sets the MemberTypes attribute.
o SetMemberTypesLock(unsigned char)
Locks or unlocks the MemberTypes parameter.
o SetPlateTypes(CATUnicodeString&)
Sets the PlateTypes attribute.
o SetPlateTypesLock(unsigned char)
Locks or unlocks the PlateTypes parameter.

Methods


o GetMemberTypes
public virtual HRESULT GetMemberTypes(CATUnicodeString& oMemberTypes)= 0
Retrieves the MemberTypes attribute.
o GetMemberTypesInfo
public virtual HRESULT GetMemberTypesInfo(CATSettingInfo* oInfo)= 0
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 GetPlateTypes
public virtual HRESULT GetPlateTypes(CATUnicodeString& oPlateTypes)= 0
Retrieves the PlateTypes attribute.
o GetPlateTypesInfo
public virtual HRESULT GetPlateTypesInfo(CATSettingInfo* oInfo)= 0
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 SetMemberTypes
public virtual HRESULT SetMemberTypes(CATUnicodeString& iMemberTypes)= 0
Sets the MemberTypes attribute.
o SetMemberTypesLock
public virtual HRESULT SetMemberTypesLock(unsigned char iLocked)= 0
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 SetPlateTypes
public virtual HRESULT SetPlateTypes(CATUnicodeString& iPlateTypes)= 0
Sets the PlateTypes attribute.
o SetPlateTypesLock
public virtual HRESULT SetPlateTypesLock(unsigned char iLocked)= 0
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

This object is included in the file: CATIStrTypeESSObjectSettingAtt.h
If needed, your Imakefile.mk should include the module: CATStrSettingsItf

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