Image Acquisition Toolbox

imaqhelp

Return image acquisition object function and property help

Syntax

• imaqhelp
  imaqhelp('name')
  imaqhelp(obj)
  imaqhelp(obj,'name')
  out = imaqhelp(...)
  

Description

imaqhelp provides a complete listing of image acquisition object functions.

imaqhelp('name') provides online help for the function or property name.

imaqhelp(obj) displays a listing of functions and properties for the image acquisition object obj along with the online help for the object's constructor. obj must be a 1-by-1 image acquisition object.

imaqhelp(obj,'name') displays the help for function or property name for the image acquisition object obj.

If name is a device-specific property name, obj must be provided.

out = imaqhelp(...) returns the help text in string out.

When property help is displayed, 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 function help is displayed, the "See also" section contains only function names.

Example

Getting general function and property help.

• imaqhelp('videoinput')
  out = imaqhelp('videoinput.m');
  imaqhelp set
  imaqhelp LoggingMode
  

Getting property help with device-specific information.

• vid = videoinput('dt', 1);
  src = getselectedsource(vid);
  imaqhelp(vid, 'TriggerType')
  imaqhelp(src, 'FrameRate')
  

See Also

propinfo

imaqfind

imaqhwinfo