Main Content

imaqhelp

Display help information for image acquisition object functions and properties

    Description

    imaqhelp displays a list of all image acquisition object functions.

    imaqhelp(name) displays help text for the function or property specified by name.

    example

    imaqhelp(obj) displays a list of functions and properties and the help information for the object construct of the image acquisition object obj.

    example

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

    Use this syntax if name is a device-specific property name.

    example

    out = imaqhelp(___) returns the help text in the character vector out.

    Note

    • When you display help information for properties, the See Also section contains functions and properties. Names in all uppercase are functions and lowercase letters are properties.

    • When you display help information for functions, the See Also section contains only function names.

    Examples

    collapse all

    imaqhelp('videoinput')
    out = imaqhelp('videoinput');
    imaqhelp getsnapshot
    imaqhelp LoggingMode
    vid = videoinput('dt',1);
    src = getselectedsource(vid);
    imaqhelp(vid,'TriggerType')
    imaqhelp(src,'FrameRate')

    Input Arguments

    collapse all

    Name of function or property, specified as a string or character vector.

    Data Types: char | string

    Image acquisition object, specified as a 1-by-1 image acquisition object. For more information, see Creating Image Acquisition Objects.

    Version History

    Introduced in R2006a