Поделиться через

IAgentCommandEx::GetHelpContextID

  • Статья

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

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

Извлекает идентификатор HelpContextID для объекта Command .

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

pulID

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

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

Примечание

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

 

См. также:

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