Port

Quick Facts


# Boilerplate Example
port = ...  # obtained from the runtime context
result = port.GetName()

Method	Returns	Summary
`GetName`	`str`	Get the internal port name.
`GetComment`	`str`	Get the human readable port comment.
`GetValueType`	`int`	Get the value type of the resource.
`GetPortDirection`	`int`	Get the direction of the port.


def GetName() -> str

Get the internal port name.

Returns: str — The port name.


def GetComment() -> str

Get the human readable port comment. This is the externally visible name that can be seen and customized by the user.

Returns: str — The comment of the port.


def GetValueType() -> int

Get the value type of the resource.

Returns: int — The value type of the port as unsigned integer.


def GetPortDirection() -> int

Get the direction of the port.

Returns: int — The direction of the port as unsigned integer.

This class is documented as of release R2025.2.4.

Was this page helpful?