All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

System Interface CATISysDisconnectionSettingAtt

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

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


interface CATISysDisconnectionSettingAtt

Interface to handle the parameters of automatic disconnection.
Role: This interface is implemented by a component which represents the controller of the cache.
This interface defines:


Method Index


o GetActivationState(CATBoolean*)
Returns activation state of automatic disconnection.
o GetActivationStateInfo(CATSettingInfo*)
Retrieves informations about the activation mode of automatic disconnection.
o GetInactivityDuration(int*)
Returns or sets the inactivity duration.
o GetInactivityDurationInfo(CATSettingInfo*)
Retrieves environment informations for inactivity duration.
o PutActivationState(CATBoolean)
Turns ON/OFF the automatic disconnection.
o PutInactivityDuration(int)
Sets the inactivity duration.
o SetActivationStateLock(unsigned char)
Locks or unlocks the activation mode of automatic disconnection.
o SetInactivityDurationLock(unsigned char)
Locks or unlocks the inactivity duration.

Methods


o GetActivationState
public virtual HRESULT GetActivationState(CATBoolean* oActivationState)=0
Returns activation state of automatic disconnection.
Role:Returns or sets the activation mode of automatic disconnection.
Parameters:
oMode
Legal values:
FALSE: turned off
TRUE: turned on
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetActivationStateInfo
public virtual HRESULT GetActivationStateInfo(CATSettingInfo* oInfo)=0
Retrieves informations about the activation mode of automatic disconnection.
Refer to CATSysSettingController for a detailled description.
o GetInactivityDuration
public virtual HRESULT GetInactivityDuration(int* oMaxInactivity)=0
Returns or sets the inactivity duration.
Role: Returns the timeout in seconds before the automatic disconnection when no activity has been detected, if the mechanism is enabled.
Parameters:
oMaxInactivity
The inactivity duration in seconds.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetInactivityDurationInfo
public virtual HRESULT GetInactivityDurationInfo(CATSettingInfo* oInfo)=0
Retrieves environment informations for inactivity duration.
Refer to CATSysSettingController for a detailled description.
o PutActivationState
public virtual HRESULT PutActivationState(CATBoolean iActivationState)=0
Turns ON/OFF the automatic disconnection.
Role: Activates or desactivates the cache mechanism.
Parameters:
iMode
Legal values:
FALSE: to turn off
TRUE: to turn on
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o PutInactivityDuration
public virtual HRESULT PutInactivityDuration(int iMaxInactivity)=0
Sets the inactivity duration.
Role: Sets the timeout in seconds before the automatic disconnection when no activity has been detected, if the mechanism is enabled.
Parameters:
iMaxInactivity
The inactivity duration in second.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetActivationStateLock
public virtual HRESULT SetActivationStateLock(unsigned char iLock)=0
Locks or unlocks the activation mode of automatic disconnection.
Refer to CATSysSettingController for a detailled description.
o SetInactivityDurationLock
public virtual HRESULT SetInactivityDurationLock(unsigned char iLock)=0
Locks or unlocks the inactivity duration.
Refer to CATSysSettingController for a detailled description.

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

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