External Interfaces/API

The Property Reference Page Format

Each serial port property description contains some or all of this information:

• The property name
• A description of the property
• The property characteristics, including:
• Read only - the condition under which the property is read only

A property can be read only always, never, while the serial port object is open, or while the serial port object is recording. You can configure a property value using the set function or dot notation. You can return the current property value using the get function or dot notation.

• Data type - the property data type

This is the data type you use when specifying a property value.

• Valid property values including the default value

When property values are given by a predefined list, the default value is usually indicated by {}.

• An example using the property
• Related properties and functions

Property Reference

Serial Port Object Properties