All Frameworks Class Hierarchy This Framework Previous Next Indexes
KnowledgeInterfaces Interface CATILieKnowledgeSheetSettingAtt
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATILieKnowledgeSheetSettingAtt
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATILieKnowledgeSheetSettingAtt
The interface to access a CATIAKnowledgeSheetSettingAtt.
This interface may be used to read or modify in the CATIA\Tools\Option the settings values
of Knowledge sheet.
Method Index
- o
GetDesignTablesCopyData(int&)
- Retrieves the DesignTablesCopyData attribute.
- o
GetDesignTablesCopyDataInfo(CATSettingInfo*)
- Retrieves the state of the DesignTablesCopyData parameter.
- o
GetDesignTablesSynchronization(int&)
- Retrieves the DesignTablesSynchronization attribute.
- o
GetDesignTablesSynchronizationInfo(CATSettingInfo*)
- Retrieves the state of the DesignTablesSynchronization parameter.
- o
GetParameterNameSurroundedByTheSymbol(int&)
- Retrieves the ParameterNameSurroundedByTheSymbol attribute.
- o
GetParameterNameSurroundedByTheSymbolInfo(CATSettingInfo*)
- Retrieves the state of the ParameterNameSurroundedByTheSymbol parameter.
- o
GetParameterTreeViewWithFormula(int&)
- Retrieves the ParameterTreeViewWithFormula attribute.
- o
GetParameterTreeViewWithFormulaInfo(CATSettingInfo*)
- Retrieves the state of the ParameterTreeViewWithFormula parameter.
- o
GetParameterTreeViewWithValue(int&)
- Retrieves the ParameterTreeViewWithValue attribute.
- o
GetParameterTreeViewWithValueInfo(CATSettingInfo*)
- Retrieves the state of the ParameterTreeViewWithValue parameter.
- o
GetRelationsUpdateInPartContextEvaluateDuringUpdate(int&)
- Retrieves the RelationsUpdateInPartContextEvaluateDuringUpdate attribute.
- o
GetRelationsUpdateInPartContextEvaluateDuringUpdateInfo(CATSettingInfo*)
- Retrieves the state of the RelationsUpdateInPartContextEvaluateDuringUpdate parameter.
- o
GetRelationsUpdateInPartContextSynchronousRelations(int&)
- Retrieves the RelationsUpdateInPartContextSynchronousRelations attribute.
- o
GetRelationsUpdateInPartContextSynchronousRelationsInfo(CATSettingInfo*)
- Retrieves the state of the RelationsUpdateInPartContextSynchronousRelations parameter.
- o
SetDesignTablesCopyData(int&)
- Sets the DesignTablesCopyData attribute.
- o
SetDesignTablesCopyDataLock(unsigned char)
- Locks or unlocks the DesignTablesCopyData parameter.
- o
SetDesignTablesSynchronization(int&)
- Sets the DesignTablesSynchronization attribute.
- o
SetDesignTablesSynchronizationLock(unsigned char)
- Locks or unlocks the DesignTablesSynchronization parameter.
- o
SetParameterNameSurroundedByTheSymbol(int&)
- Sets the ParameterNameSurroundedByTheSymbol attribute.
- o
SetParameterNameSurroundedByTheSymbolLock(unsigned char)
- Locks or unlocks the ParameterNameSurroundedByTheSymbol parameter.
- o
SetParameterTreeViewWithFormula(int&)
- Sets the ParameterTreeViewWithFormula attribute.
- o
SetParameterTreeViewWithFormulaLock(unsigned char)
- Locks or unlocks the ParameterTreeViewWithFormula parameter.
- o
SetParameterTreeViewWithValue(int&)
- Sets the ParameterTreeViewWithValue attribute.
- o
SetParameterTreeViewWithValueLock(unsigned char)
- Locks or unlocks the ParameterTreeViewWithValue parameter.
- o
SetRelationsUpdateInPartContextEvaluateDuringUpdate(int&)
- Sets the RelationsUpdateInPartContextEvaluateDuringUpdate attribute.
- o
SetRelationsUpdateInPartContextEvaluateDuringUpdateLock(unsigned char)
- Locks or unlocks the RelationsUpdateInPartContextEvaluateDuringUpdate parameter.
- o
SetRelationsUpdateInPartContextSynchronousRelations(int&)
- Sets the RelationsUpdateInPartContextSynchronousRelations attribute.
- o
SetRelationsUpdateInPartContextSynchronousRelationsLock(unsigned char)
- Locks or unlocks the RelationsUpdateInPartContextSynchronousRelations parameter.
Methods
o GetDesignTablesCopyData
public virtual HRESULT GetDesignTablesCopyData( | int& | ioDesignTablesCopyData)= 0 |
-
Retrieves the DesignTablesCopyData attribute.
- Parameters:
-
- ioDesignTablesCopyData
- Legal values:
0 : default mode for design table : copy data into models
1 : default mode for design table : do not copy data into models.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure.
o GetDesignTablesCopyDataInfo
-
Retrieves the state of the DesignTablesCopyData parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure.
o GetDesignTablesSynchronization
public virtual HRESULT GetDesignTablesSynchronization( | int& | ioDesignTablesSynchronization)= 0 |
-
Retrieves the DesignTablesSynchronization attribute.
- Parameters:
-
- ioDesignTablesSynchronization
- Legal values:
0 : automatic synchronization at load for design table
1 : interactive synchronization at load for design table
2 : manual synchronization for design table.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure.
o GetDesignTablesSynchronizationInfo
-
Retrieves the state of the DesignTablesSynchronization parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure.
o GetParameterNameSurroundedByTheSymbol
public virtual HRESULT GetParameterNameSurroundedByTheSymbol( | int& | ioParameterNameSurroundedByTheSymbol)= 0 |
-
Retrieves the ParameterNameSurroundedByTheSymbol attribute.
- Parameters:
-
- ioParameterNameSurroundedByTheSymbol
- Legal values:
0 : to see parameter name not surrounded by the symbol "'"
1 : to see parameter name surrounded by the symbol "'".
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure.
o GetParameterNameSurroundedByTheSymbolInfo
-
Retrieves the state of the ParameterNameSurroundedByTheSymbol parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure.
o GetParameterTreeViewWithFormula
public virtual HRESULT GetParameterTreeViewWithFormula( | int& | ioParameterTreeViewWithFormula)= 0 |
-
Retrieves the ParameterTreeViewWithFormula attribute.
- Parameters:
-
- ioParameterTreeViewWithFormula
- Legal values:
0 : to see parameter tree view without formula
1 : to see parameter tree view with formula.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure.
o GetParameterTreeViewWithFormulaInfo
-
Retrieves the state of the ParameterTreeViewWithFormula parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure.
o GetParameterTreeViewWithValue
public virtual HRESULT GetParameterTreeViewWithValue( | int& | ioParameterTreeViewWithValue)= 0 |
-
Retrieves the ParameterTreeViewWithValue attribute.
- Parameters:
-
- oParameterTreeViewWithValue
- Legal values:
0 : to see parameter tree view without value
1 : to see parameter tree view with value.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure.
o GetParameterTreeViewWithValueInfo
-
Retrieves the state of the ParameterTreeViewWithValue parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure.
o GetRelationsUpdateInPartContextEvaluateDuringUpdate
public virtual HRESULT GetRelationsUpdateInPartContextEvaluateDuringUpdate( | int& | ioRelationsUpdateInPartContextEvaluateDuringUpdate)= 0 |
-
Retrieves the RelationsUpdateInPartContextEvaluateDuringUpdate attribute.
- Parameters:
-
- ioRelationsUpdateInPartContextEvaluateDuringUpdate
- Legal values:
0 : creation of relations not evaluate during update
1 : creation of relations evaluate during update.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure.
o GetRelationsUpdateInPartContextEvaluateDuringUpdateInfo
-
Retrieves the state of the RelationsUpdateInPartContextEvaluateDuringUpdate parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure.
o GetRelationsUpdateInPartContextSynchronousRelations
public virtual HRESULT GetRelationsUpdateInPartContextSynchronousRelations( | int& | ioRelationsUpdateInPartContextSynchronousRelations)= 0 |
-
Retrieves the RelationsUpdateInPartContextSynchronousRelations attribute.
- Parameters:
-
- ioRelationsUpdateInPartContextSynchronousRelations
- Legal values:
0 : creation of unsynchronous relations
1 : creation of synchronous relations.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure.
o GetRelationsUpdateInPartContextSynchronousRelationsInfo
-
Retrieves the state of the RelationsUpdateInPartContextSynchronousRelations parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure.
o SetDesignTablesCopyData
public virtual HRESULT SetDesignTablesCopyData( | const int& | iDesignTablesCopyData)= 0 |
-
Sets the DesignTablesCopyData attribute.
- Parameters:
-
- iDesignTablesCopyData
- Legal values:
0 : default mode for design table : copy data into models
1 : default mode for design table : do not copy data into models.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure.
o SetDesignTablesCopyDataLock
public virtual HRESULT SetDesignTablesCopyDataLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the DesignTablesCopyData parameter.
Role: Locks or unlocks the DesignTablesCopyData 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 SetDesignTablesSynchronization
public virtual HRESULT SetDesignTablesSynchronization( | const int& | iDesignTablesSynchronization)= 0 |
-
Sets the DesignTablesSynchronization attribute.
- Parameters:
-
- iDesignTablesSynchronization
- Legal values:
0 : automatic synchronization at load for design table
1 : interactive synchronization at load for design table
2 : manual synchronization for design table.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure.
o SetDesignTablesSynchronizationLock
public virtual HRESULT SetDesignTablesSynchronizationLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the DesignTablesSynchronization parameter.
Role: Locks or unlocks the DesignTablesSynchronization 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 SetParameterNameSurroundedByTheSymbol
public virtual HRESULT SetParameterNameSurroundedByTheSymbol( | const int& | iParameterNameSurroundedByTheSymbol)= 0 |
-
Sets the ParameterNameSurroundedByTheSymbol attribute.
- Parameters:
-
- iParameterNameSurroundedByTheSymbol
- Legal values:
0 : to see parameter name not surrounded by the symbol "'"
1 : to see parameter name surrounded by the symbol "'".
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure.
o SetParameterNameSurroundedByTheSymbolLock
public virtual HRESULT SetParameterNameSurroundedByTheSymbolLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the ParameterNameSurroundedByTheSymbol parameter.
Role: Locks or unlocks the ParameterNameSurroundedByTheSymbol 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 SetParameterTreeViewWithFormula
public virtual HRESULT SetParameterTreeViewWithFormula( | const int& | iParameterTreeViewWithFormula)= 0 |
-
Sets the ParameterTreeViewWithFormula attribute.
- Parameters:
-
- iParameterTreeViewWithFormula
- Legal values:
0 : to see parameter tree view without formula
1 : to see parameter tree view with formula.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure.
o SetParameterTreeViewWithFormulaLock
public virtual HRESULT SetParameterTreeViewWithFormulaLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the ParameterTreeViewWithFormula parameter.
Role: Locks or unlocks the ParameterTreeViewWithFormula 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 SetParameterTreeViewWithValue
public virtual HRESULT SetParameterTreeViewWithValue( | const int& | iParameterTreeViewWithValue)= 0 |
-
Sets the ParameterTreeViewWithValue attribute.
- Parameters:
-
- iParameterTreeViewWithValue
- Legal values:
0 : to see parameter tree view without value
1 : to see parameter tree view with value.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure.
o SetParameterTreeViewWithValueLock
public virtual HRESULT SetParameterTreeViewWithValueLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the ParameterTreeViewWithValue parameter.
Role: Locks or unlocks the ParameterTreeViewWithValue 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 SetRelationsUpdateInPartContextEvaluateDuringUpdate
public virtual HRESULT SetRelationsUpdateInPartContextEvaluateDuringUpdate( | const int& | iRelationsUpdateInPartContextEvaluateDuringUpdate)= 0 |
-
Sets the RelationsUpdateInPartContextEvaluateDuringUpdate attribute.
- Parameters:
-
- ioRelationsUpdateInPartContextEvaluateDuringUpdate
- Legal values:
0 : creation of relations not evaluate during update
1 : creation of relations evaluate during update.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure.
o SetRelationsUpdateInPartContextEvaluateDuringUpdateLock
public virtual HRESULT SetRelationsUpdateInPartContextEvaluateDuringUpdateLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the RelationsUpdateInPartContextEvaluateDuringUpdate parameter.
Role: Locks or unlocks the RelationsUpdateInPartContextEvaluateDuringUpdate 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 SetRelationsUpdateInPartContextSynchronousRelations
public virtual HRESULT SetRelationsUpdateInPartContextSynchronousRelations( | const int& | iRelationsUpdateInPartContextSynchronousRelations)= 0 |
-
Sets the RelationsUpdateInPartContextSynchronousRelations attribute.
- Parameters:
-
- iRelationsUpdateInPartContextSynchronousRelations
- Legal values:
0 : creation of unsynchronous relations
1 : creation of synchronous relations.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure.
o SetRelationsUpdateInPartContextSynchronousRelationsLock
public virtual HRESULT SetRelationsUpdateInPartContextSynchronousRelationsLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the RelationsUpdateInPartContextSynchronousRelations parameter.
Role: Locks or unlocks the RelationsUpdateInPartContextSynchronousRelations 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: CATILieKnowledgeSheetSettingAtt.h
If needed, your Imakefile.mk should include the module: KnowledgeItf