External Interfaces/API

Serial Port Object Properties

The serial port object properties are briefly described below, and organized into categories based on how they are used. Following this section, the properties are listed alphabetically and described in detail.

Communications Properties
BaudRate	Specify the rate at which bits are transmitted
DataBits	Specify the number of data bits to transmit
Parity	Specify the type of parity checking
StopBits	Specify the number of bits used to indicate the end of a byte
Terminator	Specify the terminator character

Write Properties
BytesToOutput	Indicate the number of bytes currently in the output buffer
OutputBufferSize	Specify the size of the output buffer in bytes
Timeout	Specify the waiting time to complete a read or write operation
TransferStatus	Indicate if an asynchronous read or write operation is in progress
ValuesSent	Indicate the total number of values written to the device

Read Properties
BytesAvailable	Indicate the number of bytes available in the input buffer
InputBufferSize	Specify the size of the input buffer in bytes
ReadAsyncMode	Specify whether an asynchronous read operation is continuous or manual
Timeout	Specify the waiting time to complete a read or write operation
TransferStatus	Indicate if an asynchronous read or write operation is in progress
ValuesReceived	Indicate the total number of values read from the device

Callback Properties
BreakInterrupt Fcn	Specify the M-file callback function to execute when a break-interrupt event occurs
BytesAvailable Fcn	Specify the M-file callback function to execute when a specified number of bytes is available in the input buffer, or a terminator is read
BytesAvailable FcnCount	Specify the number of bytes that must be available in the input buffer to generate a bytes-available event
BytesAvailable FcnMode	Specify if the bytes-available event is generated after a specified number of bytes is available in the input buffer, or after a terminator is read
ErrorFcn	Specify the M-file callback function to execute when an error event occurs
OutputEmptyFcn	Specify the M-file callback function to execute when the output buffer is empty
PinStatusFcn	Specify the M-file callback function to execute when the CD, CTS, DSR, or RI pins change state
TimerFcn	Specify the M-file callback function to execute when a predefined period of time passes
TimerPeriod	Specify the period of time between timer events

Control Pin Properties
DataTerminal Ready	Specify the state of the DTR pin
FlowControl	Specify the data flow control method to use
PinStatus	Indicate the state of the CD, CTS, DSR, and RI pins
RequestToSend	Specify the state of the RTS pin

Recording Properties
RecordDetail	Specify the amount of information saved to a record file
RecordMode	Specify whether data and event information are saved to one record file or to multiple record files
RecordName	Specify the name of the record file
RecordStatus	Indicate if data and event information are saved to a record file

General Purpose Properties
ByteOrder	Specify the order in which the device stores bytes
Name	Specify a descriptive name for the serial port object
Port	Indicate the platform-specific serial port name
Status	Indicate if the serial port object is connected to the device
Tag	Specify a label to associate with a serial port object
Type	Indicate the object type
UserData	Specify data that you want to associate with a serial port object

The Property Reference Page Format

BaudRate