Data Acquisition Toolbox

daqhelp

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

Syntax

• daqhelp
  out = daqhelp('name')
  out = daqhelp(obj)
  out = daqhelp(obj,'name')
  

Arguments

'name'	A device object, constructor, adaptor, function, or property name.
obj	A device object.
out	Contains the specified help text.

Description

daqhelp displays a complete listing of Data Acquisition Toolbox constructors and functions along with a brief description of each.

out = daqhelp('name') returns help for the device object, constructor, adaptor, function, or property specified by name. The help text is returned to out.

out = daqhelp(obj) returns a complete listing of functions and properties for the device object obj to out. Help for obj's constructor is also displayed.

out = daqhelp(obj,'name') returns help for name for the specified device object obj to out. name can be a constructor, adaptor, property, or function name.

Remarks

As shown below, you can also display help via the Workspace browser by right-clicking a device object, and selecting Explore -> DAQ Help from the context menu.

More About Displaying Help

• When displaying property help, the names in the See Also section that contain all uppercase letters are function names. The names that contain a mixture of upper- and lowercase letters are property names.
• When displaying function help, the See Also section contains only function names.

Rules for Specifying Names

For the daqhelp('name') syntax:

• If name is the name of a 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 constructor help is also displayed.
• You can display object-specific function information by specifying name as object/function. For example, to display the help for an analog input object's getdata function, name is analoginput/getdata.
• You can display object-specific property information by specifying name as obj.property. For example, to display the help for an analog input object's SampleRate property, name is analoginput.SampleRate.

For the daqhelp(obj,'name') syntax:

• If name is the name of a device object constructor and the .m extension is included, the constructor help is displayed.
• If name is the name of a function or property, the function or property help is displayed.

Example

The following commands are some of the ways you can use daqhelp to obtain help on device objects, constructors, adaptors, functions, and properties.

• daqhelp('analogoutput');
  out = daqhelp('analogoutput.m');
  daqhelp set
  daqhelp analoginput/peekdata
  daqhelp analoginput.TriggerDelayUnits
  

The following commands are some of the ways you can use daqhelp to obtain information about functions and properties for an existing device object.

• ai = analoginput('winsound');
  daqhelp(ai,'InitialTriggerTime')
  out = daqhelp(ai,'getsample');
  

See Also

Functions

propinfo

daqfind

daqhwinfo