daqhelp (Data Acquisition Toolbox)

Data Acquisition Toolbox

Search Help Desk

daqhelp

Examples See Also

Display help for device objects, constructors, functions, and properties.

Syntax

daqhelp

daqhelp('name')

daqhelp(obj)

daqhelp(obj, 'name')

Description

daqhelp displays a complete listing of Data Acquisition Toolbox functions with a brief description of each function.

daqhelp('name') displays device object, constructor, adaptor, function, or property help.

If name is the name of a device object constructor, a complete listing of the device object's functions and properties is displayed along with a brief description of each function and property. The command-line help for the device object's constructor is also displayed. In this case, name is not specified as a string. If name is the name of a device object constructor, and the ".m" extension is included, the command-line constructor help is displayed. If name is the name of an adaptor, the command-line adaptor help is displayed. If name is the name of a function or property, the command-line function or property help is displayed.

Object-specific function information can be displayed by specifying name as object/function. For example to display the command-line help for an analog input object's getdata function, name would be analoginput/getdata.

Object-specific property information can be displayed by specifying name as obj.property. For example to display the command-line help for an analog input object's SampleRate property, name would be analoginput.SampleRate.

daqhelp(obj) displays a complete listing of functions and properties for obj, along with the command-line help for the obj's constructor.

daqhelp(obj, 'name') displays the help for name for the specified device object. name can be a property or function name.

Examples

The commands listed below are some of the ways daqhelp can be used to obtain information about device objects, constructors, adaptors, functions, and properties.

daqhelp('analogoutput')
daqhelp('analogoutput.m')
daqhelp('winsound')
daqhelp set
daqhelp analoginput/peekdata
daqhelp analoginput.TriggerDelayUnits

The commands listed below are some of the ways daqhelp can be used to obtain information about functions and properties for a given device object.

ai = analoginput('winsound');
daqhelp(ai, 'TriggerTime');
daqhelp(ai, 'getsample');
daqhelp(ai, 'set');