Getting Started with the Data Acquisition Toolbox (Data Acquisition Toolbox)

Data Acquisition Toolbox

The propinfo function

propinfo returns information about properties. The information is returned as a structure containing the fields shown below.


Field	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 an enumerated list)
`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 the device object is 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.

This information can be used to evaluate the allowed value(s) for a given property or to programmatically configure property values. For example, to display all the propinfo field values for the SampleRate property, type

info = propinfo(ai);
info.SampleRate
ans = 
               Type: 'double'
         Constraint: 'Bounded'
    ConstraintValue: [8000 44100]
       DefaultValue: 8000
           ReadOnly: 0
    ReadOnlyRunning: 1
     DeviceSpecific: 0

For more information about propinfo, refer to Chapter 6, "Function Reference."

[ Previous | Help Desk | Next ]