AfArcRead

AfArcRead(int1) : int
Stammdaten eines Archivs lesen
int1 Leseoptionen: 0 Archiv lesen, dessen Nummer in gAFArcNr angegeben ist _RecFirst erstes Archiv lesen _RecPrev vorheriges Archiv lesen _RecNext nächstes Archiv lesen _RecLast letztes Archiv lesen _RecLock Archiv sperren _RecUnlock Archiv entsperren 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 Resultat int Fehlerwert Siehe Verwandte Befehle, AfArcEdit(), AfArcReadCustomFld()

Die Funktion liest das Archiv, dessen Archiv-Nummer in der globalen Variable gArcNr übergeben wird.

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

Konstante	Funktion
0	Liest das Archiv, dessen Nummer in gAFArcNr angegeben ist.
_RecFirst	Liest das erste Archiv
_RecPrev	Liest das Archiv, das sich vor dem angegebenen Archiv befindet
_RecNext	Liest das Archiv, das sich nach dem angegebenen Archiv befindet
_RecLast	Liest das letzte Archiv
_RecLock	sperrt das Archiv für exklusiven Zugriff
_RecUnlock	entsperrt das Archiv

Die Lese-Optionen können mit den Sperr-Optionen kombiniert werden. Soll das in gAFArcNr angegeben Archiv gelesen aber nicht gesperrt werden, muss in (int1) 0 übergeben werden.

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

Der Inhalt des Feldes gAfArcColor kann mit folgenden Konstanten verglichen werden:

Konstante	Wert	Farbe
sAfArcColorDefault	0
sAfArcColorCornflowerBlue	1
sAfArcColorAero	2
sAfArcColorPistachio	3
sAfArcColorChamoisee	4
sAfArcColorPeach	5
sAfArcColorAzure	6
sAfArcColorBeige	7
sAfArcColorIndianRed	8
sAfArcColorUclaBlue	9
sAfArcColorLimeGreen	10
sAfArcColorPastelBrown	11
sAfArcColorLavender	12
sAfArcColorChocolate	13
sAfArcColorOliveGreen	14
sAfArcColorCyan	15

Beispiele

Lesen eines bestimmten Archivs:

ScriptAPIArcFlowAPI

...
gAFArcNr # '2023.0001234';
tResult # AfArcRead(0);
if (tResult != _ErrOk)
{
  // Error handling
  ...
}
...

...
gArcNr # '2023.0001234';
tResult # AF.API:AfArcRead(0);
if (tResult != _ErrOk)
{
  // Error handling
  ...
}
...

Schleife über alle Archive:

ScriptAPIArcFlowAPI

for tResult # AfArcRead(_RecFirst);
loop tResult # AfArcRead(_RecNext);
while (tResult = _ErrOk or tResult = _rLocked)
{
  ...
}

for tResult # AF.API:AfArcRead(_RecFirst);
loop tResult # AF.API:AfArcRead(_RecNext);
while (tResult = _ErrOk or tResult = _rLocked)
{
  ...
}

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
_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.