pycatia.cat_ipd_adapter_interfaces.mfg_hub_setting_att

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-09-25 14:34:21.593357

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.cat_ipd_adapter_interfaces.mfg_hub_setting_att.MfgHubSettingAtt(com_object)

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

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

Represents the Manufacturing Hub setting controller object.
Role: The HubSettingAtt1 setting controller object deals with the setting
attributes displayed in the PPR Hub property page. To access this property
page:

Click the Options command in the Tools menu
Click + left of Digital Process for Manufacturing to unfold the workbench
list
Right scroll to display the property pages titles until you get PPR
Hub
Click PPR Hub

The New Elements setting controller object can be retrieved as an item of the
setting controller collection using its name “HubSettingAtt1” as
follows:

Dim settingControllers1 As SettingControllers
Set settingControllers1 = CATIA.SettingControllers
Dim HubSettingAtt1 as DNBMHIMfgHubSettingCtrl
set HubSettingAtt1 = settingControllers1.Item( “DNBMHIMfgHubSettingCtrl” )
property append_context_chk_b: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property AppendContextChkB() As boolean

Retrieves (or sets, if not initialized) the AppendContextChkB
attribute.

A TRUE value indicates that the loaded context will be appended to the
existing context in the V5 process document
Return type:

bool

property apply_label_eff_to_alt_child: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property ApplyLabelEffToAltChild() As boolean

Retrieves (or sets, if not initialized) the ApplyLabelEffToAltChild
attribute.

A TRUE value indicates that the label effectivity will be applied to all
components associated with the Alternative
Return type:

bool

property auto_load_mfg_ctx: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property AutoLoadMfgCtx() As boolean

Retrieves (or sets, if not initialized) the AutoLoadMfgCtx
parameter.

A TRUE value indicates that the manufacturing context is automatically
(computed and) loaded into the V5 process document during load
Return type:

bool

property auto_load_srv_mfg_ctx: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property AutoLoadSrvMfgCtx() As boolean

Retrieves (or sets, if not initialized) the AutoLoadSrvMfgCtx
parameter.

A TRUE value indicates that the existing volumetric context is to be
automatically loaded into the V5 process document during load
Return type:

bool

property auto_load_vol_ctx: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property AutoLoadVolCtx() As boolean

Retrieves (or sets, if not initialized) the AutoLoadVolCtx
parameter.

A TRUE value indicates that the existing volumetric context is to be
automatically loaded into the V5 process document during load
Return type:

bool

property disable_shape_roll_up: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property DisableShapeRollUp() As boolean

Retrieves (or sets, if not initialized) the DisableShapeRollUp
attribute.

A TRUE value indicates that the Shape Rollup won’t be added during load
Return type:

bool

get_append_context_chk_b_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetAppendContextChkBInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the AppendContextChkB
parameter.
Role:Retrieves the state of the AppendContextChkB parameter in the current
environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_apply_label_eff_to_alt_child_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetApplyLabelEffToAltChildInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the ApplyLabelEffToAltChild
parameter.
Role:Retrieves the state of the ApplyLabelEffToAltChild parameter in the
current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_auto_load_mfg_ctx_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetAutoLoadMfgCtxInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the AutoLoadMfgCtx
parameter.
Role:Retrieves the state of the AutoLoadMfgCtx parameter in the current
environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_auto_load_srv_mfg_ctx_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetAutoLoadSrvMfgCtxInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the AutoLoadSrvMfgCtx
parameter.
Role:Retrieves the state of the AutoLoadSrvMfgCtx parameter in the current
environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_auto_load_vol_ctx_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetAutoLoadVolCtxInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the AutoLoadVolCtx
parameter.
Role:Retrieves the state of the AutoLoadVolCtx parameter in the current
environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_disable_shape_roll_up_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetDisableShapeRollUpInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the DisableShapeRollUp
parameter.
Role:Retrieves the state of the DisableShapeRollUp parameter in the current
environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_issue_repository_path_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetIssueRepositoryPathInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves the state of the IssueRepositoryPath parameter.

Parameters:

oInfo
Address of an object CATSettingInfo.

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetLinkSendModeInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves the state of the LinkSendMode parameter.

Parameters:

oInfo
Address of an object CATSettingInfo.

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_load_3d_state_and_pos_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetLoad3dStateAndPosInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the Load3dStateAndPos
parameter.
Role:Retrieves the state of the Load3dStateAndPos parameter in the current
environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_load_all_child_proc_mfg_ctx_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetLoadAllChildProcMfgCtxInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the LoadAllChildProcMfgCtx
parameter.
Role:Retrieves the state of the LoadAllChildProcMfgCtx parameter in the
current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_load_assoc_prd_res_child_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetLoadAssocPrdResChildInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the LoadAssocPrdResChild
parameter.
Role:Retrieves the state of the LoadAssocPrdResChild parameter in the
current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_load_child_proc_mfg_ctx_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetLoadChildProcMfgCtxInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the LoadChildProcMfgCtx
parameter.
Role:Retrieves the state of the LoadChildProcMfgCtx parameter in the
current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_load_ctx_with_file_geometry_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetLoadCtxWithFileGeometryInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the LoadCtxWithFileGeometry
parameter.
Role:Retrieves the state of the LoadCtxWithFileGeometry parameter in the
current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_load_disp_mfg_ctx_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetLoadDispMfgCtxInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the LoadDispMfgCtx
parameter.
Role:Retrieves the state of the LoadDispMfgCtx parameter in the current
environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_load_duplicates_in_context_tree_chk_b_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetLoadDuplicatesInContextTreeChkBInfo(CATBSTR
ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the LoadDuplicatesChkB
parameter.
Role:Retrieves the state of the LoadDuplicatesChkB parameter in the current
environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_load_env_geom_from_en_vdb_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetLoadENVGeomFromENVdbInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the LoadENVGeomFromENVdb
parameter.
Role:Retrieves the state of the LoadENVGeomFromENVdb parameter in the
current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_load_feed_proc_mfg_ctx_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetLoadFeedProcMfgCtxInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the LoadFeedProcMfgCtx
parameter.
Role:Retrieves the state of the LoadFeedProcMfgCtx parameter in the current
environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_load_mfg_assmbly_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetLoadMfgAssmblyInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the LoadMfgAssmbly
parameter.
Role:Retrieves the state of the LoadMfgAssmbly parameter in the current
environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_load_mfg_kits_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetLoadMfgKitsInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the LoadMfgKits
parameter.
Role:Retrieves the state of the LoadMfgKits parameter in the current
environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_load_prd_res_user_attribs_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetLoadPrdResUserAttribsInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the LoadPrdResUserAttribs
parameter.
Role:Retrieves the state of the LoadPrdResUserAttribs parameter in the
current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_load_pss_data_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetLoadPSSDataInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the LoadPSSData
parameter.
Role:Retrieves the state of the LoadPSSData parameter in the current
environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_load_res_geo_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetLoadResGeoInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the LoadResGeo
parameter.
Role:Retrieves the state of the LoadResGeo parameter in the current
environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_load_unconstrained_mfg_ctx_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetLoadUnconstrainedMfgCtxInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the LoadUnconstrainedMfgCtx
parameter.
Role:Retrieves the state of the LoadUnconstrainedMfgCtx parameter in the
current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_lock_assigned_prd_on_load_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetLockAssignedPrdOnLoadInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the LockAssignedPrdOnLoad
parameter.
Role:Retrieves the state of the LockAssignedPrdOnLoad parameter in the
current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_mail_client_launch_mode_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetMailClientLaunchModeInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves the state of the MailClientLaunchMode parameter.

Parameters:

oInfo
Address of an object CATSettingInfo.

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_mfg_ctx_prev_proc_relation_type_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetMfgCtxPrevProcRelationTypeInfo(CATBSTR
ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment information for the MfgCtxPrevProcRelationType
parameter
Role:Retrieves the state of the MfgCtxPrevProcRelationType parameter in the
current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_only_load_ctx_with_geometry_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetOnlyLoadCtxWithGeometryInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the OnlyLoadCtxWithGeometry
parameter.
Role:Retrieves the state of the OnlyLoadCtxWithGeometry parameter in the
current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_open_mode_for_load_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetOpenModeForLoadInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the OpenModeForLoad
parameter.
Role:Retrieves the value of the OpenModeForLoad parameter in the current
environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_pack_and_go_repository_path_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetPackAndGoRepositoryPathInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves the state of the PackAndGoRepositoryPath
parameter.

Parameters:

oInfo
Address of an object CATSettingInfo.

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_post_load_script_option_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetPostLoadScriptOptionInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the PostLoadScriptOption
parameter.
Role:Retrieves the state of the PostLoadScriptOption parameter in the
current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_post_load_script_path_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetPostLoadScriptPathInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves the state of the PostLoadScriptPath parameter.

Parameters:

oInfo
Address of an object CATSettingInfo.

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_post_load_vba_module_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetPostLoadVBAModuleInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves the state of the PostLoadVBAModule parameter.

Parameters:

oInfo
Address of an object CATSettingInfo.

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_prev_proc_parse_type_for_mfg_ctx_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetPrevProcParseTypeForMfgCtxInfo(CATBSTR
ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the PrevProcParseTypeForMfgCtx
parameter.
Role:Retrieves the state of the PrevProcParseTypeForMfgCtx parameter in the
current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_proc_prod_relations_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetProcProdRelationsInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the ProcProdRelations
parameter.
Role:Retrieves the state of the ProcProdRelations parameter in the current
environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_proc_res_relations_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetProcResRelationsInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the ProcResRelations
parameter.
Role:Retrieves the state of the ProcResRelations parameter in the current
environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_rmv_not_assgn_prd_res_on_sync_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetRmvNotAssgnPrdResOnSyncInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the RmvNotAssgnPrdResOnSync
parameter.
Role:Retrieves the state of the RmvNotAssgnPrdResOnSync parameter in the
current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_save_control_flow_in_pro_mode_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetSaveControlFlowInPROModeInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the SaveControlFlowInPROMode
parameter.
Role:Retrieves the state of the SaveControlFlowInPROMode parameter in the
current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_save_ppr_no_detailing_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetSavePPRNoDetailingInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the SavePPRNoDetailing
parameter.
Role:Retrieves the state of the SavePPRNoDetailing parameter in the current
environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_save_relation_to_un_exposed_part_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetSaveRelationToUnExposedPartInfo(CATBSTR
ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the SaveRelationToUnExposedPart
parameter.
Role:Retrieves the state of the SaveRelationToUnExposedPart parameter in
the current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_save_show_effctvt_panel_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetSaveShowEffctvtPanelInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the SaveShowEffctvtPanel
parameter.
Role:Retrieves the state of the SaveShowEffctvtPanel parameter in the
current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_save_v5_calc_time_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetSaveV5CalcTimeInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the SaveV5CalcTime
parameter.
Role:Retrieves the state of the SaveV5CalcTime parameter in the current
environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_show_only_filtered_objects_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetShowOnlyFilteredObjectsInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the ShowOnlyFilteredObjects
parameter.
Role:Retrieves the state of the ShowOnlyFilteredObjects parameter in the
current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

property issue_repository_path: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property IssueRepositoryPath() As CATBSTR

Retrieves (or sets, if not initialized) the IssueRepositoryPath
attribute.

Parameters:

oIssueRepositoryPath
[out] Path stored in settings (or default path if none stored)


Returns:
S_OK if everything ran ok
Return type:

str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property LinkSendMode() As short

Retrieves (or sets, if not initialized) the LinkSendMode
attribute.

Parameters:

ioLinkSendMode
[inout] The value stored in settings (or default value if none
stored) Legal values:
0: If link location is to be sent
1: If link itself is to be sent (as attachment)

Returns:
S_OK if everything ran ok
Return type:

int

property load_3d_state_and_pos: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Load3dStateAndPos() As boolean

Retrieves (or sets, if not initialized) the Load3dStateAndPos
parameter.

A TRUE value indicates that the ENOVIA product geometry will be loaded from
ENOVIA database.
Return type:

bool

property load_all_child_proc_mfg_ctx: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property LoadAllChildProcMfgCtx() As boolean

Retrieves (or sets, if not initialized) the LoadAllChildProcMfgCtx
parameter.

If set to TRUE than during load of manufacturing context the child
processes of the previous processes will also be considered
Return type:

bool

property load_assoc_prd_res_child: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property LoadAssocPrdResChild() As boolean

Retrieves (or sets, if not initialized) the LoadAssocPrdResChild
parameter.

A TRUE value indicates that the associated prdres children will be loaded
from the database.
Return type:

bool

property load_child_proc_mfg_ctx: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property LoadChildProcMfgCtx() As boolean

Retrieves (or sets, if not initialized) the LoadChildProcMfgCtx
parameter.

If set to TRUE than during load of manufacturing context the child
processes of the previous processes will also be considered
Return type:

bool

property load_ctx_with_file_geometry: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property LoadCtxWithFileGeometry() As boolean

Retrieves (or sets, if not initialized) the LoadCtxWithFileGeometry
parameter.

A TRUE value indicates that the existing volumetric context is to be
automatically loaded into the V5 process document during load
Return type:

bool

property load_disp_mfg_ctx: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property LoadDispMfgCtx() As boolean

Retrieves (or sets, if not initialized) the LoadDispMfgCtx
parameter.

A TRUE value indicates that the manufacturing context is display in the V5
process document
Return type:

bool

property load_duplicates_in_context_tree_chk_b: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property LoadDuplicatesInContextTreeChkB() As boolean

Retrieves (or sets, if not initialized) the LoadDuplicatesChkB
attribute.

A TRUE value indicates that the duplicate objects will be loaded in the
context in the V5 process document
Return type:

bool

property load_env_geom_from_en_vdb: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property LoadENVGeomFromENVdb() As boolean

Retrieves (or sets, if not initialized) the LoadENVGeomFromENVdb
parameter.

A TRUE value indicates that the ENOVIA product geometry will be loaded from
ENOVIA database.
Return type:

bool

property load_feed_proc_mfg_ctx: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property LoadFeedProcMfgCtx() As boolean

Retrieves (or sets, if not initialized) the LoadFeedProcMfgCtx
parameter.

A TRUE value indicates that during load the manufacturing context will also
include products / resource of the feeder process of the previous processes in
process graph
Return type:

bool

property load_mfg_assembly: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property LoadMfgAssmbly() As boolean

Retrieves (or sets, if not initialized) the LoadMfgAssmbly
parameter.

A TRUE value indicates that the Manufacturing Assemblies related to process
will be loaded when a PPRHub project is opened in V5
Return type:

bool

property load_mfg_kits: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property LoadMfgKits() As boolean

Retrieves (or sets, if not initialized) the LoadMfgKits
parameter.

A TRUE value indicates tthat the Manufacturing Kits related to process will
be loaded when a PPRHub project is opened in V5
Return type:

bool

property load_prd_res_user_attribs: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property LoadPrdResUserAttribs() As boolean

Retrieves (or sets, if not initialized) the LoadPrdResUserAttribs
parameter.
Return type:

bool

property load_pss_data: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property LoadPSSData() As boolean

Retrieves (or sets, if not initialized) the LoadPSSData
attribute.

A TRUE value indicates that the PSS data will be loaded from the database.
Return type:

bool

property load_res_geo: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property LoadResGeo() As boolean

Retrieves (or sets, if not initialized) the LoadResGeo
parameter.

A TRUE value indicates tthat the Geometries related to Resource will be
loaded when a PPRHub project is opened in V5
Return type:

bool

property load_unconstrained_mfg_ctx: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property LoadUnconstrainedMfgCtx() As boolean

Retrieves (or sets, if not initialized) the LoadUnconstrainedMfgCtx
parameter.

A TRUE value indicates that on load the manufacturing context will also
include products / resource of the processes not linked in the process graph
containing loaded process
Return type:

bool

property lock_assigned_prd_on_load: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property LockAssignedPrdOnLoad() As boolean

Retrieves (or sets, if not initialized) the LockAssignedPrdOnLoad
parameter.

If set to TRUE than on load all the products assigned to process(es) will
be locked in WRITE mode
Return type:

bool

property mail_client_launch_mode: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property MailClientLaunchMode() As boolean

Retrieves (or sets, if not initialized) the MailClientLaunchMode
attribute.

Parameters:

ioMailClientLaunchMode
[inout] The value stored in settings (or default value if none
stored) Legal values:
1: If mail client is to be launched
0: If mail client is not to be launched

Returns:
S_OK if everything ran ok
Return type:

bool

property mfg_ctx_prev_proc_relation_type: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property MfgCtxPrevProcRelationType() As short

Retrieves the MfgCtxPrevProcRelationType parameter

The valid integer values (0,1) define the type of Process Traversal
Relations to consider while computing Manufacturing Context
Return type:

int

property only_load_ctx_with_geometry: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property OnlyLoadCtxWithGeometry() As boolean

Retrieves (or sets, if not initialized) the OnlyLoadCtxWithGeometry
parameter.

A TRUE value indicates that the existing volumetric context is to be
automatically loaded into the V5 process document during load
Return type:

bool

property open_mode_for_load: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property OpenModeForLoad() As long

Retrieves (or sets, if not initialized) the OpenModeForLoad
attribute.

Parameters:

oOpenModeForLoad[out]
The mode with which the data will be loaded in hub. The possible
values are as follows 0: Read-Write Mode (Default) 1: Partial Read Only Mode 2:
Read Only mode
Return type:

int

property pack_and_go_repository_path: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property PackAndGoRepositoryPath() As CATBSTR

Retrieves (or sets, if not initialized) the PackAndGoRepositoryPath
attribute.

Parameters:

ioPackAndGoRepositoryPath
[out] Path stored in settings (or default path if none stored)


Returns:
S_OK if everything ran ok
Return type:

str

property post_load_script_option: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property PostLoadScriptOption() As boolean

Retrieves (or sets, if not initialized) the PostLoadScriptOption
attribute.

A TRUE value indicates that the provided script in the editor will be
executed post Load
Return type:

bool

property post_load_script_path: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property PostLoadScriptPath() As CATBSTR

Retrieves (or sets, if not initialized) the PostLoadScriptPath
attribute.

Parameters:

oPostLoadScriptPath
[out] Path stored in settings (or default path if none stored)


Returns:
S_OK if everything ran ok
Return type:

str

property post_load_vba_module: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property PostLoadVBAModule() As CATBSTR

Retrieves (or sets, if not initialized) the PostLoadVBAModule
attribute.

Parameters:

ioPostLoadVBAModule
[inout] VBA Module name stored in settings

Returns:
S_OK if everything ran ok
Return type:

str

property prev_proc_parse_type_for_mfg_ctx: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property PrevProcParseTypeForMfgCtx() As short

Retrieves or sets the PrevProcParseTypeForMfgCtx
parameter.

The valid integer values (0,1,2) define extent of parsing previous process
in the loaded process’ parent process structure
Return type:

int

property proc_prod_relations: tuple

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property ProcProdRelations() As CATSafeArrayVariant

Retrieves (or sets, if not initialized) the ProcProdRelations
attribute.

A safe array of process - product relations to be loaded
Return type:

tuple

property proc_res_relations: tuple

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property ProcResRelations() As CATSafeArrayVariant

Retrieves (or sets, if not initialized) the ProcResRelations
attribute.

A safe array of process - resource relations to be loaded
Return type:

tuple

property rmv_not_assgn_prd_res_on_sync: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property RmvNotAssgnPrdResOnSync() As boolean

Retrieves (or sets, if not initialized) the RmvNotAssgnPrdResOnSync
parameter.

If set to TRUE than on synchronization during load the products or
resources that are not assigned to any loaded processes will be removed from
the V5 document.
Return type:

bool

property save_control_flow_in_pro_mode: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property SaveControlFlowInPROMode() As boolean

Retrieves (or sets, if not initialized) the SaveControlFlowInPROMode
attribute.

A TRUE value indicates that the Control flow will be saved to the database
in Partial Read only mode
Return type:

bool

property save_ppr_no_detailing: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property SavePPRNoDetailing() As boolean

Returns (or sets, if not initialized) the SavePPRNoDetailing
parameter.

A TRUE value indicates that simulation detailing data is NOT saved in PPR
hub during save.
Return type:

bool

property save_relation_to_un_exposed_part: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property SaveRelationToUnExposedPart() As boolean

Returns (or sets, if not initialized) the SaveRelationToUnExposedPart
parameter.

A TRUE value indicates that the relation to unexposed part will be saved in
the database
Return type:

bool

property save_show_effctvt_panel: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property SaveShowEffctvtPanel() As boolean

Retrieves (or sets, if not initialized) the SaveShowEffctvtPanel
parameter.

If set to TRUE (and SavePPRNoDetailing is TRUE) a panel is displayed
showing effectivity filter information
Return type:

bool

property save_v5_calc_time: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property SaveV5CalcTime() As boolean

Returns (or sets, if not initialized) the SaveV5CalcTime
parameter.

A TRUE value indicates that the calculated cycle time for V5 process should
be assigned to corresponding E5 process attribure on save
Return type:

bool

set_append_context_chk_b_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetAppendContextChkBLock(boolean iLocked)

Locks or unlocks the AppendContextChkB parameter.
Role:Locks or unlocks the AppendContextChkB parameter if it is possible in
the current administrative context. In user mode this method will always return
E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_apply_label_eff_to_alt_child_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetApplyLabelEffToAltChildLock(boolean iLocked)

Locks or unlocks the ApplyLabelEffToAltChild parameter.
Role:Locks or unlocks the ApplyLabelEffToAltChild parameter if it is
possible in the current administrative context. In user mode this method will
always return E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_auto_load_mfg_ctx_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetAutoLoadMfgCtxLock(boolean iLocked)

Locks or unlocks the AutoLoadMfgCtx parameter.
Role:Locks or unlocks the AutoLoadMfgCtx parameter if it is possible in the
current administrative context. In user mode this method will always return
E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_auto_load_srv_mfg_ctx_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetAutoLoadSrvMfgCtxLock(boolean iLocked)

Locks or unlocks the AutoLoadSrvMfgCtx parameter.
Role:Locks or unlocks the AutoLoadSrvMfgCtx parameter if it is possible in
the current administrative context. In user mode this method will always return
E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_auto_load_vol_ctx_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetAutoLoadVolCtxLock(boolean iLocked)

Locks or unlocks the AutoLoadVolCtx parameter.
Role:Locks or unlocks the AutoLoadVolCtx parameter if it is possible in the
current administrative context. In user mode this method will always return
E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_disable_shape_roll_up_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetDisableShapeRollUpLock(boolean iLocked)

Locks or unlocks the DisableShapeRollUp parameter.
Role:Locks or unlocks the DisableShapeRollUp parameter if it is possible in
the current administrative context. In user mode this method will always return
E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_issue_repository_path_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetIssueRepositoryPathLock(boolean iLocked)

Locks or unlocks the IssueRepositoryPath parameter.
Role: Locks or unlocks the IssueRepositoryPath parameter if the operation
is allowed in the current administrated environment. In user mode this method
will always return E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
1 : to lock the parameter.
0: to unlock the parameter.

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

i_locked (bool) –

Return type:

None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetLinkSendModeLock(boolean iLocked)

Locks or unlocks the LinkSendMode parameter.
Role: Locks or unlocks the LinkSendMode parameter if the operation is
allowed in the current administrated environment. In user mode this method will
always return E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
1 : to lock the parameter.
0: to unlock the parameter.

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

i_locked (bool) –

Return type:

None

set_load_3d_state_and_pos_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetLoad3dStateAndPosLock(boolean iLocked)

Locks or unlocks the Load3dStateAndPos parameter.
Role:Locks or unlocks the Load3dStateAndPos parameter if it is possible in
the current administrative context. In user mode this method will always return
E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_load_all_child_proc_mfg_ctx_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetLoadAllChildProcMfgCtxLock(boolean iLocked)

Locks or unlocks the LoadAllChildProcMfgCtx parameter.
Role:Locks or unlocks the LoadAllChildProcMfgCtx parameter if it is
possible in the current administrative context. In user mode this method will
always return E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_load_assoc_prd_res_child_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetLoadAssocPrdResChildLock(boolean iLocked)

Locks or unlocks the LoadAssocPrdResChild parameter.
Role:Locks or unlocks the LoadAssocPrdResChild parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_load_child_proc_mfg_ctx_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetLoadChildProcMfgCtxLock(boolean iLocked)

Locks or unlocks the LoadChildProcMfgCtx parameter.
Role:Locks or unlocks the LoadChildProcMfgCtx parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_load_ctx_with_file_geometry_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetLoadCtxWithFileGeometryLock(boolean iLocked)

Locks or unlocks the LoadCtxWithFileGeometry parameter.
Role:Locks or unlocks the LoadCtxWithFileGeometry parameter if it is
possible in the current administrative context. In user mode this method will
always return E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_load_disp_mfg_ctx_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetLoadDispMfgCtxLock(boolean iLocked)

Locks or unlocks the LoadDispMfgCtx parameter.
Role:Locks or unlocks the LoadDispMfgCtx parameter if it is possible in the
current administrative context. In user mode this method will always return
E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_load_duplicates_in_context_tree_chk_b_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetLoadDuplicatesInContextTreeChkBLock(boolean
iLocked)

Locks or unlocks the LoadDuplicatesChkB parameter.
Role:Locks or unlocks the LoadDuplicatesChkB parameter if it is possible in
the current administrative context. In user mode this method will always return
E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_load_env_geom_from_en_vdb_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetLoadENVGeomFromENVdbLock(boolean iLocked)

Locks or unlocks the LoadENVGeomFromENVdb parameter.
Role:Locks or unlocks the LoadENVGeomFromENVdb parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_load_feed_proc_mfg_ctx_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetLoadFeedProcMfgCtxLock(boolean iLocked)

Locks or unlocks the SaveV5CalcTime parameter.
Role:Locks or unlocks the SaveV5CalcTime parameter if it is possible in the
current administrative context. In user mode this method will always return
E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_load_mfg_assmbly_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetLoadMfgAssmblyLock(boolean iLocked)

Locks or unlocks the LoadMfgAssmbly parameter.
Role:Locks or unlocks the LoadMfgAssmbly parameter if it is possible in the
current administrative context. In user mode this method will always return
E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_load_mfg_kits_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetLoadMfgKitsLock(boolean iLocked)

Locks or unlocks the LoadMfgKits parameter.
Role:Locks or unlocks the LoadMfgKits parameter if it is possible in the
current administrative context. In user mode this method will always return
E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_load_prd_res_user_attribs_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetLoadPrdResUserAttribsLock(boolean iLocked)

Locks or unlocks the LoadPrdResUserAttribs parameter.
Role:Locks or unlocks the LoadPrdResUserAttribs parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_load_pss_data_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetLoadPSSDataLock(boolean iLocked)

Locks or unlocks the LoadPSSData parameter.
Role:Locks or unlocks the LoadPSSData parameter if it is possible in the
current administrative context. In user mode this method will always return
E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_load_res_geo_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetLoadResGeoLock(boolean iLocked)

Locks or unlocks the LoadResGeo parameter.
Role:Locks or unlocks the LoadResGeo parameter if it is possible in the
current administrative context. In user mode this method will always return
E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_load_unconstrained_mfg_ctx_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetLoadUnconstrainedMfgCtxLock(boolean iLocked)

Locks or unlocks the LoadUnconstrainedMfgCtx parameter.
Role:Locks or unlocks the LoadUnconstrainedMfgCtx parameter if it is
possible in the current administrative context. In user mode this method will
always return E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_lock_assigned_prd_on_load_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetLockAssignedPrdOnLoadLock(boolean iLocked)

Locks or unlocks the LockAssignedPrdOnLoad parameter.
Role:Locks or unlocks the LockAssignedPrdOnLoad parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_mail_client_launch_mode_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetMailClientLaunchModeLock(boolean iLocked)

Locks or unlocks the MailClientLaunchMode parameter.
Role: Locks or unlocks the MailClientLaunchMode parameter if the operation
is allowed in the current administrated environment. In user mode this method
will always return E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
1 : to lock the parameter.
0: to unlock the parameter.

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

i_locked (bool) –

Return type:

None

set_mfg_ctx_prev_proc_relation_type_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetMfgCtxPrevProcRelationTypeLock(boolean iLocked)

Locks or unlocks the GetMfgCtxPrevProcRelationType
parameter.
Role:Locks or unlocks the GetMfgCtxPrevProcRelationType parameter if it is
possible in the current administrative context. In user mode this method will
always return E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_only_load_ctx_with_geometry_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetOnlyLoadCtxWithGeometryLock(boolean iLocked)

Locks or unlocks the OnlyLoadCtxWithGeometry parameter.
Role:Locks or unlocks the OnlyLoadCtxWithGeometry parameter if it is
possible in the current administrative context. In user mode this method will
always return E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_open_mode_for_load_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetOpenModeForLoadLock(boolean iLocked)

Locks or unlocks the OpenModeForLoad parameter.
Role:Locks or unlocks the OpenModeForLoad parameter if it is possible in
the current administrative context. In user mode this method will always return
E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_pack_and_go_repository_path_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetPackAndGoRepositoryPathLock(boolean iLocked)

Locks or unlocks the PackAndGoRepositoryPath parameter.
Role: Locks or unlocks the PackAndGoRepositoryPath parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
1 : to lock the parameter.
0: to unlock the parameter.

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

i_locked (bool) –

Return type:

None

set_post_load_script_option_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetPostLoadScriptOptionLock(boolean iLocked)

Locks or unlocks the PostLoadScriptOption parameter.
Role:Locks or unlocks the PostLoadScriptOption parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_post_load_script_path_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetPostLoadScriptPathLock(boolean iLocked)

Locks or unlocks the PostLoadScriptPath parameter.
Role: Locks or unlocks the PostLoadScriptPath parameter if the operation is
allowed in the current administrated environment. In user mode this method will
always return E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
1 : to lock the parameter.
0: to unlock the parameter.

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

i_locked (bool) –

Return type:

None

set_post_load_vba_module_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetPostLoadVBAModuleLock(boolean iLocked)

Locks or unlocks the PostLoadVBAModule parameter.
Role: Locks or unlocks the PostLoadVBAModule parameter if the operation is
allowed in the current administrated environment. In user mode this method will
always return E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
1 : to lock the parameter.
0: to unlock the parameter.

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

i_locked (bool) –

Return type:

None

set_prev_proc_parse_type_for_mfg_ctx_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetPrevProcParseTypeForMfgCtxLock(boolean iLocked)

Locks or unlocks the PrevProcParseTypeForMfgCtx parameter.
Role:Locks or unlocks the PrevProcParseTypeForMfgCtx parameter if it is
possible in the current administrative context. In user mode this method will
always return E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_proc_prod_relations_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetProcProdRelationsLock(boolean iLocked)

Locks or unlocks the ProcProdRelations parameter.
Role:Locks or unlocks the ProcProdRelations parameter if it is possible in
the current administrative context. In user mode this method will always return
E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_proc_res_relations_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetProcResRelationsLock(boolean iLocked)

Locks or unlocks the ProcResRelations parameter.
Role:Locks or unlocks the ProcResRelations parameter if it is possible in
the current administrative context. In user mode this method will always return
E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_rmv_not_assgn_prd_res_on_sync_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetRmvNotAssgnPrdResOnSyncLock(boolean iLocked)

Locks or unlocks the RmvNotAssgnPrdResOnSync parameter.
Role:Locks or unlocks the RmvNotAssgnPrdResOnSync parameter if it is
possible in the current administrative context. In user mode this method will
always return E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_save_control_flow_in_pro_mode_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetSaveControlFlowInPROModeLock(boolean iLocked)

Locks or unlocks the SaveControlFlowInPROMode parameter.
Role:Locks or unlocks the SaveControlFlowInPROMode parameter if it is
possible in the current administrative context. In user mode this method will
always return E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_save_ppr_no_detailing_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetSavePPRNoDetailingLock(boolean iLocked)

Locks or unlocks the SavePPRNoDetailing parameter.
Role:Locks or unlocks the SavePPRNoDetailing parameter if it is possible in
the current administrative context. In user mode this method will always return
E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_save_relation_to_un_exposed_part_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetSaveRelationToUnExposedPartLock(boolean iLocked)

Locks or unlocks the SaveRelationToUnExposedPart
parameter.
Role:Locks or unlocks the SaveRelationToUnExposedPart parameter if it is
possible in the current administrative context. In user mode this method will
always return E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_save_show_effctvt_panel_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetSaveShowEffctvtPanelLock(boolean iLocked)

Locks or unlocks the SaveShowEffctvtPanel parameter.
Role:Locks or unlocks the SaveShowEffctvtPanel parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_save_v5_calc_time_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetSaveV5CalcTimeLock(boolean iLocked)

Locks or unlocks the SaveV5CalcTime parameter.
Role:Locks or unlocks the SaveV5CalcTime parameter if it is possible in the
current administrative context. In user mode this method will always return
E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_show_only_filtered_objects_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetShowOnlyFilteredObjectsLock(boolean iLocked)

Locks or unlocks the ShowOnlyFilteredObjects parameter.
Role:Locks or unlocks the ShowOnlyFilteredObjects parameter if it is
possible in the current administrative context. In user mode this method will
always return E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

property show_only_filtered_objects: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property ShowOnlyFilteredObjects() As boolean

Retrieves (or sets, if not initialized) the ShowOnlyFilteredObjects
attribute.

A TRUE value indicates that the Only Filtered objects will be shown in
Search Results
Return type:

bool