AfArcReadCustomFld

Aus ArcFlow Wiki
Version vom 19. August 2020, 14:36 Uhr von AfWikiBot (Diskussion | Beiträge) (Die Seite wurde neu angelegt: „<languages /> <translate> <table class=head> <tr> <td class="BigTitle" colspan="2" align="center">file:DE_Schriftzug.gif</td> </tr> <tr clas…“)
(Unterschied) ← Nächstältere Version | Aktuelle Version (Unterschied) | Nächstjüngere Version → (Unterschied)
Zur Navigation springen Zur Suche springen
 AFArcReadCustomFld(alpha1, alpha2, int3[, alpha4]) : int

Ausführbar von der APINicht ausführbar von der Programmierschnittstelle (DLL)Nicht ausführbar mit der Application Remote ControlAusführbar von der Script-API

Archiv über kundenspezifische Zusatzfelder lesen
alpha1 Name des Zusatzfeldes
alpha2 Inhalt des Zusatzfeldes
int3 Leseoptionen:
_RecFirst erstes Archiv lesen
_RecPrev vorheriges Archiv lesen
_RecNext nächstes Archiv lesen
_RecLast letztes Archiv lesen
_RecLock Archiv sperren
_RecUnlock Archiv entsperren
alpha4 Startarchiv (optional)
Feldpuffer
gAfArcNr alpha Nummer des Archives
gAfArcDocDate date Dokumentdatum
gAfArcScanDate date Scandatum
gAfArcCreateModul alpha Erstell-Modul
gAfArcTypeString alpha Dateitypen
gAfArcFilesCnt int Anzahl der Anhangdateien
gAfArcScanFileCnt int Anzahl der Scanseiten
gAfArcFileSize int Archivgröße (in KB)
gAfArcStorageYears int Aufbewahrungsfrist (in Jahren)
gAfArcCaption alpha Beschreibung
gAfArcLocation alpha Standort
gAfArcInvisible logic Archiv nicht sichtbar
gAfArcCustomFld alpha Inhalt des kundenspezifischen Feldes
Resultat int Fehlerwert
Siehe

Verwandte Befehle, AFArcRead()

Die Funktion liest bei Angabe von 0 in (int3) das Archiv, dessen Zusatzfeld (alpha1) mit dem in (alpha2) übergebenen Wert übereinstimmt.

Die Suche nach dem Archiv kann an dem in (alpha4) angegebenen Archiv begonnen werden. Es wird dann ausgehend von dem angegebenen Archiv gesucht.

Bei Datums- und Zeitfeldern sind folgende Formate zwingend: YYYY-MM-DD bzw. HH:MM:SS.

Über den Parameter (int3) können zudem folgende Leseoptionen übergeben werden:

Konstante Funktion
_RecFirst Liest das erste Archiv, dessen Zusatzfeld (alpha1) gefüllt ist
_RecPrev Liest das vorherige Archiv, dessen Zusatzfeld (alpha1) gefüllt ist, ausgehend vom übergebenen Archiv
_RecNext Liest das nächste Archiv, dessen Zusatzfeld (alpha1) gefüllt ist, ausgehend vom übergebenen Archiv
_RecLast Liest das letzte Archiv, dessen Zusatzfeld (alpha1) gefüllt ist
_RecLock sperrt das Archiv für exklusiven Zugriff
_RecUnlock entsperrt das Archiv

Die Lese-Optionen können mit den Sperr-Optionen kombiniert werden.

Nach dem Aufruf der Funktion stehen in den Feldpuffern die Informationen des gelesenen Archivs zur Verfügung.

{{{1}}}

Beispiele

// Read all archives of one type
for tErr # AFArcReadCustomFld('ArchiveType', 'Invoice', 0);
loop tErr # AFArcReadCustomFld('ArchiveType', 'Invoice', _RecNext, gAFArcNr);
while (tErr = _rOk)
{
  ...
}
tErr # AfArcReadCustomFld('ArchiveType', 'zzz', _RecFirst);
if (tErr = _rOk)
{
  // Archive with value "zzz" in custom field
  // or 
  // Archive with lowest value in custom field
  // same as AfArcReadCustomFld('ArchiveType', '', _RecFirst);
}

Neben den allgemeinen Fehlerwerten können folgende Werte zurückgegeben werden:

Konstante Wert Bedeutung
_ErrOk 0 ok - kein Fehler aufgetreten
_rLocked 1 Das Archiv ist von einem anderen Benutzer gesperrt
_rMultiKey 2 Es sind mehrere Archive mit den angegebenen Schlüsselwerten vorhanden
_rNoKey 3 Es existiert kein Archiv mit den angegebenen Kriterien
_rLastRec 4 Es existiert kein Archiv mit den angegebenen Kriterien
_rNoRec 5 Das angegebene Archiv existiert nicht
sAfErrNoRights -20029 Die Benutzerrechte reichen nicht aus

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