Method

GioFilecreate_readwrite

since: 2.22

Declaration 

GFileIOStream*
g_file_create_readwrite (
  GFile* file,
  GFileCreateFlags flags,
  GCancellable* cancellable,
  GError** error
)

Description

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 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 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.

Available since: 2.22

Parameters

flags

Type: GFileCreateFlags

A set of GFileCreateFlags.

cancellable

Type: GCancellable

Optional GCancellable object, NULL to ignore.

The argument can be NULL.
The data is owned by the caller of the function.
error

Type: GError **

The return location for a recoverable error.

The argument can be NULL.
If the return location is not NULL, then you must initialize it to a NULL GError*.
The argument will left initialized to NULL by the method if there are no errors.
In case of error, the argument will be set to a newly allocated GError; the caller will take ownership of the data, and be responsible for freeing it.

Return value

Type: GFileIOStream

A GFileIOStream for the newly created file, or NULL on error. Free the returned object with g_object_unref().

The caller of the method takes ownership of the data, and is responsible for freeing it.