All Frameworks Class Hierarchy This Framework Previous Next Indexes
KnowledgeInterfaces Interface CATILieUnitsSheetSettingAtt
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATILieUnitsSheetSettingAtt
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATILieUnitsSheetSettingAtt
The interface to access a CATILieUnitsSheetSettingAtt.
This interface may be used to read or modify in the CATIA\Tools\Option the settings values
of Units sheet.
Method Index
- o
CommitForUnits()
- Validates the unit settings in session.
- o
GetDecimalReadOnly(CATUnicodeString&,int*)
- Retrieves the DecimalReadOnly attribute.
- o
GetDecimalReadWrite(CATUnicodeString&,int*)
- Retrieves the DecimalReadWrite attribute.
- o
GetDimensionsDisplayInfo(CATSettingInfo*)
- Retrieves information about the DimensionsDisplay setting parameter.
- o
GetDisplayTrailingZeros(int*)
- Retrieves the DisplayTrailingZeros attribute.
- o
GetDisplayTrailingZerosInfo(CATSettingInfo*)
-
- o
GetExpNotationValuesGreater(int*)
- Retrieves the ExpNotationValuesGreater attribute.
- o
GetExpNotationValuesGreaterInfo(CATSettingInfo*)
-
- o
GetExpNotationValuesLower(int*)
- Retrieves the ExpNotationValuesLower attribute.
- o
GetExpNotationValuesLowerInfo(CATSettingInfo*)
-
- o
GetListOfMagnitudes(CATSafeArrayVariant&)
- Retrieves the list of magnitudes attribute.
- o
GetListOfMagnitudesInfo(CATSettingInfo*)
- Retrieves information about the ListOfMagnitudes setting parameter.
- o
GetListOfMagnitudesSize(int*)
- Retrieves the list of magnitudes size attribute.
- o
GetMagnitudeUnit(CATICkeMagnitude_var&,CATUnicodeString&)
- Retrieves the MagnitudeValues attribute.
- o
GetMagnitudeValues(CATUnicodeString&,CATUnicodeString&,int*,int*)
- Retrieves the MagnitudeValues attribute.
- o
GetSameDisplay(int*)
- Retrieves the SameDisplay attribute.
- o
GetSameDisplayInfo(CATSettingInfo*)
-
- o
ResetToAdminValuesForUnits()
- Resets the unit settings to default values.
- o
RollbackForUnits()
- Rollbacks the unit settings.
- o
SaveRepositoryForUnits()
- Saves the unit settings in repository.
- o
SetDimensionsDisplayLock(unsigned char)
- Locks or unlocks the DimensionsDisplay setting parameter.
- o
SetDisplayTrailingZeros(int*)
- Sets the DisplayTrailingZeros attribute.
- o
SetDisplayTrailingZerosLock(unsigned char)
-
- o
SetExpNotationValuesGreater(int*)
- Sets the ExpNotationValuesGreater attribute.
- o
SetExpNotationValuesGreaterLock(unsigned char)
-
- o
SetExpNotationValuesLower(int*)
- Sets the ExpNotationValuesLower attribute.
- o
SetExpNotationValuesLowerLock(unsigned char)
-
- o
SetListOfMagnitudesLock(unsigned char)
- Locks or unlocks the ListOfMagnitudes setting parameter.
- o
SetMagnitudeValues(CATUnicodeString&,CATUnicodeString&,int*,int*)
- Sets the MagnitudeValues attribute.
- o
SetSameDisplay(int*)
- *
Sets the SameDisplay attribute.
- o
SetSameDisplayLock(unsigned char)
-
Methods
o CommitForUnits
public virtual HRESULT CommitForUnits( | )= 0 |
-
Validates the unit settings in session.
o GetDecimalReadOnly
-
Retrieves the DecimalReadOnly attribute.
Role:Return the GetDecimalReadOnly parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- iMagnitudeName
- The name of the Magnitude.
- oDecimalPlaceReadOnly
- The value of the DecimalReadOnly attribute corresponding to the Magnitude.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDecimalReadWrite
-
Retrieves the DecimalReadWrite attribute.
Role:Return the DecimalReadWrite parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- iMagnitudeName
- The name of the Magnitude.
- oDecimalPlaceReadWrite
- The value of the DecimalReadWrite attribute corresponding to the Magnitude.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDimensionsDisplayInfo
-
Retrieves information about the DimensionsDisplay setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetDisplayTrailingZeros
public virtual HRESULT GetDisplayTrailingZeros( | int* | ioDisplayTrailingZeros) = 0 |
-
Retrieves the DisplayTrailingZeros attribute.
Role:Return the DisplayTrailingZeros parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- ioDisplayTrailingZeros
- Legal values:
0 : to not display trailing zeros
1 : to display trailing zeros.
o GetDisplayTrailingZerosInfo
-
- Deprecated:
- V5R15. Use GetDimensionsDisplayInfo.
Retrieves the state of the DisplayTrailingZeros parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetExpNotationValuesGreater
public virtual HRESULT GetExpNotationValuesGreater( | int* | ioExpNotationValuesGreater) = 0 |
-
Retrieves the ExpNotationValuesGreater attribute.
Role:Return the ExpNotationValuesGreater parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- ioExpNotationValuesGreater
- The minimum value for exponential notation values.
o GetExpNotationValuesGreaterInfo
-
- Deprecated:
- V5R15. Use GetDimensionsDisplayInfo.
Retrieves the state of the ExpNotationValuesGreater parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetExpNotationValuesLower
public virtual HRESULT GetExpNotationValuesLower( | int* | ioExpNotationValuesLower) = 0 |
-
Retrieves the ExpNotationValuesLower attribute.
Role:Return the ExpNotationValuesGreater parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- ioExpNotationValuesLower
- The maximum value for exponential notation values.
o GetExpNotationValuesLowerInfo
-
- Deprecated:
- V5R15. Use GetDimensionsDisplayInfo.
Retrieves the state of the ExpNotationValuesLower parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetListOfMagnitudes
-
Retrieves the list of magnitudes attribute.
Role:Return the ListOfMagnitudes parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- oListOfMagnitudes
- The list of magnitudes
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetListOfMagnitudesInfo
-
Retrieves information about the ListOfMagnitudes setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetListOfMagnitudesSize
public virtual HRESULT GetListOfMagnitudesSize( | int* | oListOfMagnitudesSize) = 0 |
-
Retrieves the list of magnitudes size attribute.
Role:Return the ListOfMagnitudesSize parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- oListOfMagnitudes
- address of an object int.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetMagnitudeUnit
-
Retrieves the MagnitudeValues attribute.
Role:Return the UnitName parameter for the given iMagnitude if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- iMagnitudeName
- The Magnitude
- Returns:
- The value of the UnitName corresponding to the Magnitude.
o GetMagnitudeValues
-
Retrieves the MagnitudeValues attribute.
Role:Return the MagnitudeValues parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- iMagnitudeName
- The name of the Magnitude.
- oUnitName
- The value of the UnitName corresponding to the Magnitude.
- oDecimalPlaceReadWrite
- The number of decimals for ReadWrite number.
- oDecimalPlaceReadOnly
-
The number of decimals for ReadOnly number.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetSameDisplay
public virtual HRESULT GetSameDisplay( | int* | ioSameDisplay) = 0 |
-
Retrieves the SameDisplay attribute.
Role:Return the SameDisplay parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- ioSameDisplay
- Legal values:
0 : to not display same display
1 : to display same display.
o GetSameDisplayInfo
-
- Deprecated:
- V5R15. Use GetDimensionsDisplayInfo.
Retrieves the state of the SameDisplay parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o ResetToAdminValuesForUnits
public virtual HRESULT ResetToAdminValuesForUnits( | )= 0 |
-
Resets the unit settings to default values.
o RollbackForUnits
public virtual HRESULT RollbackForUnits( | )= 0 |
-
Rollbacks the unit settings.
o SaveRepositoryForUnits
public virtual HRESULT SaveRepositoryForUnits( | )= 0 |
-
Saves the unit settings in repository.
o SetDimensionsDisplayLock
public virtual HRESULT SetDimensionsDisplayLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the DimensionsDisplay setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetDisplayTrailingZeros
public virtual HRESULT SetDisplayTrailingZeros( | int* | iDisplayTrailingZeros) = 0 |
-
Sets the DisplayTrailingZeros attribute.
Role:Set the DisplayTrailingZeros parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- iDisplayTrailingZeros
- Legal values:
0 : to not display trailing zeros
1 : to display trailing zeros.
o SetDisplayTrailingZerosLock
public virtual HRESULT SetDisplayTrailingZerosLock( | unsigned char | iLocked)= 0 |
-
- Deprecated:
- V5R15. Use SetDimensionsDisplayLock.
Locks or unlocks the DisplayTrailingZeros parameter.
Role: Locks or unlocks the DisplayTrailingZeros 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 SetExpNotationValuesGreater
public virtual HRESULT SetExpNotationValuesGreater( | int* | iExpNotationValuesGreater) = 0 |
-
Sets the ExpNotationValuesGreater attribute.
Role:Set the ExpNotationValuesGreater parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- iExpNotationValuesGreater
- The minimum value for exponential notation values.
o SetExpNotationValuesGreaterLock
public virtual HRESULT SetExpNotationValuesGreaterLock( | unsigned char | iLocked)= 0 |
-
- Deprecated:
- V5R15. Use SetDimensionsDisplayLock.
Locks or unlocks the ExpNotationValuesGreater parameter.
Role: Locks or unlocks the ExpNotationValuesGreater 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 SetExpNotationValuesLower
public virtual HRESULT SetExpNotationValuesLower( | int* | iExpNotationValuesLower) = 0 |
-
Sets the ExpNotationValuesLower attribute.
Role:Set the ExpNotationValuesGreater parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- iExpNotationValuesLower
- The maximum value for exponential notation values.
o SetExpNotationValuesLowerLock
public virtual HRESULT SetExpNotationValuesLowerLock( | unsigned char | iLocked)= 0 |
-
- Deprecated:
- V5R15. Use SetDimensionsDisplayLock.
Locks or unlocks the ExpNotationValuesLower parameter.
Role: Locks or unlocks the ExpNotationValuesLower 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 SetListOfMagnitudesLock
public virtual HRESULT SetListOfMagnitudesLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the ListOfMagnitudes setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetMagnitudeValues
-
Sets the MagnitudeValues attribute.
Role:Set the MagnitudeValues parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- iMagnitudeName
- The name of the magnitude.
- iUnitName
- The name of the unit.
- iDecimalPlaceReadWrite
- The number of decimals for read/write number.
- iDecimalPlaceReadOnly
- The number of decimals for read/only number.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetSameDisplay
public virtual HRESULT SetSameDisplay( | int* | iSameDisplay) = 0 |
-
*
Sets the SameDisplay attribute.
Role:Set the SameDisplay parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- iSameDisplay
- Legal values:
0 : to not display same display
1 : to display same display.
o SetSameDisplayLock
public virtual HRESULT SetSameDisplayLock( | unsigned char | iLocked)= 0 |
-
- Deprecated:
- V5R15. Use SetDimensionsDisplayLock.
Locks or unlocks the SameDisplay parameter.
Role: Locks or unlocks the SameDisplay 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: CATILieUnitsSheetSettingAtt.h
If needed, your Imakefile.mk should include the module: KnowledgeItf