Help for instrument object type, function, or property
instrhelp
instrhelp('name')
out = instrhelp('name')
instrhelp(obj)
instrhelp(obj,'name')
out = instrhelp(obj,'name')
| A function name, property name, or instrument object type. |
| An instrument object. |
| The help text. |
instrhelp returns a complete listing of
toolbox functions, with a brief description of each.
instrhelp('
returns help for the function, property, or instrument object type specified by
name')name.
You can return specific instrument object information by specifying
name in the form object/function
or object.property. For example, to return the help for a serial
port object's fprintf function,
name would be serial/fprintf. To
return the help for a serial port object's Parity property,
name would be
serial.parity.
out = instrhelp('
returns the help text to name')out.
instrhelp(obj) returns a complete listing
of functions and properties for obj, with a brief description of
each. Help for the constructor is also returned.
instrhelp(obj,'
returns help for the function or property specified by
name')name associated with obj.
out = instrhelp(obj,'
returns the help text to name')out.
The following commands illustrate some of the ways you can get function and property help without creating an instrument object:
instrhelp gpibout = instrhelp('gpib.m');instrhelp setinstrhelp EOSCharCodeinstrhelp('gpib.eoscharcode')The following commands illustrate some of the ways you can get function and property help for an existing instrument object:
g = gpib('ni',0,1);instrhelp(g)
instrhelp(g,'EOSMode');out = instrhelp(g,'trigger')When returning 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 returning function help, the See Also section contains only function names.
You can also display help via the Workspace browser by right-clicking an instrument object, and selecting Instrument Help from the context menu.