smartinspectpython.sipipehandle

Module: sipipehandle.py

Revision History

Date Version Description
2023/05/30 3.0.0.0 Initial Version.

@export
class SIPipeHandle:

Used to open a named-pipe connection.

Threadsafety:

The public members of this class are thread-safe.

SIPipeHandle(pipeName: str = None)

Initializes a new instance of the class with the specified named pipe.

Arguments:
  • pipeName (str): The named pipe to open.
IsInvalid: int

Gets the IsInvalid property value.

HResult: int

Gets the HResult property value.

Handle: object

Gets the named pipe file Handle.

@staticmethod
def OpenPipe(pipeName: str = None) -> object:

Calls win32api to create a named pipe file.

Arguments:
  • pipeName (str): The named pipe to open.
Raises:
  • Exception: Thrown if an exception occurs for any reason (pipe not found, broken pipe, etc).
Returns:

A win32api file handle to the named pipe.