AfArcTextRead: Unterschied zwischen den Versionen

Aus ArcFlow Wiki
Zur Navigation springen Zur Suche springen
K Jens verschob die Seite AFArcTextRead nach AfArcTextRead, ohne dabei eine Weiterleitung anzulegen
K Stand 4.1.09
 
Zeile 6: Zeile 6:
   </tr>
   </tr>
   <tr class="ProcSyntax">
   <tr class="ProcSyntax">
     <td class="title">&nbsp;AFArcTextRead(alpha1, int2, int3[,alpha4]) : int</td>
     <td class="title">&nbsp;AfArcTextRead(alpha1, int2, int3[,alpha4]) : int</td>
     <td class="platforms">
     <td class="platforms">
[[file:DE_SymbolAPI.gif|alt=Ausführbar von der API|link=Befehle der Schnittstellen]][[file:DE_SymbolDLL.gif|alt=Ausführbar von der Programmierschnittstelle|link=Befehle der Schnittstellen]][[file:DE_SymbolARC.gif|alt=Ausführbar mit der Application Remote Control|link=Befehle der Schnittstellen]][[file:DE_SymbolScriptAPI.gif|alt=Ausführbar von der Script-API|link=Befehle der Schnittstellen]]
[[file:DE_SymbolAPI.gif|alt=Ausführbar von der API|link=Befehle der Schnittstellen]][[file:DE_SymbolDLL.gif|alt=Ausführbar von der Programmierschnittstelle|link=Befehle der Schnittstellen]][[file:DE_SymbolARC.gif|alt=Ausführbar mit der Application Remote Control|link=Befehle der Schnittstellen]][[file:DE_SymbolScriptAPI.gif|alt=Ausführbar von der Script-API|link=Befehle der Schnittstellen]]
Zeile 52: Zeile 52:
   <td width="85%" class=Right colspan="3">
   <td width="85%" class=Right colspan="3">
[[:Category:Befehle für Archive|Verwandte Befehle]],
[[:Category:Befehle für Archive|Verwandte Befehle]],
[[AFArcTextEdit#|AFArcTextEdit()]]
[[AfArcTextEdit#|AfArcTextEdit()]]
   </td>
   </td>
</tr>
</tr>
Zeile 64: Zeile 64:
<p><p>Die Funktion liest den Archiv-Text einer Anhangdatei des Archivs (alpha1). Welche Anhangdatei gelesen werden soll, wird über den Parameter (int2) definiert.</p>
<p><p>Die Funktion liest den Archiv-Text einer Anhangdatei des Archivs (alpha1). Welche Anhangdatei gelesen werden soll, wird über den Parameter (int2) definiert.</p>


<p>Im dritten Parameter muss der Deskriptor eines leeren Text-Puffers übergeben werden, der vor dem Aufruf der Funktion über den Befehl [[AFTextOpen#|AfTextOpen()]] angelegt wurde. Nach dem Aufruf der Funktion ist der Archiv-Text im Textpuffer abgelegt.</p>
<p>Im dritten Parameter muss der Deskriptor eines leeren Text-Puffers übergeben werden, der vor dem Aufruf der Funktion über den Befehl [[AfTextOpen#|AfTextOpen()]] angelegt wurde. Nach dem Aufruf der Funktion ist der Archiv-Text im Textpuffer abgelegt.</p>


<p>Der Archivtext wird von ArcFlow zwischenzeitlich in einem temporären Verzeichnis abgelegt und von dort von der API gelesen. Standardmäßig wird das im System eingestellte Temp-Verzeichnis verwendet. Über (alpha4) kann aber optional auch ein anderes Verzeichnis angegeben werden.</p>
<p>Der Archivtext wird von ArcFlow zwischenzeitlich in einem temporären Verzeichnis abgelegt und von dort von der API gelesen. Standardmäßig wird das im System eingestellte Temp-Verzeichnis verwendet. Über (alpha4) kann aber optional auch ein anderes Verzeichnis angegeben werden.</p>
Zeile 93: Zeile 93:
</table>
</table>


<p>Zum Beispiel: <font class=source>/user=admin /password=troja /action=fnc /fnc=AFArctextRead /ArcNr=2008.0000012 /Page=1 /RsltPath=c:\temp\AFAPIRES.TXT</font></p>
<p>Zum Beispiel: <font class=source>/user=admin /password=troja /action=fnc /fnc=AfArctextRead /ArcNr=2008.0000012 /Page=1 /RsltPath=c:\temp\AFAPIRES.TXT</font></p>


<p>In der Ergebnisdatei wird in der ersten Zeile die übergebene Anweisung  
<p>In der Ergebnisdatei wird in der ersten Zeile die übergebene Anweisung  

Aktuelle Version vom 30. Oktober 2024, 08:03 Uhr

 AfArcTextRead(alpha1, int2, int3[,alpha4]) : int

Ausführbar von der APIAusführbar von der ProgrammierschnittstelleAusführbar mit der Application Remote ControlAusführbar von der Script-API

Textseite eines Archivs lesen
alpha1 Nummer des Archives
int2 Nummer der Anhangdatei
int3 Text-Deskriptor
alpha4 temporärer Pfad (optional)
Resultat int Fehlerwert
Siehe

Verwandte Befehle, AfArcTextEdit()

Die Funktion liest den Archiv-Text einer Anhangdatei des Archivs (alpha1). Welche Anhangdatei gelesen werden soll, wird über den Parameter (int2) definiert.

Im dritten Parameter muss der Deskriptor eines leeren Text-Puffers übergeben werden, der vor dem Aufruf der Funktion über den Befehl AfTextOpen() angelegt wurde. Nach dem Aufruf der Funktion ist der Archiv-Text im Textpuffer abgelegt.

Der Archivtext wird von ArcFlow zwischenzeitlich in einem temporären Verzeichnis abgelegt und von dort von der API gelesen. Standardmäßig wird das im System eingestellte Temp-Verzeichnis verwendet. Über (alpha4) kann aber optional auch ein anderes Verzeichnis angegeben werden.

Der Benutzer muss in diesem Verzeichnis Schreibrechte besitzen.

Bei der Verwendung mit der Application Remote Control werden die Parameter mit folgenden Namen übergeben:

/ArcNr Nummer des Archivs
/Page zu lesende Anhangdatei
/Path temporärer Pfad
/RsltPath Pfad und Name der externen Datei, in der das Ergebnis gespeichert wird.

Zum Beispiel: /user=admin /password=troja /action=fnc /fnc=AfArctextRead /ArcNr=2008.0000012 /Page=1 /RsltPath=c:\temp\AFAPIRES.TXT

In der Ergebnisdatei wird in der ersten Zeile die übergebene Anweisung geschrieben. In der zweiten Zeile wird der Rückgabewert der Funktion gespeichert. In der folgenden Zeile wird der Pfad und der Name der externen Datei angegeben, in dem der Text steht.

Konstante Wert Bedeutung
_ErrOk 0 ok - kein Fehler aufgetreten
_rNoRec 5 Das übergebene Archiv wurde nicht gefunden
sAfErrNoRecArcTxt -20018 Zu dem angegebenen Archiv existiert kein Archivtext
sAfErrNoRights -20029 Die Berechtigungen reichen nicht aus
sAfErrArcTxtPageNotExists -20033 Die in (int2) übergebene Textseite existiert nicht

Für weitere CONZEPT 16-spezifische Rückgabewerte siehe die aktuelle CONZEPT 16-Hilfe.