IAgentCharacterEx::GetHelpContextID

[Der Microsoft-Agent ist ab Windows 7 veraltet und kann in nachfolgenden Versionen von Windows nicht verfügbar sein.]

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

Ruft die HelpContextID- für das Zeichen ab.

• Gibt S_OK zurück, um anzugeben, dass der Vorgang erfolgreich war.

pulHelpID-

Adresse einer Variablen, die die Kontextnummer des Hilfethemas für das Zeichen empfängt.

Wenn Sie eine Windows-Hilfedatei für Ihre Anwendung erstellt und die HelpFile- Eigenschaft des Zeichens festgelegt haben, ruft Der Microsoft-Agent automatisch Hilfe auf, wenn HelpModeOn- auf True festgelegt ist und der Benutzer das Zeichen auswählt. Wenn in der HelpContextIDeine Kontextnummer vorhanden ist, ruft Agent Hilfe auf und sucht nach dem Thema, das durch die aktuelle Kontextnummer identifiziert wird. Die aktuelle Kontextnummer ist der Wert HelpContextID- für das Zeichen.

IAgentCharacterEx::GetHelpContextID gibt die HelpContextID- zurück, die Sie für das Zeichen festgelegt haben. Die HelpContextID- von anderen Clients wird nicht zurückgegeben.

Siehe auch

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