IAgentCommandEx::SetHelpContextID

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

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

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

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

ulID

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

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

Заметка

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

 

См. также

IAgentCommandEx::GetHelpContextID, IAgentCharacterEx::SetHelpModeOn, IAgentCharacterEx::SetHelpFileName