[Microsoft代理程式從 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中有內容編號,Agent 會呼叫說明並搜尋目前內容編號所識別的主題。 目前的內容編號是字元 HelpContextID 的值。
IAgentCharacterEx::GetHelpContextID 會傳回您為字元設定的 HelpContextID。 它不會傳回其他客戶端所設定 HelpContextID。
注意
建置說明檔需要Microsoft Windows 說明編譯程式。
另請參閱
IAgentCharacterEx::SetHelpContextID、IAgentCharacterEx::SetHelpModeOn、IAgentCharacterEx::SetHelpFileName