All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

System Interface CATISysMemoryWarningSettingAtt

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

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


interface CATISysMemoryWarningSettingAtt

Interface to handle the parameters of memory warning.
Role: This interface is implemented by a component which represents the controller of the memory warning mechanism. This mechanism informs the user when the process memory use exceeds a given percentage of the address space usage. This mechanism warns you that because the amout of remaining memory is becoming low, you should save your data and leave the session.
This interface defines:


Method Index


o GetActivationState(CATBoolean*)
Returns activation state of memory warning mechanism.
o GetActivationStateInfo(CATSettingInfo*)
Retrieves environment informations for the memory warning mechanism.
o GetMemoryStopperState(CATBoolean*)
Returns activation state of memory stopper mechanism.
o GetMemoryStopperStateInfo(CATSettingInfo*)
Retrieves environment informations for the memory stopper mechanism.
o GetUsageLimit(int*)
Returns the alert percentage.
o GetUsageLimitInfo(CATSettingInfo*)
Retrieves environment informations for the alert percentage.
o PutActivationState(CATBoolean)
Turns ON/OFF the memory warning mechanism.
o PutMemoryStopperState(CATBoolean)
Turns ON/OFF the memory stopper mechanism.
o PutUsageLimit(int)
Sets the alert percentage.
o SetActivationStateLock(unsigned char)
Locks or unlocks the activation mode of the memory warning mechanism.
o SetMemoryStopperStateLock(unsigned char)
Locks or unlocks the activation mode of the memory stopper mechanism.
o SetUsageLimitLock(unsigned char)
Locks or unlocks the the alert percentage.

Methods


o GetActivationState
public virtual HRESULT GetActivationState(CATBoolean* oActivationState)=0
Returns activation state of memory warning mechanism.
Role:Returns or sets the activation state of memory warning.
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 environment informations for the memory warning mechanism.
Refer to CATSysSettingController for a detailled description.
o GetMemoryStopperState
public virtual HRESULT GetMemoryStopperState(CATBoolean* oActivationState)=0
Returns activation state of memory stopper mechanism.
Role:Returns or sets the activation state of memory stopper.
Parameters:
oMode
Legal values:
FALSE: turned off
TRUE: turned on
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetMemoryStopperStateInfo
public virtual HRESULT GetMemoryStopperStateInfo(CATSettingInfo* oInfo)=0
Retrieves environment informations for the memory stopper mechanism.
Refer to CATSysSettingController for a detailled description.
o GetUsageLimit
public virtual HRESULT GetUsageLimit(int* oMaxLimit)=0
Returns the alert percentage.
Role: Returns or sets the percentage of the address space usage that can be used by the process before sending the warning.
Parameters:
oMaxLimit
the percentage of the address space usage.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetUsageLimitInfo
public virtual HRESULT GetUsageLimitInfo(CATSettingInfo* oInfo)=0
Retrieves environment informations for the alert percentage.
Refer to CATSysSettingController for a detailled description.
o PutActivationState
public virtual HRESULT PutActivationState(CATBoolean iActivationState)=0
Turns ON/OFF the memory warning mechanism.
Role: Activates or desactivates memory warning 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 PutMemoryStopperState
public virtual HRESULT PutMemoryStopperState(CATBoolean iActivationState)=0
Turns ON/OFF the memory stopper mechanism.
Role: Activates or desactivates memory stopper 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 PutUsageLimit
public virtual HRESULT PutUsageLimit(int iMaxLimit)=0
Sets the alert percentage.
Role: Sets the percentage of the address space usage that can be used by the process before sending the warning.
Parameters:
iMaxLimit
the percentage of the address space usage.
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 the memory warning mechanism.
Refer to CATSysSettingController for a detailled description.
o SetMemoryStopperStateLock
public virtual HRESULT SetMemoryStopperStateLock(unsigned char iLock)=0
Locks or unlocks the activation mode of the memory stopper mechanism.
Refer to CATSysSettingController for a detailled description.
o SetUsageLimitLock
public virtual HRESULT SetUsageLimitLock(unsigned char iLock)=0
Locks or unlocks the the alert percentage.
Refer to CATSysSettingController for a detailled description.

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

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