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

IAgentCharacterEx::GetHelpFileName

  • Статья

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

HRESULT GetHelpFileName(
   BSTR * pbszName  // address of Help filename
);

Извлекает helpFileName для символа.

  • Возвращает S_OK для указания успешной операции.

pbszName

Адрес переменной, которая получает имя файла справки для символа.

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

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

Примечание

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

 

См. также:

IAgentCommandsEx::SetHelpContextID, IAgentCharacterEx::SetHelpModeOn, IAgentCharacterEx::SetHelpFileName