共用方式為


IAgentCharacterEx::SetHelpContextID

[Microsoft代理程式從 Windows 7 開始已被取代,而且可能無法在後續版本的 Windows 中使用。]

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

設定字元 HelpContextID

  • 傳回S_OK,表示作業成功。

ulHelpID

與字元相關聯之說明主題的內容編號;用來提供字元的內容相關說明。

如果您已為應用程式建立 Windows 說明檔,並在字元的 HelpFile 屬性中設定此檔案,Microsoft Agent 會在 HelpModeOn 設定為 True,且用戶選取字元時會自動呼叫說明。 如果 HelpContextID中有內容編號,Agent 會呼叫說明並搜尋目前內容編號所識別的主題。 目前的內容編號是字元 HelpContextID 的值。 如果 HelpContextID 屬性中有內容編號,說明會顯示對應至目前說明內容的主題;否則會顯示「沒有與此專案相關聯的說明主題」。

只有當用戶端應用程式是最上層字元的作用中用戶端時,才會套用此設定。 它不會影響您用戶端應用程式所使用的字元或其他字元的其他用戶端。

注意

建置說明檔需要Microsoft Windows 說明編譯程式。

 

另請參閱

IAgentCharacterEx::GetHelpContextIDIAgentCharacterEx::SetHelpModeOnIAgentCharacterEx::SetHelpFileName