共用方式為


IAgentCommandsEx::SetHelpContextID

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

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

設定 Command 物件的 HelpContextID

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

ulHelpID

Command 對象相關聯的幫助主題內容編號;用來提供命令的內容相關說明。

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

此屬性僅適用於用戶端應用程式使用 字元;這個設定不會影響用戶端應用程式字元或其他字元的其他用戶端。

注意

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

 

另請參閱

IAgentCommandsEx::GetHelpContextIDIAgentCharacterEx::SetHelpModeOnIAgentCharacterEx::SetHelpFileName