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

IAgentCharacterEx::GetHelpContextID

  • Статья

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

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

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

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

pulHelpID

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

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

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

Заметка

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

 

См. также

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