gFileCreate: gFileCreate

In RGtk2: R Bindings for Gtk 2.8.0 and Above

Description

Creates a new file and returns an output stream for writing to it. The file must not already exist.

Usage

gFileCreate(object, flags = "G_FILE_CREATE_NONE", cancellable = NULL, 
    .errwarn = TRUE)

Arguments

object	input GFile.
flags	a set of GFileCreateFlags.
cancellable	optional GCancellable object, NULL to ignore.
.errwarn	Whether to issue a warning on error or fail silently

Details

By default files created are generally readable by everyone, but if you pass G_FILE_CREATE_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 to 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.

Value

A list containing the following elements:

retval	[GFileOutputStream] a GFileOutputStream for the newly created file, or NULL on error.
error	a GError, or NULL

Author(s)

Derived by RGtkGen from GTK+ documentation

RGtk2 documentation built on Oct. 14, 2021, 5:08 p.m.