IAgentCharacterEx::GetHelpContextID

[Microsoft Agent ist ab Version Windows 7 veraltet und in nachfolgenden Versionen von Windows.]

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 Microsoft Agent automatisch Help auf, wenn HelpModeOn auf True festgelegt ist und der Benutzer das Zeichen auswählt. Wenn die HelpContextIDeine Kontextnummer enthält, ruft der -Agent die Hilfe auf und sucht nach dem Thema, das durch die aktuelle Kontextnummer identifiziert wird. Die aktuelle Kontextnummer ist der Wert von HelpContextID für das Zeichen.

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

Hinweis

Zum Erstellen einer Hilfedatei ist der Microsoft Windows Help Compiler erforderlich.

Weitere Informationen

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