IAgentCommandsEx::SetHelpContextID

[Microsoft Agent не рекомендуется использовать в Windows 7 и может быть недоступно в последующих версиях Windows.]

HRESULT SetHelpContextID(
   long ulHelpID  // ID for help topic
);

ЗадаетHelpContextID для объектаcommand.

• Возвращает S_OK, чтобы указать, что операция выполнена успешно.

ulHelpID

Номер контекста раздела справки, связанного с объектомкоманды; используется для предоставления контекстно-конфиденциальной справки для команды.

Если вы создали файл справки Windows для приложения и задайте его в свойствеHelpFile символа. Агент автоматически вызывает справку, если HelpModeOn задано значение True, а пользователь выбирает команду. Если в helpContextIDесть номер контекста, агент вызывает справку и ищет раздел, определенный текущим номером контекста. Текущий номер контекста — это значение helpContextID для команды. Если в свойстве HelpContextID выбранной команды есть номер контекста, справка отображает раздел, соответствующий текущему контексту справки; в противном случае отображается сообщение "Нет раздела справки, связанного с этим элементом".

Это свойство применяется только к использованию символа клиентского приложения; Параметр не влияет на другие клиенты символов или других символов клиентского приложения.

Заметка

Для создания файла справки требуется компилятор справки Microsoft Windows.

 

См. также

IAgentCommandsEx::GetHelpContextID, IAgentCharacterEx::SetHelpModeOn, IAgentCharacterEx::SetHelpFileName