pycatia.system_interfaces.memory_warning_setting_att

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-09 09:53:18.676780

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.system_interfaces.memory_warning_setting_att.MemoryWarningSettingAtt(com_object)

Note

CAA V5 Visual Basic Help (2020-06-09 09:53:18.676780)

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.AnyObject
System.SettingController
MemoryWarningSettingAtt

Represents the base object to handle the parameters of 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.
property activation_state

Note

CAA V5 Visual Basic Help (2020-06-09 09:53:18.676780)
o Property ActivationState() As boolean

Returns or sets the activation state of the memory warning
mechanism.
Role: Returns or sets the value of of the memory warning.
Returns:

bool

get_activation_state_info(admin_level, o_locked)

Note

CAA V5 Visual Basic Help (2020-06-09 09:53:18.676780))
o Func GetActivationStateInfo(CATBSTR AdminLevel,
CATBSTR oLocked) As boolean

Retrieves environment informations for the memory warning
mechanism.
Refer to SettingController for a detailed description.
Parameters:

  • admin_level (str) –

  • o_locked (str) –

Returns:

None

get_memory_stopper_state_info(admin_level, o_locked)

Note

CAA V5 Visual Basic Help (2020-06-09 09:53:18.676780))
o Func GetMemoryStopperStateInfo(CATBSTR AdminLevel,
CATBSTR oLocked) As boolean

Retrieves environment informations for the memory stopper
mechanism.
Refer to SettingController for a detailed description.
Parameters:

  • admin_level (str) –

  • o_locked (str) –

Returns:

None

get_usage_limit_info(admin_level, o_locked)

Note

CAA V5 Visual Basic Help (2020-06-09 09:53:18.676780))
o Func GetUsageLimitInfo(CATBSTR AdminLevel,
CATBSTR oLocked) As boolean

Retrieves environment informations for the alert
percentage.
Refer to SettingController for a detailed description.
Parameters:

  • admin_level (str) –

  • o_locked (str) –

Returns:

None

property memory_stopper_state

Note

CAA V5 Visual Basic Help (2020-06-09 09:53:18.676780)
o Property MemoryStopperState() As boolean

Returns or sets the activation state of the memory stopper
mechanism.
Role: Returns or sets the value of of the memory stopper.
Returns:

bool

set_activation_state_lock(i_locked)

Note

CAA V5 Visual Basic Help (2020-06-09 09:53:18.676780))
o Sub SetActivationStateLock(boolean iLocked)

Locks or unlocks the activation mode of the memory warning
mechanism.
Refer to SettingController for a detailed description.
Parameters:

i_locked (bool) –

Returns:

None

set_memory_stopper_state_lock(i_locked)

Note

CAA V5 Visual Basic Help (2020-06-09 09:53:18.676780))
o Sub SetMemoryStopperStateLock(boolean iLocked)

Locks or unlocks the activation mode of the memory stopper
mechanism.
Refer to SettingController for a detailed description.
Parameters:

i_locked (bool) –

Returns:

None

set_usage_limit_lock(i_locked)

Note

CAA V5 Visual Basic Help (2020-06-09 09:53:18.676780))
o Sub SetUsageLimitLock(boolean iLocked)

Locks or unlocks the the alert percentage.
Refer to SettingController for a detailed description.
Parameters:

i_locked (bool) –

Returns:

None

property usage_limit

Note

CAA V5 Visual Basic Help (2020-06-09 09:53:18.676780)
o Property UsageLimit() As long

Returns or sets 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.
Returns:

int