All Frameworks  Class Hierarchy  This Framework  Indexes   

System Interface 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 GetActivationStateInfo(CATSettingInfo*)
Retrieves environment informations for the memory warning mechanism.
o GetActivationState(CATBoolean*)
Returns activation state of memory warning mechanism.
o GetMemoryStopperStateInfo(CATSettingInfo*)
Retrieves environment informations for the memory stopper mechanism.
o GetMemoryStopperState(CATBoolean*)
Returns activation state of memory stopper mechanism.
o GetUsageLimitInfo(CATSettingInfo*)
Retrieves environment informations for the alert percentage.
o GetUsageLimit(int*)
Returns 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 GetActivationStateInfo
public virtual GetActivationStateInfo( oInfo)
Retrieves environment informations for the memory warning mechanism.
Refer to CATSysSettingController for a detailled description.
o GetActivationState
public virtual GetActivationState( oActivationState)
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 GetMemoryStopperStateInfo
public virtual GetMemoryStopperStateInfo( oInfo)
Retrieves environment informations for the memory stopper mechanism.
Refer to CATSysSettingController for a detailled description.
o GetMemoryStopperState
public virtual GetMemoryStopperState( oActivationState)
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 GetUsageLimitInfo
public virtual GetUsageLimitInfo( oInfo)
Retrieves environment informations for the alert percentage.
Refer to CATSysSettingController for a detailled description.
o GetUsageLimit
public virtual GetUsageLimit( oMaxLimit)
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 PutActivationState
public virtual PutActivationState( iActivationState)
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 PutMemoryStopperState( iActivationState)
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 PutUsageLimit( iMaxLimit)
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 SetActivationStateLock( iLock)
Locks or unlocks the activation mode of the memory warning mechanism.
Refer to CATSysSettingController for a detailled description.
o SetMemoryStopperStateLock
public virtual SetMemoryStopperStateLock( iLock)
Locks or unlocks the activation mode of the memory stopper mechanism.
Refer to CATSysSettingController for a detailled description.
o SetUsageLimitLock
public virtual SetUsageLimitLock( iLock)
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.