Documentation

This is machine translation

Translated by Microsoft
Mouseover text to see original. Click the button below to return to the English verison of the page.

Note: This page has been translated by MathWorks. Please click here
To view all translated materals including this page, select Japan from the country navigator on the bottom of this page.

get (serial)

Serial port object properties

Syntax

get(obj)
out = get(obj)
out = get(obj,'PropertyName')

Description

get(obj) returns all property names and their current values to the command line for the serial port object, obj.

out = get(obj) returns the structure out where each field name is the name of a property of obj, and each field contains the value of that property.

out = get(obj,'PropertyName') returns the value out of the property specified by PropertyName for obj. If PropertyName is replaced by a 1-by-n or n-by-1 cell array of strings containing property names, then get returns a 1-by-n cell array of values to out. If obj is an array of serial port objects, then out will be a m-by-n cell array of property values where m is equal to the length of obj and n is equal to the number of properties specified.

Examples

This example illustrates some of the ways you can use get to return property values for the serial port object s on a Windows® platform.

s = serial('COM1');
out1 = get(s);
out2 = get(s,{'BaudRate','DataBits'});
s.Parity
ans =
none

More About

collapse all

Tips

Refer to Displaying Property Names and Property Values for a list of serial port object properties that you can return with get.

When you specify a property name, you can do so without regard to case. For example, if s is a serial port object, then these commands are equivalent.

out = s.BaudRate;
out = s.baudrate;

See Also

Introduced before R2006a

Was this topic helpful?