pycatia.in_interfaces.system_configuration

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

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.in_interfaces.system_configuration.SystemConfiguration(com_object)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.AnyObject
SystemConfiguration

Provides abstractions to resources which depend on the platform or the current
configuration.
get_product_names() → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub GetProductNames(CATSafeArrayVariant ioProductNames)

Returns the product names of all the licenses currently known to the
system.

Parameters:

CATSafeArrayVariant
An properly dimensioned array of strings in which the product names
will be stored.

Example:
This example determines if the first product in the list of
known product names is authorized.

Dim SystemConfiguration1 As SystemConfiguration
Set SystemConfiguration1 = CATIA.SystemConfiguration
ReDim NameArray(SystemConfiguration1.ProductNamesCount)
SystemConfiguration1.GetProductNames NameArray
MsgBox “IsProductAuthorized for product “ & NameArray(0) & “
returns “ & SystemConfiguration1.IsProductAuthorized(NameArray(0))
Parameters:

io_product_names (tuple) –

Return type:

None

is_product_authorized(i_product_name: str) → bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func IsProductAuthorized(CATBSTR iProductName) As boolean

Returns True if the specified product is authorized, False
otherwise.

Parameters:

iProductName
The name of the product to check.
oAuthorized
A boolean which specifies if the product is
authorized.
Parameters:

i_product_name (str) –

Return type:

bool

property operating_system: str

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property OperatingSystem() As CATBSTR (Read Only)

Returns a string which identifies the operating system on which the
application is currently running. Examples of identifiers include: intel_a,
solaris_a, aix_a, win_a and hpux_a.

Parameters:

oOperatingSystem
The operating system identifier.
Return type:

str

property product_count: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property ProductCount() As long (Read Only)

Returns the number of product names names currently known to the
system.

Parameters:

oProductCount
The number of product names currently known to the
system.
Return type:

int

property release: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property Release() As long (Read Only)

Returns the CATIA release number.

Parameters:

oVersion
The CATIA release number.
Return type:

int

property service_pack: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property ServicePack() As long (Read Only)

Returns the CATIA service pack number.

Parameters:

oServicePack
The CATIA service pack number.
Return type:

int

property version: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property Version() As long (Read Only)

Returns the CATIA version number (usually version 5).

Parameters:

oVersion
The CATIA version.
Return type:

int