All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

System Class CATSysAutoSettingController

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---System.CATBaseObject
        |
        +---CATSysAutoSettingController
 

Usage: you can derive this class.


public class CATSysAutoSettingController

Interface to handle a setting repository controller for Automation.
Role: This interface must be implemented by a component which represents the controller of the setting file for an Automation context.
This controller must implement:


Constructor and Destructor Index


o CATSysAutoSettingController()
Constructs an empty setting controller for Automation.
o ~CATSysAutoSettingController()

Method Index


o Commit()
Makes a memory copy of the setting attribute values.
o Initialize()
Initializes the setting controller.
o ResetToAdminValues()
Restores the administrated values of the attributes.
o ResetToAdminValuesByName(CATSafeArrayVariant&)
Restores the administrated values of a subset of the attributes.
o Rollback()
Restores the last memory copy of the setting attribute values.
o SaveRepository()
Makes a persistent copy of the setting attribute values on file.

Constructor and Destructor


o CATSysAutoSettingController
protected CATSysAutoSettingController()
Constructs an empty setting controller for Automation.
o ~CATSysAutoSettingController
public virtual ~CATSysAutoSettingController()

Methods


o Commit
public virtual HRESULT Commit()
Makes a memory copy of the setting attribute values.
Role: Commit saves the current values of the setting attributes managed by the setting controller in a specific memory area. Successive calls to Commit overwrite the memory area. The values saved by the last call to Commit can be restored from that memory area using the Rollback method.
Returns:
Legal values: S_OK on success, and E_FAIL otherwise
o Initialize
protected virtual HRESULT Initialize()
Initializes the setting controller.
Role: Initialize might be necessary for setting controllers that keep some setting attribute values as data member for performance reasons. Such setting controllers are qualified as bufferized setting controllers.
Returns:
Legal values: S_OK on success, and E_FAIL otherwise
o ResetToAdminValues
public virtual HRESULT ResetToAdminValues()
Restores the administrated values of the attributes.
Role: ResetToAdminValues restores all the values of the setting attributes managed by the setting controller to either the values set by the setting administrator, or to their default values if the setting administrator did not change them.
Returns:
Legal values: S_OK on success, and E_FAIL otherwise
o ResetToAdminValuesByName
public virtual HRESULT ResetToAdminValuesByName( const CATSafeArrayVariant& iAttList)
Restores the administrated values of a subset of the attributes.
Role: ResetToAdminValuesByName restores the values of a subset of the setting attributes managed by the setting controller to either the values set by the setting administrator, or to their default values if the setting administrator did not change them.
Parameters:
iAttList
The attribute subset to which the administrated values are to be restored
o Rollback
public virtual HRESULT Rollback()
Restores the last memory copy of the setting attribute values.
Role: Rollback restores the values of the setting attributes managed by the setting controller from the memory area. All values of the setting attributes managed by the setting controller modified since the last call to Commit are restored to the values they had when this last Commit was called.
Returns:
Legal values: S_OK on success, and E_FAIL otherwise
o SaveRepository
public virtual HRESULT SaveRepository()
Makes a persistent copy of the setting attribute values on file.
Role: SaveRepository saves the current values of the setting attributes managed by the setting controller in a setting repository file. To avoid inconsistencies, SaveRepository first saves the values in the memory area used by the Commit method by calling Commit before writing the values in the setting repository file.
Returns:
Legal values: S_OK on success, and E_FAIL otherwise

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

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