Mit dem Hilfe-Manager kommunizieren

Aus RAD Studio
Wechseln zu: Navigation, Suche

Nach oben zu Hilfesystem-Interfaces


System.HelpIntfs.ICustomHelpViewer stellt vier Funktionen für den Austausch von Systeminformation mit dem Hilfe-Manager bereit. Der Hilfe-Manager ruft diese Funktionen in folgenden Situationen auf:

  • GetViewerName: String--wird aufgerufen, wenn der Hilfe-Manager den Namen der Hilfeanzeige wissen will (wenn die Anwendung beispielsweise aufgefordert wird, eine Liste aller registrierten Hilfeanzeigen anzuzeigen). Diese Information wird in einem String-Rückgabewert zurückgegeben und muss logisch statisch sein (d.h. während der Ausführung der Anwendung dürfen keine Änderungen daran vorgenommen werden).
  • NotifyID(const ViewerID: Integer)--wird unmittelbar nach der Registrierung aufgerufen, um die Hilfeanzeige mit einem eindeutigen Cookie zu versehen, das sie identifiziert. Diese Information muss für die spätere Verwendung gespeichert werden; wenn die Hilfeanzeige selbständig geschlossen wird (im Gegensatz dazu, wenn sie nach einer Benachrichtigung des Hilfe-Managers geschlossen wird), muss sie dem Hilfe-Manager diesen Cookie bereitstellen, so dass er alle Verweise auf die Anzeige freigeben kann. (Wird der Cookie nicht übergeben oder wird der falsche Cookie übergeben, gibt der Hilfe-Manager möglicherweise Verweise auf die falsche Hilfeanzeige frei).
  • ShutDown--wird vom Hilfe-Manager aufgerufen, um die Hilfeanzeige darüber zu benachrichtigen, dass der Hilfe-Manager geschlossen wird und alle von ihm reservierten Ressourcen freigegeben werden sollen. Es wird empfohlen, die Freigabe aller Ressourcen dieser Methode zu überlassen.
  • SoftShutDown--wird vom Hilfe-Manager aufgerufen und veranlasst die Hilfeanzeige, sämtliche extern sichtbaren Instanzen des Hilfesystems zu schließen, ohne die Anzeige aus dem Speicher zu entfernen.

Siehe auch