exponenta event banner

instrhelp

Справка по типу объекта инструмента, функции или свойству

Синтаксис

instrhelp
instrhelp('name')
out = instrhelp('name')
instrhelp(obj)
instrhelp(obj,'name')
out = instrhelp(obj,'name')

Аргументы

'name'

Имя функции, имя свойства или тип объекта инструмента.

obj

Объект прибора.

out

Текст справки.

Описание

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 gpib
out = instrhelp('gpib.m');
instrhelp set
instrhelp EOSCharCode
instrhelp('gpib.eoscharcode')

Следующие команды иллюстрируют некоторые способы получения справки по функциям и свойствам для существующего объекта инструмента.

g = gpib('ni',0,1);
instrhelp(g)
instrhelp(g,'EOSMode');
out = instrhelp(g,'trigger')

Совет

При возврате справки по свойствам имена в разделе «См. также», содержащие все прописные буквы, являются именами функций. Имена, содержащие сочетание прописных и строчных букв, являются именами свойств. При возврате справки по функциям раздел См. также содержит только имена функций.

Можно также отобразить справку в браузере рабочей области, щелкнув правой кнопкой мыши объект инструмента и выбрав в контекстном меню команду Справка по приборам.

См. также

Представлен до R2006a