Topic       : TOS - das Betriebssystem
Author      : 
Version     : tos.hyp (5. März 2013)
Subject     : Programmieren/Atari
Nodes       : 3001
Index Size  : 93602
HCP-Version : 5
Compiled on : Atari
@charset    : atarist
@lang       : 
@default    : Titel
@help       : 
@options    : +g -i -s +x +zz -t4
@width      : 70
View Ref-File8.18.4  shel_help                                                  TOS

 Name:         Ausgabe von Hilfetexten.

 AES-Nummer:   128

 Deklaration:  int16_t shel_help ( int16_t sh_hmode, int8_t *sh_hfile, 
               int8_t *sh_hkey);

 Beschreibung: Die Funktion dient zur Ausgabe von Hilfetexten 
               (Online-Hilfe) über einen Help-Server.

                Parameter  Bedeutung

                sh_hmode   Hierfür ist im Moment immer SHP_HELP(=0) zu 
                           übergeben.

                sh_hfile   Name der Hilfedatei.

                           Wird sie inklusive einer Extension 
                           übergeben, so wird anhand dieser Extension 
                           der entsprechende Server in der Liste der 
                           Helpserver aufgesucht.

                           Hat die übergebene Datei keine Extension, 
                           so wird automatisch die des ersten in der 
                           CNF-Datei definierten Helpservers 
                           angehängt.

                sh_hkey    Schlüsselwort, zu welchem ein Hilfetext 
                           ausgegeben werden soll, oder NULL.

               Bei einem Aufruf von shel_help mit einer Datei, welche 
               eine Extension hat, prüft N.AES, ob ein Helpserver für 
               diese Extension (mittels 'helpserver') definiert wurde. 
               Wird ein passender Server gefunden, so wird geprüft, ob 
               dieser bereits aktiv ist (als Accessory oder auch als 
               nebenläufig gestartete Anwendung). Ist dies der Fall, 
               so wird dem Server die Mitteilung VA_START mit den bei 
               sh_hfile und sh_hkey angegebenen Argumenten als 
               Kommandozeile zugesendet.

               Ist der Server nicht aktiv, so wird er automatisch 
               gestartet, wenn bei seiner Definition mit Hilfe von 
               'helpserver' ein Pfad für ihn angegeben wurde. Als 
               Kommandozeile wird ihm dabei die bei sh_hfile und 
               sh_hkey angegebenen Argumente übergeben.

 Ergebnis:     Ein Rückgabewert von Null signalisiert einen Fehler.

 Verfügbar:    Das Vorhandensein dieser Funktion kann per appl_getinfo 
               (Opcode 65) festgestellt werden.

               Neben N.AES gibt es eine TSR welches diese Funktion auf 
               anderen Systemen zur Verfügung stellt.

 Gruppe:       Shell-Kommunikation

 Querverweis:  Binding