Zum Hauptinhalt springen

Datei oder Verzeichnis verschieben (file.move)

Deklaration​

erfolg, fehlermeldung = file.move(Quellpfad, Zielpfad [, Modus])

Parameter​

  • Quellpfad
    Text; absoluter Pfad der Quelldatei oder des Quellverzeichnisses
  • Zielpfad
    Text; vollständiger absoluter Pfad der verschobenen Datei oder des verschobenen Verzeichnisses einschließlich des Zieldatei- oder Zielverzeichnisnamens
  • Modus ab 20250914
    Text; optional, Verschiebemodus. Mögliche Werte:
    • Leere Zeichenkette oder ausgelassen: Standardmodus (no-clobber); bei vorhandenem Ziel wird ein Fehlschlag zurückgegeben
    • "overwrite" oder "o": Überschreibmodus; ersetzt das vorhandene Ziel direkt (das vorhandene Ziel wird gelöscht)
    • "merge" oder "m": Zusammenführungsmodus (nur für Verzeichnisse); vorhandene Dateien im Ziel bleiben erhalten
    • "overwrite-merge" oder "om"/"mo": Überschreibender Zusammenführungsmodus; führt Verzeichnisse zusammen, überschreibt aber gleichnamige Dateien

Rückgabewerte​

  • Erfolg
    Boolescher Wert; bei Erfolg true, bei Fehlschlag false
  • Fehlermeldung
    Text; Fehlermeldung bei einem Fehlschlag

Beschreibung​

Verschiebt die Datei oder das Verzeichnis unter Quellpfad nach Zielpfad; eine Namensänderung innerhalb desselben Verzeichnisses ist eine Umbenennung.
Diese Funktion bedeutet „verschieben als“, nicht „hineinverschieben“. Zielpfad bezeichnet die endgültige Datei oder das endgültige Verzeichnis; der Quelldatei- oder Quellverzeichnisname wird nicht automatisch angehängt. Auch wenn das Ziel bereits als Verzeichnis existiert oder der Zielpfad mit / endet, wird die Quelle nicht in dieses Verzeichnis hineinverschoben.
Um beispielsweise /a/b/c unter Beibehaltung des Namens c nach /d/e/ zu verschieben, muss der Zielpfad /d/e/c lauten, nicht nur /d/e/.
Existiert das Ziel bereits, entscheidet Modus: Der Standardmodus schlägt fehl, der Überschreibmodus ersetzt das Ziel selbst, und die Zusammenführungsmodi für Verzeichnisse führen den Inhalt des Quellverzeichnisses mit dem Zielverzeichnis zusammen.
Schlagwörter: Datei umbenennen, Verzeichnis umbenennen, Ordner umbenennen, Datei verschieben, Verzeichnis verschieben, Ordner verschieben
Erst in Versionen nach 20250313 verfügbar

Beispiel​

ok, err = file.move(XXT_SCRIPTS_PATH..'/1.zip', XXT_SCRIPTS_PATH..'/2.zip')
if not ok then
sys.alert('Verschieben fehlgeschlagen: '..err)
end

Hinweis: Der obige Code verwendet die Funktion sys.alert, die nicht zu diesem Kapitel gehört.

In ein anderes Verzeichnis verschieben und den Namen beibehalten​

-- Angenommen, /d/e ist ein vorhandenes Verzeichnis und /d/e/c existiert noch nicht
file.move('/a/b/c', '/d/e/c') -- Richtig: c nach /d/e/c verschieben

-- Eigenständiges Beispiel einer falschen Schreibweise: Das Ziel ist e selbst, nicht c im Verzeichnis e
-- file.move('/a/b/c', '/d/e/') -- Schlägt im Standardmodus fehl, da das Ziel bereits existiert

-- Der Überschreibmodus ersetzt e selbst und erzeugt kein /d/e/c (20250914+)
-- file.move('/a/b/c', '/d/e/', 'overwrite')

Eine Funktion zum Hineinverschieben in ein Verzeichnis definieren​

Das folgende Beispiel definiert eine eigene Hilfsfunktion und erfordert eine Version nach 20250914. Das Zielverzeichnis muss bereits existieren. Die Funktion behält den Namen der Quelldatei oder des Quellverzeichnisses bei und reicht den optionalen Parameter mode an file.move weiter. Namenskonflikte werden weiterhin gemäß dem angegebenen Modus behandelt.

local function file_move_into(src_path, dst_dir, mode)
if file.exists(dst_dir) ~= "directory" then
return false, "Target is not a directory"
end

local name, err = file.path.last_component(src_path)
if not name then
return false, err
end
-- Verhindert, dass das Zielverzeichnis selbst oder dessen übergeordnetes Verzeichnis zum endgültigen Ziel wird.
if name == "" or name == "/" or name == "." or name == ".." then
return false, "Source path must end with a file or directory name"
end

local dst_path, path_err = file.path.add_component(dst_dir, name)
if not dst_path then
return false, path_err
end
return file.move(src_path, dst_path, mode)
end

-- Angenommen, /d/e ist ein vorhandenes Verzeichnis; c nach /d/e/c verschieben
local ok, err = file_move_into("/a/b/c", "/d/e/")
if not ok then
print("Verschieben fehlgeschlagen: "..err)
end

-- Um /d/e/c zu ersetzen, geben Sie beim Aufruf den Überschreibmodus an:
-- file_move_into("/a/b/c", "/d/e/", "overwrite")

Hinweis: Der obige Code verwendet file.exists, file.path.last_component und file.path.add_component.