Bezeichnung
zip.CloseArchive -- schliesst das Zip-Archiv
Übersicht
zip.CloseArchive(id[, discard, callback, userdata])
Beschreibung
Dieser Befehl schließt das in id angegebene Zip-Archiv. Beachten Sie, dass zip.CloseArchive() den Punkt angibt, an dem das Komprimieren und Schreiben der Daten tatsächlich erfolgt, wenn das Zip-Archiv zum Schreiben geöffnet wurde. Aus diesem Grund kann es einige Zeit dauern, bis dieser Befehl seine Arbeit beendet hat.

Wenn Sie alle Änderungen verwerfen möchten, die am ZIP-Archiv vorgenommen wurden, müssen Sie True im Parameter discard übergeben. In diesem Fall wird das ursprüngliche Zip-Archiv nicht geändert und alle Änderungen werden verworfen. Dies wird auch mit allen Zip-Archiven geschehen, die Sie mit zip.OpenArchive() öffnen, aber vergessen mit zip.CloseArchive() zu schließen. Änderungen werden nur dann in das Zip-Archiv geschrieben, wenn Sie explizit zip.CloseArchive() aufrufen, wobei discard False ist.

Wenn Sie den Fortschritt beim Komprimieren von Daten und beim Schreiben in das Zip-Archiv überwachen möchten, können Sie eine Callback-Funktion im dritten Parameter callback übergeben. Optional ist es auch möglich, Benutzerdaten anzugeben, die in ihrem vierten Argument userdata an die Callback-Funktion übergeben werden. Der Parameter userdata kann Werte beliebigen Typs annehmen: Zahlen, Zeichenketten, Tabellen und sogar Funktionen können als Benutzerdaten übergeben werden.

Die Status-Callback-Funktion empfängt ein einzelnes Tabellenelement, das die folgenden Felder enthält:

Action:
Enthält die Zeichenkette "CloseArchive".

ID:
Enthält den Identifikator des Zip-Archivs, an dem gerade gearbeitet wird.

Progress:
Enthält einen Wert zwischen 0 und 100, der angibt, wie viel Arbeit bereits erledigt wurde.

UserData:
Enthält den Wert, den Sie im Argument userdata übergeben haben.

Offensichtlich wird die Callback-Funktion niemals aufgerufen, wenn discard auf True gesetzt ist.

Eingaben
id
Identifikator des zu schließenden Zip-Archivs
discard
Optional: True um alle Änderungen zu verwerfen, False, um alle Änderungen in das Zip-Archiv zu schreiben (voreingestellt ist False)
callback
Optional: Funktion, die von Zeit zu Zeit aufgefrufen wird
userdata
Optional: Benutzerspezifische Daten, die an die Callback-Funktion übergeben werden

Navigation zeigen