pycatia.in_interfaces.file

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.file.File(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
InfInterfaces.FileComponent
File

Represents the file object.
Role: The file object allows to manipulate files with UNIX and Windows. Use it
instead of the one of Visual Basic to make portable macros. Its gives access to
information about the file and can open a file as a TextStream
object.
open_as_text_stream(i_mode: str) → TextStream

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func OpenAsTextStream(CATBSTR iMode) As TextStream

Opens the file and retrieves it as a TextSteam object. Paramater iMode can
have the value “ForReading”, “ForWriting” or
“ForAppending”.

Example:
This example opens the file TestFile for reading and retrieves in the
text stream TextStr.

Dim TextStr As CATIATextSteam
Set TextStr = TestFile.OpenAsTextStream(“ForReading”)
Parameters:

i_mode (str) –

Return type:

TextStream

property size: int

Note

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

Returns the size of the file.

Example:
This example retrieves in FileSize the size of the File
TestFile.

Dim FileSize As Long
FileSize = TestFile.Size
Return type:

int

property type: str

Note

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

Returns the type of the file. For instance, if the file has a .txt or .doc
extension, its type will be “Text Document”.

Example:
This example retrieves in FileType the type of the File
TestFile.

Dim FileType As String
FileSize = TestFile.Size
Return type:

str