Home
Reference Guides
Explore the Extended Definitions, OML Guides, Block Library, API Guide and Glossary.
Function Guide for Twin Activate
Provides information about developing and simulating models through the Twin Activate Application Program Interface.
Block Diagram Editor APIs
Learn about the APIs available for manipulating blocks through the Block Diagram Editor.
Ports
bdeGetPortLabel
Returns the label of a given port.

Welcome
What's New
Discover new features and enhancements.
Get Started
New to Twin Activate? Learn the basics here.
Tutorials
Start using Twin Activate with our interactive tutorials.
User Guide
Learn about the features and functionality available in Twin Activate.
Reference Guides
Explore the Extended Definitions, OML Guides, Block Library, API Guide and Glossary.
- Extended Definitions for Advanced Users
  PDF file with in-depth information on key topics in the User's Guide.
- Scripting Guide for OpenMatrix Language
  OpenMatrix is a mathematical scripting language.
- Reference Guide for OpenMatrix Language Functions
  The Reference Guide contains documentation for all functions supported in the OpenMatrix language.
- Block Reference Guide
  Describes all of the blocks in the installed Twin Activate library.
- Function Guide for Twin Activate
  Provides information about developing and simulating models through the Twin Activate Application Program Interface.
  - Block Diagram Editor APIs
    Learn about the APIs available for manipulating blocks through the Block Diagram Editor.
    - Annotations
    - Block Manipulation
    - Block Parameters
    - Dialog
    - Selector Dialog
    - Diagram
    - Editor
    - Links
    - Models
    - Ports
      - bdeCreatePort
        Creates a new port for a given block.
      - bdeGetPortBackgroundColor
        Returns the background color of a given port.
      - bdeGetPortFrameColor
        Returns the frame color of a given port.
      - bdeGetPortHeight
        Returns the height of a given port.
      - bdeGetPortIOType
        Returns the input/output type of a given port.
      - bdeGetPortLabel
        Returns the label of a given port.
      - bdeGetPortNumber
        Returns the number of a given port.
      - bdeGetPortPosition
        Returns the position of a given port.
      - bdeGetPortShape
        Returns the shape of a given port.
      - bdeGetPortsOnBlock
        Returns a list of the ports on a given block.
      - bdeGetPortType
        Returns the type of a given port.
      - bdeGetPortWidth
        Returns the width of a given port.
      - bdeGetPortXPosition
        Returns the x position of a given port.
      - bdeGetPortYPosition
        Returns the y position of a given port.
      - bdeIsPortLabelVisible
        Returns a value showing whether the port label is visible or not.
      - bdeIsValidPortVariableType
        Returns a value that shows whether or not a portType is a valid port variable type.
      - bdeSetPortBackgroundColor
        Sets the background color of a port.
      - bdeSetPortFrameColor
        Sets the frame color of a port.
      - bdeSetPortIOType
        Sets the input output type of a port. Only works for newly created blocks.
      - bdeSetPortLabel
        Sets the label of a port label.
      - bdeSetPortLabelVisibility
        Sets the visibility of a port label.
      - bdeSetPortNumber
        Sets the shape of a port. Only works for newly created blocks.
      - bdeSetPortPosition
        Sets the position of a port label. For position there are three options that can be used: hwdc::Position, a string of which side to place the port and using doubles for the x and y position.
      - bdeSetPortShape
        Sets the shape of a port.
      - bdeSetPortSize
        Sets the width and height of a port.
      - bdeSetPortType
        Sets the type of a port. Only works for newly created block.
    - Simulation Settings
  - Utility APIs
    Learn about the APIs available for obtaining information from Activate models, for example information about variables and environments.
  - Simulation APIs
    Learn about the APIs available for simulating models.
- Glossary
  Key terms associated with the software.
Frequently Asked Questions
You've got questions? We've got answers!

bdeGetPortLabel

Returns the label of a given port.

Syntax

label = bdeGetPortLabel(port)

Inputs

port: The port to get the label of.; Type: hwdcConnectionPoint

Outputs

label: The label of the port.; Type: string

Examples

Get the label of a given port:


          diagram = bdeGetCurrentDiagram();
          block = bdeGetSelectedBlock(diagram);
          portList = bdeGetPortsOnBlock(block);
          portX = portList{[1, 1]};
          label = bdeGetPortLabel(portX);


          
            label = x1