pycatia.behavior_interfaces.behavior_vb_script

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.behavior_interfaces.behavior_vb_script.BehaviorVBScript(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
CATBehaviorInterfaces.Behavior
BehaviorVBScript

Represents the VBScript behavior.
Role: The VB script behavior is designed to run a VBScript (or catvbs files) or
to reference a VBA project. This interface derives from Behavior and enables
the manipulation of the internal variables of the VBScript
behavior.
cancel() → None

Note

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

Inform Client VB has Failed & Has Not operated.

Example:

Deprecated:
V5R15 (Not needed)
Return type:

None

done() → None

Note

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

Inform Client VB has Successfully Finished.

Example:

Deprecated:
V5R15 (Not needed)
Return type:

None

get_internal(p_name: str) → AnyObject

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetInternal(CATBSTR pName) As AnyObject

Returns one available io of the behavior. The behavior has to be in
executing mode, otherwise it fails

Example:
This example retrieves in BehParameter the internal parameter
CATIAReference XXX currently managed by a Behavior
Beh.

Dim BehParameter as Parameter
Set BehParameter = Beh.GetInternal(“XXX”)
Parameters:

p_name (str) –

Return type:

AnyObject

put_internal(p_name: str, o_value: AnyObject) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub PutInternal(CATBSTR pName,
AnyObject oValue)

provide output of one available io of the behavior. The behavior has to be
in executing mode, otherwise it fails

Example:
This example assign the BehParameter containing a CATIAReference to the
internal parameter XXX currently managed by a Behavior
Beh.

Dim BehPower as Parameter
Beh.PutInternal “XXX”, BehParameter
Parameters:
Return type:

None

start() → None

Note

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

Inform Client VB has Started.

Example:

Deprecated:
V5R15 (Not needed)
Return type:

None

suspend() → None

Note

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

Inform Client VB has not completly finished the task and has to be called
later on

Example:

Deprecated:
V5R15 (Not needed)
Return type:

None

test_internal(p_name: str) → int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func TestInternal(CATBSTR pName) As long

Test for one available output of the behavior. The behavior has to be in
executing mode, otherwise it fails

Example:
This example test for the value existance of an internal parameter XXX
that may contain or not a CATIAReference currently managed by a Behavior
Beh.

if (Beh.TestInternal(“XXX”))
Parameters:

p_name (str) –

Return type:

int