Справка по типу, функции или свойству объекта прибора
instrhelp
instrhelp('name')
out = instrhelp('name')
instrhelp(obj)
instrhelp(obj,'name')
out = instrhelp(obj,'name')
| Имя функции, имя свойства или тип объекта инструмента. |
| Объект инструмента. |
| Текст справки. |
instrhelp возвращает полный список функций тулбокса с кратким описанием каждой функции.
instrhelp(' возвращает справку по функции, свойству или типу объекта инструмента, заданному в name')name.
Можно вернуть информацию о конкретном объекте инструмента путем определения name в форме object/function или object.property. Например, чтобы вернуть справку для объекта последовательного порта fprintf функция, name будет serial/fprintf. Возврат справки по Parity объекта последовательного порта свойство, name будет serial.parity.
out = instrhelp(' возвращает текст справки в name')out.
instrhelp(obj) возвращает полный список функций и свойств для obj, с кратким описанием каждого. Также возвращается справка для конструктора.
instrhelp(obj,' возвращает справку по функции или свойству, заданному name')name связана с obj.
out = instrhelp(obj,' возвращает текст справки в name')out.
Следующие команды иллюстрируют некоторые способы получения справки по функции и свойствам без создания объекта инструмента:
instrhelp gpibout = instrhelp('gpib.m');instrhelp setinstrhelp EOSCharCodeinstrhelp('gpib.eoscharcode')Следующие команды иллюстрируют некоторые способы получения справки по функции и свойствам для существующего объекта инструмента:
g = gpib('ni',0,1);instrhelp(g)
instrhelp(g,'EOSMode');out = instrhelp(g,'trigger')При возвращении справки по свойствам имена в разделе «См. также», которые содержат все заглавные буквы, являются именами функции. Имена, которые содержат смесь верхних и нижних букв, являются именами свойства. При возвращении справки по функции раздел «См. также» содержит только имена функции.
Можно также отобразить справку в браузере Рабочей области, щелкнув правой кнопкой мыши объект инструмента и выбрав Instrument Help из контекстного меню.