All Frameworks  Class Hierarchy  This Framework  Next  Indexes

CATFunctSystemItf Interface CATIFsyFunctionalSystemSettingAtt

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

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


interface CATIFsyFunctionalSystemSettingAtt

Enables attribute access to PFD options.


Method Index


o GetDocumentContentAtCreationAtt(long&)
Retrieves the DocumentContentAtCreation attribute.
o GetDocumentContentAtCreationInfo(CATSettingInfo*)
Retrieves the state of the DocumentContentAtCreation parameter.
o GetFunctionalActionPresentationAtt(long&)
Retrieves the DocumentContentAtCreation attribute.
o GetFunctionalActionPresentationInfo(CATSettingInfo*)
Retrieves the state of the DocumentContentAtCreation parameter.
o GetShowParametersAtt(long&)
Retrieves the ShowParameters attribute.
o GetShowParametersInfo(CATSettingInfo*)
Retrieves the state of the ShowParameters parameter.
o GetShowRelationsAtt(long&)
Retrieves the Show Relations attribute.
o GetShowRelationsInfo(CATSettingInfo*)
Retrieves the state of the Show Relations parameter.
o GetShowSynchroStatusOfLocalParamCacheAtt(long&)
Retrieves the ShowSynchroStatusOfLocalParamCache attribute.
o GetShowSynchroStatusOfLocalParamCacheInfo(CATSettingInfo*)
Retrieves the state of the ShowSynchroStatusOfLocalParamCache parameter.
o GetSplitFunctionalObjectNameAtt(long&)
Retrieves the SplitFunctionalObjectName attribute.
o GetSplitFunctionalObjectNameInfo(CATSettingInfo*)
Retrieves the state of the SplitFunctionalObjectName parameter.
o GetStringUsedAsCarriageReturnAtt(CATUnicodeString&)
Retrieves the StringUsedAsCarriageReturn attribute.
o GetStringUsedAsCarriageReturnInfo(CATSettingInfo*)
Retrieves the state of the StringUsedAsCarriageReturn parameter.
o GetTypeOfIconOnFunctionalElementAtt(long&)
Retrieves the TypeOfIconOnFunctionalElement attribute.
o GetTypeOfIconOnFunctionalElementInfo(CATSettingInfo*)
Retrieves the state of the TypeOfIconOnFunctionalElement parameter.
o SetDocumentContentAtCreationAtt(long)
Sets the DocumentContentAtCreation attribute.
o SetDocumentContentAtCreationLock(unsigned char)
Locks or unlocks the DocumentContentAtCreation parameter.
o SetFunctionalActionPresentationAtt(long)
Sets the DocumentContentAtCreation attribute.
o SetFunctionalActionPresentationLock(unsigned char)
Locks or unlocks the DocumentContentAtCreation parameter.
o SetShowParametersAtt(long)
Sets the ShowParameters attribute.
o SetShowParametersLock(unsigned char)
Locks or unlocks the ShowParameters parameter.
o SetShowRelationsAtt(long)
Sets the Show Relations attribute.
o SetShowRelationsLock(unsigned char)
Locks or unlocks the Show Relations parameter.
o SetShowSynchroStatusOfLocalParamCacheAtt(long)
Sets the ShowSynchroStatusOfLocalParamCache attribute.
o SetShowSynchroStatusOfLocalParamCacheLock(unsigned char)
Locks or unlocks the ShowSynchroStatusOfLocalParamCache parameter.
o SetSplitFunctionalObjectNameAtt(long)
Sets the SplitFunctionalObjectName attribute.
o SetSplitFunctionalObjectNameLock(unsigned char)
Locks or unlocks the SplitFunctionalObjectName parameter.
o SetStringUsedAsCarriageReturnAtt(CATUnicodeString&)
Sets the StringUsedAsCarriageReturn attribute.
o SetStringUsedAsCarriageReturnLock(unsigned char)
Locks or unlocks the StringUsedAsCarriageReturn parameter.
o SetTypeOfIconOnFunctionalElementAtt(long)
Sets the TypeOfIconOnFunctionalElement attribute.
o SetTypeOfIconOnFunctionalElementLock(unsigned char)
Locks or unlocks the TypeOfIconOnFunctionalElement parameter.

Methods


o GetDocumentContentAtCreationAtt
public virtual HRESULT GetDocumentContentAtCreationAtt(long& oDocumentContentAtCreation)= 0
Retrieves the DocumentContentAtCreation attribute.
Parameters:
oDocumentContentAtCreation
Document Content At Creation Attribute Legal values:
0 : Sample elements
1: empty
o GetDocumentContentAtCreationInfo
public virtual HRESULT GetDocumentContentAtCreationInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the DocumentContentAtCreation parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetFunctionalActionPresentationAtt
public virtual HRESULT GetFunctionalActionPresentationAtt(long& oFunctionalActionPresentation)= 0
Retrieves the DocumentContentAtCreation attribute.
Parameters:
oFunctionalActionPresentation
Functional Action Presentation Legal values:
0 : A : Action
1: SAO : Subject Action Object
2: ASO : Action Subject Object
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetFunctionalActionPresentationInfo
public virtual HRESULT GetFunctionalActionPresentationInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the DocumentContentAtCreation parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetShowParametersAtt
public virtual HRESULT GetShowParametersAtt(long& oShowParameters)= 0
Retrieves the ShowParameters attribute.
Parameters:
oShowParameters
Show Parameters Legal values:
False :
True :
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetShowParametersInfo
public virtual HRESULT GetShowParametersInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the ShowParameters parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetShowRelationsAtt
public virtual HRESULT GetShowRelationsAtt(long& oShowRelations)= 0
Retrieves the Show Relations attribute.
Parameters:
oShowRelations
Show Relations Legal values:
False :
True :
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetShowRelationsInfo
public virtual HRESULT GetShowRelationsInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the Show Relations parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetShowSynchroStatusOfLocalParamCacheAtt
public virtual HRESULT GetShowSynchroStatusOfLocalParamCacheAtt(long& oShowSynchroStatusOfLocalParamCache)= 0
Retrieves the ShowSynchroStatusOfLocalParamCache attribute.
Parameters:
oShowSynchroStatusOfLocalParamCache
Show Synchronisation Status OfLocal Parameter Cache Legal values:
False :
True :
o GetShowSynchroStatusOfLocalParamCacheInfo
public virtual HRESULT GetShowSynchroStatusOfLocalParamCacheInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the ShowSynchroStatusOfLocalParamCache parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetSplitFunctionalObjectNameAtt
public virtual HRESULT GetSplitFunctionalObjectNameAtt(long& oSplitFunctionalObjectName)= 0
Retrieves the SplitFunctionalObjectName attribute.
Parameters:
oSplitFunctionalObjectName
Legal values:
0 : don't split functional object name
1: split Functional object name
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetSplitFunctionalObjectNameInfo
public virtual HRESULT GetSplitFunctionalObjectNameInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the SplitFunctionalObjectName parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetStringUsedAsCarriageReturnAtt
public virtual HRESULT GetStringUsedAsCarriageReturnAtt(CATUnicodeString& oStringUsedAsCarriageReturn)= 0
Retrieves the StringUsedAsCarriageReturn attribute.
Parameters:
oStringUsedAsCarriageReturn
String Used As Carriage Return
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetStringUsedAsCarriageReturnInfo
public virtual HRESULT GetStringUsedAsCarriageReturnInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the StringUsedAsCarriageReturn parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetTypeOfIconOnFunctionalElementAtt
public virtual HRESULT GetTypeOfIconOnFunctionalElementAtt(long& oTypeOfIconOnFunctionalElement)= 0
Retrieves the TypeOfIconOnFunctionalElement attribute.
Parameters:
oTypeOfIconOnFunctionalElement
Type Of Icon On FunctionalElement Legal values:
0 : indicate a current association with PPR links.
1: indicate a current generative script.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetTypeOfIconOnFunctionalElementInfo
public virtual HRESULT GetTypeOfIconOnFunctionalElementInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the TypeOfIconOnFunctionalElement parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetDocumentContentAtCreationAtt
public virtual HRESULT SetDocumentContentAtCreationAtt( const long iDocumentContentAtCreation)= 0
Sets the DocumentContentAtCreation attribute.
Parameters:
iDocumentContentAtCreation
Document Content At Creation Attribute Legal values:
0 : Sample elements
1: empty
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetDocumentContentAtCreationLock
public virtual HRESULT SetDocumentContentAtCreationLock(unsigned char iLocked)= 0
Locks or unlocks the DocumentContentAtCreation parameter.
Role: Locks or unlocks the DocumentContentAtCreation 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 SetFunctionalActionPresentationAtt
public virtual HRESULT SetFunctionalActionPresentationAtt( const long iFunctionalActionPresentation)= 0
Sets the DocumentContentAtCreation attribute.
Parameters:
iFunctionalActionPresentation
Functional Action Presentation Legal values:
0 : A : Action
1: SAO : Subject Action Object
2: ASO : Action Subject Object
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetFunctionalActionPresentationLock
public virtual HRESULT SetFunctionalActionPresentationLock(unsigned char iLocked)= 0
Locks or unlocks the DocumentContentAtCreation parameter.
Role: Locks or unlocks the DocumentContentAtCreation 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 SetShowParametersAtt
public virtual HRESULT SetShowParametersAtt( const long iShowParameters)= 0
Sets the ShowParameters attribute.
Parameters:
iShowParameters
Show Parameters Legal values:
False :
True:
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetShowParametersLock
public virtual HRESULT SetShowParametersLock(unsigned char iLocked)= 0
Locks or unlocks the ShowParameters parameter.
Role: Locks or unlocks the ShowParameters 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 SetShowRelationsAtt
public virtual HRESULT SetShowRelationsAtt( const long iShowRelations)= 0
Sets the Show Relations attribute.
Parameters:
iShowRelations
Show Relations Legal values:
False :
True :
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetShowRelationsLock
public virtual HRESULT SetShowRelationsLock(unsigned char iLocked)= 0
Locks or unlocks the Show Relations parameter.
Role: Locks or unlocks the Show Relations 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 SetShowSynchroStatusOfLocalParamCacheAtt
public virtual HRESULT SetShowSynchroStatusOfLocalParamCacheAtt( const long iShowSynchroStatusOfLocalParamCache)= 0
Sets the ShowSynchroStatusOfLocalParamCache attribute.
Parameters:
iShowSynchroStatusOfLocalParamCache
Show Synchronisation Status OfLocal Parameter Cache Legal values:
False :
True :
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetShowSynchroStatusOfLocalParamCacheLock
public virtual HRESULT SetShowSynchroStatusOfLocalParamCacheLock(unsigned char iLocked)= 0
Locks or unlocks the ShowSynchroStatusOfLocalParamCache parameter.
Role: Locks or unlocks the Show Relations 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 SetSplitFunctionalObjectNameAtt
public virtual HRESULT SetSplitFunctionalObjectNameAtt( const long iSplitFunctionalObjectName)= 0
Sets the SplitFunctionalObjectName attribute.
Parameters:
iSplitFunctionalObjectName
Legal values:
False : don't split functional object name
True: split Functional object name
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetSplitFunctionalObjectNameLock
public virtual HRESULT SetSplitFunctionalObjectNameLock(unsigned char iLocked)= 0
Locks or unlocks the SplitFunctionalObjectName parameter.
Role: Locks or unlocks the SplitFunctionalObjectName 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 SetStringUsedAsCarriageReturnAtt
public virtual HRESULT SetStringUsedAsCarriageReturnAtt(CATUnicodeString& iStringUsedAsCarriageReturn)= 0
Sets the StringUsedAsCarriageReturn attribute.
Parameters:
iStringUsedAsCarriageReturn
String Used As Carriage Return
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetStringUsedAsCarriageReturnLock
public virtual HRESULT SetStringUsedAsCarriageReturnLock(unsigned char iLocked)= 0
Locks or unlocks the StringUsedAsCarriageReturn parameter.
Role: Locks or unlocks the StringUsedAsCarriageReturn 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 SetTypeOfIconOnFunctionalElementAtt
public virtual HRESULT SetTypeOfIconOnFunctionalElementAtt( const long iTypeOfIconOnFunctionalElement)= 0
Sets the TypeOfIconOnFunctionalElement attribute.
Parameters:
iTypeOfIconOnFunctionalElement
Type Of Icon On Functional Elements Legal values:
0 : indicate a current association with PPR links.
1: indicate a current generative script.
o SetTypeOfIconOnFunctionalElementLock
public virtual HRESULT SetTypeOfIconOnFunctionalElementLock(unsigned char iLocked)= 0
Locks or unlocks the TypeOfIconOnFunctionalElement parameter.
Role: Locks or unlocks the TypeOfIconOnFunctionalElement 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: CATIFsyFunctionalSystemSettingAtt.h
If needed, your Imakefile.mk should include the module: FunctionalAnalysisItfCPP

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