propinfo (Data Acquisition Toolbox)

Data Acquisition Toolbox

Search Help Desk

propinfo

Examples See Also

Return property information for device objects, channels, or lines.

Syntax

info = propinfo(obj);

info = propinfo(obj, 'Property');

Description

info = propinfo(obj) returns information for all device object properties to info. The information is returned as a structure containing the fields shown below.


Property	Description
`Type`	The property data type (e.g., double, string)
`Constraint`	Constraints on property values (e.g., `None`, `Bounded`)
`ConstraintValue`	Property value constraint (e.g., range of valid values, elements of a list of valid values)
`DefaultValue`	The property default value
`ReadOnly`	If a property is read-only, a "1" is returned. Otherwise a "0" is returned.
`ReadOnlyRunning`	If a property cannot be set while running, a "1" is returned. Otherwise a "0" is returned.
`DeviceSpecific`	If the property is device-specific, then a "1" is returned. Otherwise a "0" is returned.

info = propinfo(obj, 'Property') returns information for the specified property to info.

Example

Sound Cards

Suppose you create the analog input object ai for a sound card and configure it to operate in stereo mode.

ai = analoginput('winsound')
addchannel(ai, 1:2);

The following command displays the default value for the SampleRate property.

info1 = propinfo(ai);
info1.SampleRate.DefaultValue

The following command displays all the propinfo information for the InputRange property.

info2 = propinfo(ai.Channel);
info2.InputRange