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.13.2  scrp_read                                                  TOS

 Name:         »Scrap read« - ermittelt den Pfadnamen des 
               Klemmbrettes.

 AES-Nummer:   80

 Deklaration:  int16_t scrp_read ( int8_t *sc_rpscrap );

 Beschreibung: Die Funktion ermittelt das aktuelle Verzeichnis, 
               welches für die Zwischenablage (Klemmbrett) benutzt 
               wird.

               Hinweis: Das Klemmbrett-Verzeichnis befindet sich nach 
               dem Aufruf der Funktion im Parameter sc_rpscrap. Man 
               sollte auf eine ausreichende Größe dieses aufnehmenden 
               Puffers achten.

 Ergebnis:     Ein Fehler ist nur dann aufgetreten, wenn als Ergebnis 
               0 zurückgegeben wird.

               Zitat Mike Fulton, Atari Computer:
               »The scrp_read() function is defined as possibly 
               returning an error code of zero. However, this function 
               currently always returns a value of 1. Since this may 
               change in future versions of GEM AES, applications 
               should handle the case of the error code even if the 
               programmer does not expect to see it.«

               Ab PC-GEM Version 2.0 werden jedoch die folgenden Werte 
               zurückgeliefert: -1, falls noch kein Pfad gesetzt ist, 
               Rückgabewerte >= 0 sind als Bitvektor aufzufassen, der 
               über gefundene Dateitypen informieren soll. Es gilt die 
               folgende Belegung:

                SCRAP_CSV  0x0001  =  scrap.csv 
                SCRAP_TXT  0x0002  =  scrap.txt 
                SCRAP_GEM  0x0004  =  scrap.gem 
                SCRAP_IMG  0x0008  =  scrap.img 
                SCRAP_DCA  0x0010  =  scrap.dca 
                           0x0020  =  scrap.dif (siehe Hinweis) 
                SCRAP_USR  0x8000  =  scrap.usr 

               Alle anderen Bits sind für zukünftige Zwecke 
               reserviert.

               Hinweis: Laut der Doku zu PC-GEM ist scrap.usr in Bit 5 
               kodiert. Der AES-Quelltext sagt aber Bit 15. Die 
               Library aus dem Buch "Vom Anfänger zum GEM-Profi" 
               belegt Bit 5 mit DIF-Dateien. Die Erweiterung ist 
               inoffiziell und funktioniert nur wenn diese Library für 
               die Erstellung benutzt wird.

 Verfügbar:    All AES versions, not present in ViewMAX.

 Gruppe:       Zwischenspeicher

 Querverweis:  Binding   scrp_write   Datenaustausch per Klemmbrett