create_readwrite


Description:

[ Version ( since = "2.22" ) ]
public abstract FileIOStream create_readwrite (FileCreateFlags flags, Cancellable? cancellable = null) throws Error

Creates a new file and returns a stream for reading and writing to it.

The file must not already exist.

By default files created are generally readable by everyone, but if you pass PRIVATE in flags the file will be made readable only to the current user, to the level that is supported on the target filesystem.

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 a file or directory with this name already exists, the g_io_error_exists error will be returned. Some file systems don't allow all file names, and may return an g_io_error_invalid_filename error, and if the name is too long, g_io_error_filename_too_long will be returned. Other errors are possible too, and depend on what kind of filesystem the file is on.

Note that in many non-local file cases read and write streams are not supported, so make sure you really need to do read and write streaming, rather than just opening for reading or writing.

Example: Create a file, rw, sync:

public static int main (string[] args) {
// Create a file for reading and writing:
File file = File.new_for_path ("my-test.txt");
try {
FileIOStream stream = file.create_readwrite (FileCreateFlags.PRIVATE);
stream.output_stream.write ("My first line\n".data);
} catch (Error e) {
print ("Error: %s\n", e.message);
}

return 0;
}

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

Parameters:

this

a File

flags

a set of FileCreateFlags

cancellable

optional Cancellable object, null to ignore

Returns:

a FileIOStream for the newly created file, or null on error. Free the returned object with unref.