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

IAgentCharacterEx::SetHelpContextID

  • Статья

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

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

Задает идентификатор HelpContextID для символа.

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

ulHelpID

Номер контекста раздела справки для связанного с символом; используется для предоставления контекстно-чувствительной справки для символа.

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

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

Примечание

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

 

См. также:

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