All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

System Interface CATISysSettingController

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

Usage: you can reimplement this interface by deriving the supplied CATSysSettingController adapter class.


interface CATISysSettingController

Interface to handle the setting controller.
Role: This interface must be implemented by a component which represents the controller of the setting repository and file. Use the CATSysSettingController class to implement CATISysSettingController. In most cases, you should not re-implement these methods, except if you create a bufferized setting controller. Refer to the CAA Encyclopedia to know about such controllers.


Method Index


o Commit(int)
Makes a memory copy of the setting attribute values.
o ResetToAdminValues(char**,int)
Restores the administrated values of the attributes.
o Rollback()
Restores the last memory copy of the setting attribute values.
o SaveRepository(char*)
Makes a persistent copy of the setting attribute values on file.

Methods


o Commit
public virtual HRESULT Commit(int iNoEvent=0) = 0
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.
Parameters:
iNoEvent
[in] Reserved for internal use. Do not use. Should always be set to 0
Returns:
Legal values: S_OK on success, and E_FAIL otherwise
o ResetToAdminValues
public virtual HRESULT ResetToAdminValues(char** iAttList=NULL,
int iNbAtt=0) = 0
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.
Parameters:
iAttList
[in] Reserved for internal use. Do not use. Should always be set to NULL
iNbAtt
[in] Reserved for internal use. Do not use. Should always be set to 0
Returns:
Legal values: S_OK on success, and E_FAIL otherwise
o Rollback
public virtual HRESULT Rollback()= 0
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( const char* itmp=NULL) = 0
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.
Parameters:
iTmp
[in] Reserved for internal use. Do not use. Should always be set to NULL
Returns:
Legal values: S_OK on success, and E_FAIL otherwise

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

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