EAGLE Help

#usage


Jedes User-Language-Programm sollte Informationen über seine Funktion, die Benutzung und evtl. auch über den Autor enthalten.
Die Direktive

#usage 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.

Beispiel


#usage "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"

Index Copyright © 2002 CadSoft Computer GmbH