move


Description:

public abstract bool move (File destination, FileCopyFlags flags, Cancellable? cancellable = null, FileProgressCallback? progress_callback = null) throws Error

Tries to move the file or directory this to the location specified by destination.

If native move operations are supported then this is used, otherwise a copy + delete fallback is used. The native implementation may support moving directories (for instance on moves inside the same filesystem), but the fallback code does not.

If the flag OVERWRITE is specified an already existing destination file is overwritten.

If cancellable is not null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error g_io_error_cancelled will be returned.

If progress_callback is not null, then the operation can be monitored by setting this to a FileProgressCallback function. progress_callback_data will be passed to this function. It is guaranteed that this callback will be called after all data has been transferred with the total number of bytes copied during the operation.

If the this file does not exist, then the g_io_error_not_found error is returned, independent on the status of the destination.

If OVERWRITE is not specified and the target exists, then the error g_io_error_exists is returned.

If trying to overwrite a file over a directory, the g_io_error_is_directory error is returned. If trying to overwrite a directory with a directory the g_io_error_would_merge error is returned.

If the source is a directory and the target does not exist, or OVERWRITE is specified and the target is a file, then the g_io_error_would_recurse error may be returned (if the native move operation isn't available).

Example: Move a file:

public static int main (string[] args) {
if (args.length != 3) {
print ("%s SRC DEST\n", args[0]);
return 0;
}

File src = File.new_for_commandline_arg (args[1]);
File dest = File.new_for_commandline_arg (args[2]);

try {
src.move (dest, FileCopyFlags.NONE, null, (current_num_bytes, total_num_bytes) => {
print ("%" + int64.FORMAT + " %" + int64.FORMAT + "\n", current_num_bytes, total_num_bytes);
});
} catch (Error e) {
print ("Error: %s\n", e.message);
}

return 0;
}

valac --pkg gio-2.0 GLib.File.move.vala

Parameters:

this

File pointing to the source location

destination

File pointing to the destination location

flags

set of FileCopyFlags

cancellable

optional Cancellable object, null to ignore

progress_callback

FileProgressCallback function for updates

progress_callback_data

gpointer to user data for the callback function

Returns:

true on successful move, false otherwise.