AfArcReadCustomFld

AfArcReadCustomFld(alpha1, alpha2, int3[, alpha4]) : int
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(12) Nummer des Archives gAFArcDocDate date Dokumentdatum gAFArcScanDate date Scandatum gAFArcCreateModul alpha(80) Erstell-Modul gAFArcTypeString alpha(1024) Dateitypen gAFArcFilesCnt int Anzahl der Anhangdateien gAFArcScanFileCnt int Anzahl der Scanseiten gAFArcFileSize int Archivgröße (in KB) gAFArcStorageYears int Aufbewahrungsfrist (in Jahren) gAFArcCaption alpha(250) Name gAFArcLocation alpha(250) Beschreibung gAfArcColor int Farbe zur Darstellung im Arbeitsmappenbaum gAfArcCustomFld alpha(250) 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.

Bei Kombinationen mit der Leseoption _RecFirst, _RecPrev, _RecNext oder _RecLast wird nicht der Fehler _rNoRec zurückgegeben, wenn kein Archiv mit dem angegebenen Inhalt gefunden wurde. Statt dessen wird das Archiv gelesen, bei dem das Zusatzfeld gesetzt ist und der entsprechenden Position in der Sortierung entspricht.

Beispiele

ScriptAPIArcFlowAPI

// 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);
}

// Read all archives of one type
for tErr # AF.API:AfArcReadCustomFld('ArchiveType', 'Invoice', 0);
loop tErr # AF.API:AfArcReadCustomFld('ArchiveType', 'Invoice', _RecNext, gArcNr);
while (tErr = _rOk)
{
  ...
}

tErr # AF.API: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.