All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

DraftingInterfaces Interface CATIDrwDraftingSettingAtt

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

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


interface CATIDrwDraftingSettingAtt

Interface to manage drafting settings.

Even if GetXXX methods fail, returned arguments are valued to default.


Method Index


o GetCreateNewSheetFrom(CatDrwNewSheetFrom&)
Retrieves the CreateNewSheetFrom attribute.
o GetCreateNewSheetFromInfo(CATSettingInfo*)
Retrieves the state of the CreateNewSheetFrom parameter.
o GetDisplayResetButton(boolean&)
Retrieves the DisplayResetButton attribute.
o GetDisplayResetButtonInfo(CATSettingInfo*)
Retrieves the state of the DisplayResetButton parameter.
o GetLockUserDefault(boolean&)
Retrieves the LockUserDefault attribute.
o GetLockUserDefaultInfo(CATSettingInfo*)
Retrieves the state of the LockUserDefault parameter.
o GetPreventBackgroundAccess(boolean&)
Retrieves the PreventBackgroundAccess attribute.
o GetPreventBackgroundAccessInfo(CATSettingInfo*)
Retrieves the state of the PreventBackgroundAccess parameter.
o GetPreventDimDriving3DCstr(boolean&)
Retrieves the PreventDimDriving3DCstr attribute.
o GetPreventDimDriving3DCstrInfo(CATSettingInfo*)
Retrieves the state of the PreventDimDriving3DCstr parameter.
o GetPreventFileNew(boolean&)
Retrieves the PreventFileNew attribute.
o GetPreventFileNewInfo(CATSettingInfo*)
Retrieves the state of the PreventFileNew parameter.
o GetPreventGenViewStyle(boolean&)
Retrieves the PreventGenViewStyle attribute.
o GetPreventGenViewStyleInfo(CATSettingInfo*)
Retrieves the state of the PreventGenViewStyle parameter.
o GetPreventSetAsDefault(boolean&)
Retrieves the PreventSetAsDefault attribute.
o GetPreventSetAsDefaultInfo(CATSettingInfo*)
Retrieves the state of the PreventSetAsDefault parameter.
o GetPreventSwitchStandard(boolean&)
Retrieves the PreventSwitchStandard attribute.
o GetPreventSwitchStandardInfo(CATSettingInfo*)
Retrieves the state of the PreventSwitchStandard parameter.
o GetPreventTrueDimensionCreation(boolean&)
Retrieves the PreventTrueDimensionCreation attribute.
o GetPreventTrueDimensionCreationInfo(CATSettingInfo*)
Retrieves the state of the PreventTrueDimensionCreation parameter.
o GetPreventUpdateStandard(boolean&)
Retrieves the PreventUpdateStandard attribute.
o GetPreventUpdateStandardInfo(CATSettingInfo*)
Retrieves the state of the PreventUpdateStandard parameter.
o GetUseStyleCreateObjects(boolean&)
Retrieves the UseStyleCreateObjects attribute.
o GetUseStyleCreateObjectsInfo(CATSettingInfo*)
Retrieves the state of the UseStyleCreateObjects parameter.
o SetCreateNewSheetFrom(CatDrwNewSheetFrom&)
Sets the CreateNewSheetFrom attribute.
o SetCreateNewSheetFromLock(unsigned char)
Locks or unlocks the CreateNewSheetFrom parameter.
o SetDisplayResetButton(boolean&)
Sets the DisplayResetButton attribute.
o SetDisplayResetButtonLock(unsigned char)
Locks or unlocks the DisplayResetButton parameter.
o SetLockUserDefault(boolean&)
Sets the LockUserDefault attribute.
o SetLockUserDefaultLock(unsigned char)
Locks or unlocks the LockUserDefault parameter.
o SetPreventBackgroundAccess(boolean&)
Sets the PreventBackgroundAccess attribute.
o SetPreventBackgroundAccessLock(unsigned char)
Locks or unlocks the PreventBackgroundAccess parameter.
o SetPreventDimDriving3DCstr(boolean&)
Sets the PreventDimDriving3DCstr attribute.
o SetPreventDimDriving3DCstrLock(unsigned char)
Locks or unlocks the PreventDimDriving3DCstr parameter.
o SetPreventFileNew(boolean&)
Sets the PreventFileNew attribute.
o SetPreventFileNewLock(unsigned char)
Locks or unlocks the PreventFileNew parameter.
o SetPreventGenViewStyle(boolean&)
Sets the PreventGenViewStyle attribute.
o SetPreventGenViewStyleLock(unsigned char)
Locks or unlocks the PreventGenViewStyle parameter.
o SetPreventSetAsDefault(boolean&)
Sets the PreventSetAsDefault attribute.
o SetPreventSetAsDefaultLock(unsigned char)
Locks or unlocks the PreventSetAsDefault parameter.
o SetPreventSwitchStandard(boolean&)
Sets the PreventSwitchStandard attribute.
o SetPreventSwitchStandardLock(unsigned char)
Locks or unlocks the PreventSwitchStandard parameter.
o SetPreventTrueDimensionCreation(boolean&)
Sets the PreventTrueDimensionCreation attribute.
o SetPreventTrueDimensionCreationLock(unsigned char)
Locks or unlocks the PreventTrueDimensionCreation parameter.
o SetPreventUpdateStandard(boolean&)
Sets the PreventUpdateStandard attribute.
o SetPreventUpdateStandardLock(unsigned char)
Locks or unlocks the PreventUpdateStandard parameter.
o SetUseStyleCreateObjects(boolean&)
Sets the UseStyleCreateObjects attribute.
o SetUseStyleCreateObjectsLock(unsigned char)
Locks or unlocks the UseStyleCreateObjects parameter.

Methods


o GetCreateNewSheetFrom
public virtual HRESULT GetCreateNewSheetFrom(CatDrwNewSheetFrom& ioValue) = 0
Retrieves the CreateNewSheetFrom attribute.
o GetCreateNewSheetFromInfo
public virtual HRESULT GetCreateNewSheetFromInfo(CATSettingInfo* oInfo) = 0
Retrieves the state of the CreateNewSheetFrom parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDisplayResetButton
public virtual HRESULT GetDisplayResetButton(boolean& ioValue) = 0
Retrieves the DisplayResetButton attribute.
o GetDisplayResetButtonInfo
public virtual HRESULT GetDisplayResetButtonInfo(CATSettingInfo* oInfo) = 0
Retrieves the state of the DisplayResetButton parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetLockUserDefault
public virtual HRESULT GetLockUserDefault(boolean& ioValue) = 0
Retrieves the LockUserDefault attribute.
o GetLockUserDefaultInfo
public virtual HRESULT GetLockUserDefaultInfo(CATSettingInfo* oInfo) = 0
Retrieves the state of the LockUserDefault parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetPreventBackgroundAccess
public virtual HRESULT GetPreventBackgroundAccess(boolean& ioValue) = 0
Retrieves the PreventBackgroundAccess attribute.
o GetPreventBackgroundAccessInfo
public virtual HRESULT GetPreventBackgroundAccessInfo(CATSettingInfo* oInfo) = 0
Retrieves the state of the PreventBackgroundAccess parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetPreventDimDriving3DCstr
public virtual HRESULT GetPreventDimDriving3DCstr(boolean& ioValue) = 0
Retrieves the PreventDimDriving3DCstr attribute.
o GetPreventDimDriving3DCstrInfo
public virtual HRESULT GetPreventDimDriving3DCstrInfo(CATSettingInfo* oInfo) = 0
Retrieves the state of the PreventDimDriving3DCstr parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetPreventFileNew
public virtual HRESULT GetPreventFileNew(boolean& ioValue) = 0
Retrieves the PreventFileNew attribute.
o GetPreventFileNewInfo
public virtual HRESULT GetPreventFileNewInfo(CATSettingInfo* oInfo) = 0
Retrieves the state of the PreventFileNew parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetPreventGenViewStyle
public virtual HRESULT GetPreventGenViewStyle(boolean& ioValue) = 0
Retrieves the PreventGenViewStyle attribute.
o GetPreventGenViewStyleInfo
public virtual HRESULT GetPreventGenViewStyleInfo(CATSettingInfo* oInfo) = 0
Retrieves the state of the PreventGenViewStyle parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetPreventSetAsDefault
public virtual HRESULT GetPreventSetAsDefault(boolean& ioValue) = 0
Retrieves the PreventSetAsDefault attribute.
o GetPreventSetAsDefaultInfo
public virtual HRESULT GetPreventSetAsDefaultInfo(CATSettingInfo* oInfo) = 0
Retrieves the state of the PreventSetAsDefault parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetPreventSwitchStandard
public virtual HRESULT GetPreventSwitchStandard(boolean& ioValue) = 0
Retrieves the PreventSwitchStandard attribute.
o GetPreventSwitchStandardInfo
public virtual HRESULT GetPreventSwitchStandardInfo(CATSettingInfo* oInfo) = 0
Retrieves the state of the PreventSwitchStandard parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetPreventTrueDimensionCreation
public virtual HRESULT GetPreventTrueDimensionCreation(boolean& ioValue) = 0
Retrieves the PreventTrueDimensionCreation attribute.
o GetPreventTrueDimensionCreationInfo
public virtual HRESULT GetPreventTrueDimensionCreationInfo(CATSettingInfo* oInfo) = 0
Retrieves the state of the PreventTrueDimensionCreation parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetPreventUpdateStandard
public virtual HRESULT GetPreventUpdateStandard(boolean& ioValue) = 0
Retrieves the PreventUpdateStandard attribute.
o GetPreventUpdateStandardInfo
public virtual HRESULT GetPreventUpdateStandardInfo(CATSettingInfo* oInfo) = 0
Retrieves the state of the PreventUpdateStandard parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetUseStyleCreateObjects
public virtual HRESULT GetUseStyleCreateObjects(boolean& ioValue) = 0
Retrieves the UseStyleCreateObjects attribute.
o GetUseStyleCreateObjectsInfo
public virtual HRESULT GetUseStyleCreateObjectsInfo(CATSettingInfo* oInfo) = 0
Retrieves the state of the UseStyleCreateObjects parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetCreateNewSheetFrom
public virtual HRESULT SetCreateNewSheetFrom( const CatDrwNewSheetFrom& iValue) = 0
Sets the CreateNewSheetFrom attribute.
o SetCreateNewSheetFromLock
public virtual HRESULT SetCreateNewSheetFromLock(unsigned char iLocked) = 0
Locks or unlocks the CreateNewSheetFrom parameter.
Role: Locks or unlocks the CreateNewSheetFrom 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 SetDisplayResetButton
public virtual HRESULT SetDisplayResetButton( const boolean& iValue) = 0
Sets the DisplayResetButton attribute.
o SetDisplayResetButtonLock
public virtual HRESULT SetDisplayResetButtonLock(unsigned char iLocked) = 0
Locks or unlocks the DisplayResetButton parameter.
Role: Locks or unlocks the DisplayResetButton 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 SetLockUserDefault
public virtual HRESULT SetLockUserDefault( const boolean& iValue) = 0
Sets the LockUserDefault attribute.
o SetLockUserDefaultLock
public virtual HRESULT SetLockUserDefaultLock(unsigned char iLocked) = 0
Locks or unlocks the LockUserDefault parameter.
Role: Locks or unlocks the LockUserDefault 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 SetPreventBackgroundAccess
public virtual HRESULT SetPreventBackgroundAccess( const boolean& iValue) = 0
Sets the PreventBackgroundAccess attribute.
o SetPreventBackgroundAccessLock
public virtual HRESULT SetPreventBackgroundAccessLock(unsigned char iLocked) = 0
Locks or unlocks the PreventBackgroundAccess parameter.
Role: Locks or unlocks the PreventBackgroundAccess 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 SetPreventDimDriving3DCstr
public virtual HRESULT SetPreventDimDriving3DCstr( const boolean& iValue) = 0
Sets the PreventDimDriving3DCstr attribute.
o SetPreventDimDriving3DCstrLock
public virtual HRESULT SetPreventDimDriving3DCstrLock(unsigned char iLocked) = 0
Locks or unlocks the PreventDimDriving3DCstr parameter.
Role: Locks or unlocks the PreventDimDriving3DCstr 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 SetPreventFileNew
public virtual HRESULT SetPreventFileNew( const boolean& iValue) = 0
Sets the PreventFileNew attribute.
o SetPreventFileNewLock
public virtual HRESULT SetPreventFileNewLock(unsigned char iLocked) = 0
Locks or unlocks the PreventFileNew parameter.
Role: Locks or unlocks the PreventFileNew 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 SetPreventGenViewStyle
public virtual HRESULT SetPreventGenViewStyle( const boolean& iValue) = 0
Sets the PreventGenViewStyle attribute.
o SetPreventGenViewStyleLock
public virtual HRESULT SetPreventGenViewStyleLock(unsigned char iLocked) = 0
Locks or unlocks the PreventGenViewStyle parameter.
Role: Locks or unlocks the PreventGenViewStyle 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 SetPreventSetAsDefault
public virtual HRESULT SetPreventSetAsDefault( const boolean& iValue) = 0
Sets the PreventSetAsDefault attribute.
o SetPreventSetAsDefaultLock
public virtual HRESULT SetPreventSetAsDefaultLock(unsigned char iLocked) = 0
Locks or unlocks the PreventSetAsDefault parameter.
Role: Locks or unlocks the PreventSetAsDefault 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 SetPreventSwitchStandard
public virtual HRESULT SetPreventSwitchStandard( const boolean& iValue) = 0
Sets the PreventSwitchStandard attribute.
o SetPreventSwitchStandardLock
public virtual HRESULT SetPreventSwitchStandardLock(unsigned char iLocked) = 0
Locks or unlocks the PreventSwitchStandard parameter.
Role: Locks or unlocks the PreventSwitchStandard 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 SetPreventTrueDimensionCreation
public virtual HRESULT SetPreventTrueDimensionCreation( const boolean& iValue) = 0
Sets the PreventTrueDimensionCreation attribute.
o SetPreventTrueDimensionCreationLock
public virtual HRESULT SetPreventTrueDimensionCreationLock(unsigned char iLocked) = 0
Locks or unlocks the PreventTrueDimensionCreation parameter.
Role: Locks or unlocks the PreventTrueDimensionCreation 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 SetPreventUpdateStandard
public virtual HRESULT SetPreventUpdateStandard( const boolean& iValue) = 0
Sets the PreventUpdateStandard attribute.
o SetPreventUpdateStandardLock
public virtual HRESULT SetPreventUpdateStandardLock(unsigned char iLocked) = 0
Locks or unlocks the PreventUpdateStandard parameter.
Role: Locks or unlocks the PreventUpdateStandard 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 SetUseStyleCreateObjects
public virtual HRESULT SetUseStyleCreateObjects( const boolean& iValue) = 0
Sets the UseStyleCreateObjects attribute.
o SetUseStyleCreateObjectsLock
public virtual HRESULT SetUseStyleCreateObjectsLock(unsigned char iLocked) = 0
Locks or unlocks the UseStyleCreateObjects parameter.
Role: Locks or unlocks the UseStyleCreateObjects 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: CATIDrwDraftingSettingAtt.h
If needed, your Imakefile.mk should include the module: CATDraftingInterfaces

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