IAgentCommandEx::GetHelpContextID

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

HRESULT GetHelpContextID(
   long * pulID  //  address of command's help topic ID
);

ИзвлекаетhelpContextIDдля объектаcommand.

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

pulID

Адрес переменной, которая получает номер контекста раздела справки, связанного с объектомкоманды.

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

Заметка

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

 

См. также

IAgentCommandEx::SetHelpContextID, IAgentCharacterEx::SetHelpModeOn, IAgentCharacterEx::SetHelpFileName