#usage text [, text...]ist die übliche Methode diese Information verfügbar zu machen.
Wird die #usage-Direktive verwendet, wird ihr Text (der eine String-Konstante sein muss) im Control Panel verwendet, um die Beschreibung des Programms anzuzeigen.
Für den Fall, dass das ULP diese Information z. B. in einer dlgMessageBox() benötigt, ist dieser Text durch die Builtin-Konstante usage im ULP verfügbar.
Es wird nur die #usage-Direktive des Hauptprogramms (das ist die Datei, die mit dem RUN-Befehl gestartet wurde) berücksichtigt. Deshalb sollten reine include-Dateien auch eine eigene #usage-Directive enthalten.
Am besten ist die #usage-Direktive an den Anfang der Datei zu stellen, so muss das Control Panel nicht den ganzen Text der Datei durchsuchen, um die Informationen, die angezeigt werden sollen, zu finden.
Soll die Usage-Information in mehreren Sprachen verfügbar gemacht werden, so sind die Texte der verschiedenen Sprachen durch Kommas getrennt anzugeben. Dabei muß jeder Text mit dem zweibuchstabigen Code der jeweiligen Sprache (so wie er auch von der language()-Funktion geliefert wird), gefolgt von einem Doppelpunkt und beliebig vielen Leerzeichen beginnen. Falls für die auf dem aktuellen System verwendete Sprache kein passender Text gefunden wird, so wird der erste angegebene Text verwendet (dieser sollte generell Englisch sein um das Programm einer möglichst großen Zahl von Benutzern zugänglich zu machen).
Beispiel
#usage "en: A sample ULP\n" "Implements an example that shows how to use the EAGLE User Language\n" "Usage: RUN sample.ulp\n" "Author: john@home.org", "de: Beispiel eines ULPs\n" "Implementiert ein Beispiel das zeigt, wie man die EAGLE User Language benutzt\n" "Aufruf: RUN sample.ulp\n" "Author: john@home.org"
Index | Copyright © 2005 CadSoft Computer GmbH |