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

IAgentCharacterEx::GetHelpContextID

  • Статья

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

HRESULT GetHelpContextID(
   long * pulHelpID  // address of character's help topic ID
);

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

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

pulHelpID

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

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

IAgentCharacterEx::GetHelpContextID возвращает идентификатор HelpContextID , заданный для символа. Он не возвращает идентификатор HelpContextID , заданный другими клиентами.

Примечание

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

 

См. также:

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