instrhelp

Помогите для инструментального типа объекта, функции или свойства

Синтаксис

instrhelp
instrhelp('name')
out = instrhelp('name')
instrhelp(obj)
instrhelp(obj,'name')
out = instrhelp(obj,'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('gpib/set')
instrhelp EOSCharCode
instrhelp('gpib.eoscharcode')

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

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

Советы

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

Можно также отобразить справку через браузер Рабочей области путем щелчка правой кнопкой по инструментальному объекту и выбора Instrument Help из контекстного меню.

Смотрите также

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

Для просмотра документации необходимо авторизоваться на сайте