Gets an output stream for appending data to the file. If the file doesn't already exist it is created.
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.
Some file systems don't allow all file names, and may return an %G_IO_ERROR_INVALID_FILENAME error. If the file is a directory the %G_IO_ERROR_IS_DIRECTORY error will be returned. Other errors are possible too, and depend on what kind of filesystem the file is on.
a set of #GFileCreateFlags
optional #GCancellable object, %NULL to ignore
Asynchronously opens file for appending.
For more details, see g_file_append_to() which is the synchronous version of this call.
When the operation is finished, callback will be called.
You can then call g_file_append_to_finish() to get the result
of the operation.
a set of #GFileCreateFlags
the [I/O priority][io-priority] of the request
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied
Finishes an asynchronous file append operation started with g_file_append_to_async().
#GAsyncResult
Creates a binding between source_property on source and target_property
on target.
Whenever the source_property is changed the target_property is
updated using the same value. For instance:
g_object_bind_property (action, "active", widget, "sensitive", 0);
Will result in the "sensitive" property of the widget #GObject instance to be updated with the same value of the "active" property of the action #GObject instance.
If flags contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well.
The binding will automatically be removed when either the source or the
target instances are finalized. To remove the binding without affecting the
source and the target you can just call g_object_unref() on the returned
#GBinding instance.
Removing the binding by calling g_object_unref() on it must only be done if
the binding, source and target are only used from a single thread and it
is clear that both source and target outlive the binding. Especially it
is not safe to rely on this if the binding, source or target can be
finalized from different threads. Keep another reference to the binding and
use g_binding_unbind() instead to be on the safe side.
A #GObject can have multiple bindings.
the property on source to bind
the target #GObject
the property on target to bind
flags to pass to #GBinding
Creates a binding between source_property on source and target_property
on target, allowing you to set the transformation functions to be used by
the binding.
This function is the language bindings friendly version of g_object_bind_property_full(), using #GClosures instead of function pointers.
the property on source to bind
the target #GObject
the property on target to bind
flags to pass to #GBinding
a #GClosure wrapping the transformation function from the source to the target, or %NULL to use the default
a #GClosure wrapping the transformation function from the target to the source, or %NULL to use the default
Prepares the file attribute query string for copying to file.
This function prepares an attribute query string to be passed to g_file_query_info() to get a list of attributes normally copied with the file (see g_file_copy_attributes() for the detailed description). This function is used by the implementation of g_file_copy_attributes() and is useful when one needs to query and set the attributes in two stages (e.g., for recursive move of a directory).
a set of #GFileCopyFlags
optional #GCancellable object, %NULL to ignore
Copies the file source to the location specified by destination.
Can not handle recursive copies of directories.
If the flag %G_FILE_COPY_OVERWRITE is specified an already
existing destination file is overwritten.
If the flag %G_FILE_COPY_NOFOLLOW_SYMLINKS is specified then symlinks
will be copied as symlinks, otherwise the target of the
source symlink will be copied.
If the flag %G_FILE_COPY_ALL_METADATA is specified then all the metadata that is possible to copy is copied, not just the default subset (which, for instance, does not include the owner, see #GFileInfo).
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 #GFileProgressCallback 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 source file does not exist, then the %G_IO_ERROR_NOT_FOUND error
is returned, independent on the status of the destination.
If %G_FILE_COPY_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 %G_FILE_COPY_OVERWRITE is specified and the target is a file, then the %G_IO_ERROR_WOULD_RECURSE error is returned.
If you are interested in copying the #GFile object itself (not the on-disk file), see g_file_dup().
destination #GFile
set of #GFileCopyFlags
optional #GCancellable object, %NULL to ignore
function to callback with progress information, or %NULL if progress information is not needed
Copies the file source to the location specified by destination
asynchronously. For details of the behaviour, see g_file_copy().
If progress_callback is not %NULL, then that function that will be called
just like in g_file_copy(). The callback will run in the default main context
of the thread calling g_file_copy_async() — the same context as callback is
run in.
When the operation is finished, callback will be called. You can then call
g_file_copy_finish() to get the result of the operation.
destination #GFile
set of #GFileCopyFlags
the [I/O priority][io-priority] of the request
optional #GCancellable object, %NULL to ignore
Copies the file attributes from source to destination.
Normally only a subset of the file attributes are copied,
those that are copies in a normal file copy operation
(which for instance does not include e.g. owner). However
if %G_FILE_COPY_ALL_METADATA is specified in flags, then
all the metadata that is possible to copy is copied. This
is useful when implementing move by copy + delete source.
a #GFile to copy attributes to
a set of #GFileCopyFlags
optional #GCancellable object, %NULL to ignore
Finishes copying the file started with g_file_copy_async().
a #GAsyncResult
Creates a new file and returns an output stream for 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 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.
a set of #GFileCreateFlags
optional #GCancellable object, %NULL to ignore
Asynchronously creates a new file and returns an output stream for writing to it. The file must not already exist.
For more details, see g_file_create() which is the synchronous version of this call.
When the operation is finished, callback will be called.
You can then call g_file_create_finish() to get the result
of the operation.
a set of #GFileCreateFlags
the [I/O priority][io-priority] of the request
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied
Finishes an asynchronous file create operation started with g_file_create_async().
a #GAsyncResult
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.
a set of #GFileCreateFlags
optional #GCancellable object, %NULL to ignore
Asynchronously creates a new file and returns a stream for reading and writing to it. The file must not already exist.
For more details, see g_file_create_readwrite() which is the synchronous version of this call.
When the operation is finished, callback will be called.
You can then call g_file_create_readwrite_finish() to get
the result of the operation.
a set of #GFileCreateFlags
the [I/O priority][io-priority] of the request
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied
Finishes an asynchronous file create operation started with g_file_create_readwrite_async().
a #GAsyncResult
Deletes a file. If the file is a directory, it will only be
deleted if it is empty. This has the same semantics as g_unlink().
If file doesn’t exist, %G_IO_ERROR_NOT_FOUND will be returned. This allows
for deletion to be implemented avoiding
time-of-check to time-of-use races:
|[
g_autoptr(GError) local_error = NULL;
if (!g_file_delete (my_file, my_cancellable, &local_error) &&
!g_error_matches (local_error, G_IO_ERROR, G_IO_ERROR_NOT_FOUND))
{
// deletion failed for some reason other than the file not existing:
// so report the error
g_warning ("Failed to delete %s: %s",
g_file_peek_path (my_file), local_error->message);
}
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.
@param cancellable optional #GCancellable object, %NULL to ignore
Asynchronously delete a file. If the file is a directory, it will
only be deleted if it is empty. This has the same semantics as
g_unlink().
the [I/O priority][io-priority] of the request
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied
Finishes deleting a file started with g_file_delete_async().
a #GAsyncResult
Duplicates a #GFile handle. This operation does not duplicate the actual file or directory represented by the #GFile; see g_file_copy() if attempting to copy a file.
g_file_dup() is useful when a second handle is needed to the same underlying file, for use in a separate thread (#GFile is not thread-safe). For use within the same thread, use g_object_ref() to increment the existing object’s reference count.
This call does no blocking I/O.
Starts an asynchronous eject on a mountable.
When this operation has completed, callback will be called with
user_user data, and the operation can be finalized with
g_file_eject_mountable_finish().
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.
flags affecting the operation
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied, or %NULL
Finishes an asynchronous eject operation started by g_file_eject_mountable().
a #GAsyncResult
Starts an asynchronous eject on a mountable.
When this operation has completed, callback will be called with
user_user data, and the operation can be finalized with
g_file_eject_mountable_with_operation_finish().
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.
flags affecting the operation
a #GMountOperation, or %NULL to avoid user interaction
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied, or %NULL
Finishes an asynchronous eject operation started by g_file_eject_mountable_with_operation().
a #GAsyncResult
Gets the requested information about the files in a directory. The result is a #GFileEnumerator object that will give out #GFileInfo objects for all the files in the directory.
The attributes value is a string that specifies the file
attributes that should be gathered. It is not an error if
it's not possible to read a particular requested attribute
from a file - it just won't be set. attributes should
be a comma-separated list of attributes or attribute wildcards.
The wildcard "" means all attributes, and a wildcard like
"standard::" means all attributes in the standard namespace.
An example attribute query be "standard::*,owner::user".
The standard attributes are available as defines, like
%G_FILE_ATTRIBUTE_STANDARD_NAME. %G_FILE_ATTRIBUTE_STANDARD_NAME should
always be specified if you plan to call g_file_enumerator_get_child() or
g_file_enumerator_iterate() on the returned enumerator.
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 the file does not exist, the %G_IO_ERROR_NOT_FOUND error will be returned. If the file is not a directory, the %G_IO_ERROR_NOT_DIRECTORY error will be returned. Other errors are possible too.
an attribute query string
a set of #GFileQueryInfoFlags
optional #GCancellable object, %NULL to ignore
Asynchronously gets the requested information about the files in a directory. The result is a #GFileEnumerator object that will give out #GFileInfo objects for all the files in the directory.
For more details, see g_file_enumerate_children() which is the synchronous version of this call.
When the operation is finished, callback will be called. You can
then call g_file_enumerate_children_finish() to get the result of
the operation.
an attribute query string
a set of #GFileQueryInfoFlags
the [I/O priority][io-priority] of the request
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied
Finishes an async enumerate children operation. See g_file_enumerate_children_async().
a #GAsyncResult
Gets a #GMount for the #GFile.
#GMount is returned only for user interesting locations, see
#GVolumeMonitor. If the #GFileIface for file does not have a #mount,
error will be set to %G_IO_ERROR_NOT_FOUND and %NULL #will be returned.
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.
optional #GCancellable object, %NULL to ignore
Asynchronously gets the mount for the file.
For more details, see g_file_find_enclosing_mount() which is the synchronous version of this call.
When the operation is finished, callback will be called.
You can then call g_file_find_enclosing_mount_finish() to
get the result of the operation.
the [I/O priority][io-priority] of the request
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied
Finishes an asynchronous find mount request. See g_file_find_enclosing_mount_async().
a #GAsyncResult
This function is intended for #GObject implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().
Increases the freeze count on object. If the freeze count is
non-zero, the emission of "notify" signals on object is
stopped. The signals are queued until the freeze count is decreased
to zero. Duplicate notifications are squashed so that at most one
#GObject::notify signal is emitted for each property modified while the
object is frozen.
This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.
Gets the base name (the last component of the path) for a given #GFile.
If called for the top level of a system (such as the filesystem root or a uri like sftp://host/) it will return a single directory separator (and on Windows, possibly a drive letter).
The base name is a byte string (not UTF-8). It has no defined encoding or rules other than it may not contain zero bytes. If you want to use filenames in a user interface you should use the display name that you can get by requesting the %G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME attribute with g_file_query_info().
This call does no blocking I/O.
Gets a child of file with basename equal to name.
Note that the file with that specific name might not exist, but you can still have a #GFile that points to it. You can use this for instance to create that file.
This call does no blocking I/O.
string containing the child's basename
Gets the child of file for a given display_name (i.e. a UTF-8
version of the name). If this function fails, it returns %NULL
and error will be set. This is very useful when constructing a
#GFile for a new file and the user entered the filename in the
user interface, for instance when you select a directory and
type a filename in the file selector.
This call does no blocking I/O.
string to a possible child
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
Gets the parse name of the file.
A parse name is a UTF-8 string that describes the
file such that one can get the #GFile back using
g_file_parse_name().
This is generally used to show the #GFile as a nice full-pathname kind of string in a user interface, like in a location entry.
For local files with names that can safely be converted to UTF-8 the pathname is used, otherwise the IRI is used (a form of URI that allows UTF-8 characters unescaped).
This call does no blocking I/O.
Gets the local pathname for #GFile, if one exists. If non-%NULL, this is guaranteed to be an absolute, canonical path. It might contain symlinks.
This call does no blocking I/O.
Gets a property of an object.
The value can be:
In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling g_value_unset().
Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.
the name of the property to get
return location for the property value
This function gets back user data pointers stored via g_object_set_qdata().
A #GQuark, naming the user data pointer
Gets the URI for the file.
This call does no blocking I/O.
Gets the URI scheme for a #GFile. RFC 3986 decodes the scheme as: |[ URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] ```
Common schemes include "file", "http", "ftp", etc.
The scheme can be different from the one used to construct the #GFile, in that it might be replaced with one that is logically equivalent to the #GFile.
This call does no blocking I/O.
Gets n_properties properties for an object.
Obtained properties will be set to values. All properties must be valid.
Warnings will be emitted and undefined behaviour may result if invalid
properties are passed in.
the names of each property to get
the values of each property to get
Checks if file has a parent, and optionally, if it is parent.
If parent is %NULL then this function returns %TRUE if file has any
parent at all. If parent is non-%NULL then %TRUE is only returned
if file is an immediate child of parent.
Checks whether file has the prefix specified by prefix.
In other words, if the names of initial elements of file's
pathname match prefix. Only full pathname elements are matched,
so a path like /foo is not considered a prefix of /foobar, only
of /foo/bar.
A #GFile is not a prefix of itself. If you want to check for equality, use g_file_equal().
This call does no I/O, as it works purely on names. As such it can
sometimes return %FALSE even if file is inside a prefix (from a
filesystem point of view), because the prefix of file is an alias
of prefix.
Checks to see if a #GFile has a given URI scheme.
This call does no blocking I/O.
a string containing a URI scheme
Creates a hash value for a #GFile.
This call does no blocking I/O.
Checks whether object has a [floating][floating-ref] reference.
Checks to see if a file is native to the platform.
A native file is one expressed in the platform-native filename format, e.g. "C:\Windows" or "/usr/bin/". This does not mean the file is local, as it might be on a locally mounted remote filesystem.
On some systems non-native files may be available using the native filesystem via a userspace filesystem (FUSE), in these cases this call will return %FALSE, but g_file_get_path() will still return a native path.
This call does no blocking I/O.
Loads the contents of file and returns it as #GBytes.
If file is a resource:// based URI, the resulting bytes will reference the
embedded resource instead of a copy. Otherwise, this is equivalent to calling
g_file_load_contents() and g_bytes_new_take().
For resources, etag_out will be set to %NULL.
The data contained in the resulting #GBytes is always zero-terminated, but this is not included in the #GBytes length. The resulting #GBytes should be freed with g_bytes_unref() when no longer in use.
a #GCancellable or %NULL
Asynchronously loads the contents of file as #GBytes.
If file is a resource:// based URI, the resulting bytes will reference the
embedded resource instead of a copy. Otherwise, this is equivalent to calling
g_file_load_contents_async() and g_bytes_new_take().
callback should call g_file_load_bytes_finish() to get the result of this
asynchronous operation.
See g_file_load_bytes() for more information.
a #GCancellable or %NULL
a #GAsyncReadyCallback to call when the request is satisfied
Completes an asynchronous request to g_file_load_bytes_async().
For resources, etag_out will be set to %NULL.
The data contained in the resulting #GBytes is always zero-terminated, but this is not included in the #GBytes length. The resulting #GBytes should be freed with g_bytes_unref() when no longer in use.
See g_file_load_bytes() for more information.
a #GAsyncResult provided to the callback
Loads the content of the file into memory. The data is always
zero-terminated, but this is not included in the resultant length.
The returned contents should be freed with g_free() when no longer
needed.
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.
optional #GCancellable object, %NULL to ignore
Starts an asynchronous load of the file's contents.
For more details, see g_file_load_contents() which is the synchronous version of this call.
When the load operation has completed, callback will be called
with user data. To finish the operation, call
g_file_load_contents_finish() with the #GAsyncResult returned by
the callback.
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.
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied
Finishes an asynchronous load of the file's contents.
The contents are placed in contents, and length is set to the
size of the contents string. The contents should be freed with
g_free() when no longer needed. If etag_out is present, it will be
set to the new entity tag for the file.
a #GAsyncResult
Finishes an asynchronous partial load operation that was started
with g_file_load_partial_contents_async(). The data is always
zero-terminated, but this is not included in the resultant length.
The returned contents should be freed with g_free() when no longer
needed.
a #GAsyncResult
Creates a directory. Note that this will only create a child directory
of the immediate parent directory of the path or URI given by the #GFile.
To recursively create directories, see g_file_make_directory_with_parents().
This function will fail if the parent directory does not exist, setting
error to %G_IO_ERROR_NOT_FOUND. If the file system doesn't support
creating directories, this function will fail, setting error to
%G_IO_ERROR_NOT_SUPPORTED.
For a local #GFile the newly created directory will have the default (current) ownership and permissions of the current process.
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.
optional #GCancellable object, %NULL to ignore
Asynchronously creates a directory.
the [I/O priority][io-priority] of the request
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied
Finishes an asynchronous directory creation, started with g_file_make_directory_async().
a #GAsyncResult
Creates a directory and any parent directories that may not
exist similar to 'mkdir -p'. If the file system does not support
creating directories, this function will fail, setting error to
%G_IO_ERROR_NOT_SUPPORTED. If the directory itself already exists,
this function will fail setting error to %G_IO_ERROR_EXISTS, unlike
the similar g_mkdir_with_parents().
For a local #GFile the newly created directories will have the default (current) ownership and permissions of the current process.
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.
optional #GCancellable object, %NULL to ignore
Creates a symbolic link named file which contains the string
symlink_value.
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.
a string with the path for the target of the new symlink
optional #GCancellable object, %NULL to ignore
Collects the results from an earlier call to g_file_measure_disk_usage_async(). See g_file_measure_disk_usage() for more information.
the #GAsyncResult passed to your #GAsyncReadyCallback
Obtains a file or directory monitor for the given file, depending on the type of the file.
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.
a set of #GFileMonitorFlags
optional #GCancellable object, %NULL to ignore
Obtains a directory monitor for the given file. This may fail if directory monitoring is not supported.
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.
It does not make sense for flags to contain
%G_FILE_MONITOR_WATCH_HARD_LINKS, since hard links can not be made to
directories. It is not possible to monitor all the files in a
directory for changes made via hard links; if you want to do this then
you must register individual watches with g_file_monitor().
a set of #GFileMonitorFlags
optional #GCancellable object, %NULL to ignore
Obtains a file monitor for the given file. If no file notification mechanism exists, then regular polling of the file is used.
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 flags contains %G_FILE_MONITOR_WATCH_HARD_LINKS then the monitor
will also attempt to report changes made to the file via another
filename (ie, a hard link). Without this flag, you can only rely on
changes made through the filename contained in file to be
reported. Using this flag may result in an increase in resource
usage, and may not have any effect depending on the #GFileMonitor
backend and/or filesystem type.
a set of #GFileMonitorFlags
optional #GCancellable object, %NULL to ignore
Starts a mount_operation, mounting the volume that contains
the file location.
When this operation has completed, callback will be called with
user_user data, and the operation can be finalized with
g_file_mount_enclosing_volume_finish().
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.
flags affecting the operation
a #GMountOperation or %NULL to avoid user interaction
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied, or %NULL
Finishes a mount operation started by g_file_mount_enclosing_volume().
a #GAsyncResult
Mounts a file of type G_FILE_TYPE_MOUNTABLE.
Using mount_operation, you can request callbacks when, for instance,
passwords are needed during authentication.
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.
When the operation is finished, callback will be called.
You can then call g_file_mount_mountable_finish() to get
the result of the operation.
flags affecting the operation
a #GMountOperation, or %NULL to avoid user interaction
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied, or %NULL
Finishes a mount operation. See g_file_mount_mountable() for details.
Finish an asynchronous mount operation that was started with g_file_mount_mountable().
a #GAsyncResult
Tries to move the file or directory source 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 %G_FILE_COPY_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 #GFileProgressCallback 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 source file does not exist, then the %G_IO_ERROR_NOT_FOUND
error is returned, independent on the status of the destination.
If %G_FILE_COPY_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 %G_FILE_COPY_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).
#GFile pointing to the destination location
set of #GFileCopyFlags
optional #GCancellable object, %NULL to ignore
#GFileProgressCallback function for updates
Asynchronously moves a file source to the location of destination. For details of the behaviour, see g_file_move().
If progress_callback is not %NULL, then that function that will be called
just like in g_file_move(). The callback will run in the default main context
of the thread calling g_file_move_async() — the same context as callback is
run in.
When the operation is finished, callback will be called. You can then call
g_file_move_finish() to get the result of the operation.
#GFile pointing to the destination location
set of #GFileCopyFlags
the [I/O priority][io-priority] of the request
optional #GCancellable object, %NULL to ignore
#GFileProgressCallback function for updates
a #GAsyncReadyCallback to call when the request is satisfied
Finishes an asynchronous file movement, started with g_file_move_async().
a #GAsyncResult
Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.
Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.
the name of a property installed on the class of object.
Emits a "notify" signal for the property specified by pspec on object.
This function omits the property name lookup, hence it is faster than g_object_notify().
One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:
enum
{
PROP_0,
PROP_FOO,
PROP_LAST
};
static GParamSpec *properties[PROP_LAST];
static void
my_object_class_init (MyObjectClass *klass)
{
properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
0, 100,
50,
G_PARAM_READWRITE);
g_object_class_install_property (gobject_class,
PROP_FOO,
properties[PROP_FOO]);
}
and then notify a change on the "foo" property with:
g_object_notify_by_pspec (self, properties[PROP_FOO]);
the #GParamSpec of a property installed on the class of object.
Opens an existing file for reading and writing. The result is a #GFileIOStream that can be used to read and write the contents of the file.
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 the file does not exist, the %G_IO_ERROR_NOT_FOUND error will be returned. If the file is a directory, the %G_IO_ERROR_IS_DIRECTORY error 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.
a #GCancellable
Asynchronously opens file for reading and writing.
For more details, see g_file_open_readwrite() which is the synchronous version of this call.
When the operation is finished, callback will be called.
You can then call g_file_open_readwrite_finish() to get
the result of the operation.
the [I/O priority][io-priority] of the request
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied
Finishes an asynchronous file read operation started with g_file_open_readwrite_async().
a #GAsyncResult
Exactly like g_file_get_path(), but caches the result via
g_object_set_qdata_full(). This is useful for example in C
applications which mix g_file_* APIs with native ones. It
also avoids an extra duplicated string when possible, so will be
generally more efficient.
This call does no blocking I/O.
Polls a file of type %G_FILE_TYPE_MOUNTABLE.
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.
When the operation is finished, callback will be called.
You can then call g_file_mount_mountable_finish() to get
the result of the operation.
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied, or %NULL
Finishes a poll operation. See g_file_poll_mountable() for details.
Finish an asynchronous poll operation that was polled with g_file_poll_mountable().
a #GAsyncResult
Returns the #GAppInfo that is registered as the default
application to handle the file specified by file.
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.
optional #GCancellable object, %NULL to ignore
Async version of g_file_query_default_handler().
the [I/O priority][io-priority] of the request
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is done
Finishes a g_file_query_default_handler_async() operation.
a #GAsyncResult
Utility function to check if a particular file exists. This is implemented using g_file_query_info() and as such does blocking I/O.
Note that in many cases it is racy to first check for file existence and then execute something based on the outcome of that, because the file might have been created or removed in between the operations. The general approach to handling that is to not check, but just do the operation and handle the errors as they come.
As an example of race-free checking, take the case of reading a file, and if it doesn't exist, creating it. There are two racy versions: read it, and on error create it; and: check if it exists, if not create it. These can both result in two processes creating the file (with perhaps a partially written file as the result). The correct approach is to always try to create the file with g_file_create() which will either atomically create the file or fail with a %G_IO_ERROR_EXISTS error.
However, in many cases an existence check is useful in a user interface, for instance to make a menu item sensitive/insensitive, so that you don't have to fool users that something is possible and then just show an error dialog. If you do this, you should make sure to also handle the errors that can happen due to races when you execute the operation.
optional #GCancellable object, %NULL to ignore
Utility function to inspect the #GFileType of a file. This is implemented using g_file_query_info() and as such does blocking I/O.
The primary use case of this method is to check if a file is a regular file, directory, or symlink.
a set of #GFileQueryInfoFlags passed to g_file_query_info()
optional #GCancellable object, %NULL to ignore
Similar to g_file_query_info(), but obtains information
about the filesystem the file is on, rather than the file itself.
For instance the amount of space available and the type of
the filesystem.
The attributes value is a string that specifies the attributes
that should be gathered. It is not an error if it's not possible
to read a particular requested attribute from a file - it just
won't be set. attributes should be a comma-separated list of
attributes or attribute wildcards. The wildcard "" means all
attributes, and a wildcard like "filesystem::" means all attributes
in the filesystem namespace. The standard namespace for filesystem
attributes is "filesystem". Common attributes of interest are
%G_FILE_ATTRIBUTE_FILESYSTEM_SIZE (the total size of the filesystem
in bytes), %G_FILE_ATTRIBUTE_FILESYSTEM_FREE (number of bytes available),
and %G_FILE_ATTRIBUTE_FILESYSTEM_TYPE (type of the 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 the file does not exist, the %G_IO_ERROR_NOT_FOUND error will be returned. Other errors are possible too, and depend on what kind of filesystem the file is on.
an attribute query string
optional #GCancellable object, %NULL to ignore
Asynchronously gets the requested information about the filesystem
that the specified file is on. The result is a #GFileInfo object
that contains key-value attributes (such as type or size for the
file).
For more details, see g_file_query_filesystem_info() which is the synchronous version of this call.
When the operation is finished, callback will be called. You can
then call g_file_query_info_finish() to get the result of the
operation.
an attribute query string
the [I/O priority][io-priority] of the request
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied
Finishes an asynchronous filesystem info query. See g_file_query_filesystem_info_async().
a #GAsyncResult
Gets the requested information about specified file.
The result is a #GFileInfo object that contains key-value
attributes (such as the type or size of the file).
The attributes value is a string that specifies the file
attributes that should be gathered. It is not an error if
it's not possible to read a particular requested attribute
from a file - it just won't be set. attributes should be a
comma-separated list of attributes or attribute wildcards.
The wildcard "" means all attributes, and a wildcard like
"standard::" means all attributes in the standard namespace.
An example attribute query be "standard::*,owner::user".
The standard attributes are available as defines, like
%G_FILE_ATTRIBUTE_STANDARD_NAME.
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.
For symlinks, normally the information about the target of the
symlink is returned, rather than information about the symlink
itself. However if you pass %G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS
in flags the information about the symlink itself will be returned.
Also, for symlinks that point to non-existing files the information
about the symlink itself will be returned.
If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will be returned. Other errors are possible too, and depend on what kind of filesystem the file is on.
an attribute query string
a set of #GFileQueryInfoFlags
optional #GCancellable object, %NULL to ignore
Asynchronously gets the requested information about specified file.
The result is a #GFileInfo object that contains key-value attributes
(such as type or size for the file).
For more details, see g_file_query_info() which is the synchronous version of this call.
When the operation is finished, callback will be called. You can
then call g_file_query_info_finish() to get the result of the operation.
an attribute query string
a set of #GFileQueryInfoFlags
the [I/O priority][io-priority] of the request
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied
Finishes an asynchronous file info query. See g_file_query_info_async().
a #GAsyncResult
Obtain the list of settable attributes for the file.
Returns the type and full attribute name of all the attributes that can be set on this file. This doesn't mean setting it will always succeed though, you might get an access failure, or some specific file may not support a specific attribute.
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.
optional #GCancellable object, %NULL to ignore
Obtain the list of attribute namespaces where new attributes can be created by a user. An example of this is extended attributes (in the "xattr" namespace).
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.
optional #GCancellable object, %NULL to ignore
Opens a file for reading. The result is a #GFileInputStream that can be used to read the contents of the file.
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 the file does not exist, the %G_IO_ERROR_NOT_FOUND error will be returned. If the file is a directory, the %G_IO_ERROR_IS_DIRECTORY error will be returned. Other errors are possible too, and depend on what kind of filesystem the file is on.
a #GCancellable
Asynchronously opens file for reading.
For more details, see g_file_read() which is the synchronous version of this call.
When the operation is finished, callback will be called.
You can then call g_file_read_finish() to get the result
of the operation.
the [I/O priority][io-priority] of the request
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied
Finishes an asynchronous file read operation started with g_file_read_async().
a #GAsyncResult
Increase the reference count of object, and possibly remove the
[floating][floating-ref] reference, if object has a floating reference.
In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.
Since GLib 2.56, the type of object will be propagated to the return type
under the same conditions as for g_object_ref().
Returns an output stream for overwriting the file, possibly creating a backup copy of the file first. If the file doesn't exist, it will be created.
This will try to replace the file in the safest way possible so that any errors during the writing will not affect an already existing copy of the file. For instance, for local files it may write to a temporary file and then atomically rename over the destination when the stream is closed.
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 you pass in a non-%NULL etag value and file already exists, then
this value is compared to the current entity tag of the file, and if
they differ an %G_IO_ERROR_WRONG_ETAG error is returned. This
generally means that the file has been changed since you last read
it. You can get the new etag from g_file_output_stream_get_etag()
after you've finished writing and closed the #GFileOutputStream. When
you load a new file you can use g_file_input_stream_query_info() to
get the etag of the file.
If make_backup is %TRUE, this function will attempt to make a
backup of the current file before overwriting it. If this fails
a %G_IO_ERROR_CANT_CREATE_BACKUP error will be returned. If you
want to replace anyway, try again with make_backup set to %FALSE.
If the file is a directory the %G_IO_ERROR_IS_DIRECTORY error will be returned, and if the file is some other form of non-regular file then a %G_IO_ERROR_NOT_REGULAR_FILE 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.
an optional [entity tag][gfile-etag] for the current #GFile, or #NULL to ignore
%TRUE if a backup should be created
a set of #GFileCreateFlags
optional #GCancellable object, %NULL to ignore
Asynchronously overwrites the file, replacing the contents, possibly creating a backup copy of the file first.
For more details, see g_file_replace() which is the synchronous version of this call.
When the operation is finished, callback will be called.
You can then call g_file_replace_finish() to get the result
of the operation.
an [entity tag][gfile-etag] for the current #GFile, or %NULL to ignore
%TRUE if a backup should be created
a set of #GFileCreateFlags
the [I/O priority][io-priority] of the request
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied
Replaces the contents of file with contents of length bytes.
If etag is specified (not %NULL), any existing file must have that etag,
or the error %G_IO_ERROR_WRONG_ETAG will be returned.
If make_backup is %TRUE, this function will attempt to make a backup
of file. Internally, it uses g_file_replace(), so will try to replace the
file contents in the safest way possible. For example, atomic renames are
used when replacing local files’ contents.
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.
The returned new_etag can be used to verify that the file hasn't
changed the next time it is saved over.
a string containing the new contents for file
the old [entity-tag][gfile-etag] for the document, or %NULL
%TRUE if a backup should be created
a set of #GFileCreateFlags
optional #GCancellable object, %NULL to ignore
Starts an asynchronous replacement of file with the given
contents of length bytes. etag will replace the document's
current entity tag.
When this operation has completed, callback will be called with
user_user data, and the operation can be finalized with
g_file_replace_contents_finish().
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 make_backup is %TRUE, this function will attempt to
make a backup of file.
Note that no copy of contents will be made, so it must stay valid
until callback is called. See g_file_replace_contents_bytes_async()
for a #GBytes version that will automatically hold a reference to the
contents (without copying) for the duration of the call.
string of contents to replace the file with
a new [entity tag][gfile-etag] for the file, or %NULL
%TRUE if a backup should be created
a set of #GFileCreateFlags
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied
Same as g_file_replace_contents_async() but takes a #GBytes input instead.
This function will keep a ref on contents until the operation is done.
Unlike g_file_replace_contents_async() this allows forgetting about the
content without waiting for the callback.
When this operation has completed, callback will be called with
user_user data, and the operation can be finalized with
g_file_replace_contents_finish().
a #GBytes
a new [entity tag][gfile-etag] for the file, or %NULL
%TRUE if a backup should be created
a set of #GFileCreateFlags
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied
Finishes an asynchronous replace of the given file. See
g_file_replace_contents_async(). Sets new_etag to the new entity
tag for the document, if present.
a #GAsyncResult
Finishes an asynchronous file replace operation started with g_file_replace_async().
a #GAsyncResult
Returns an output stream for overwriting the file in readwrite mode, possibly creating a backup copy of the file first. If the file doesn't exist, it will be created.
For details about the behaviour, see g_file_replace() which does the same thing but returns an output stream only.
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.
an optional [entity tag][gfile-etag] for the current #GFile, or #NULL to ignore
%TRUE if a backup should be created
a set of #GFileCreateFlags
optional #GCancellable object, %NULL to ignore
Asynchronously overwrites the file in read-write mode, replacing the contents, possibly creating a backup copy of the file first.
For more details, see g_file_replace_readwrite() which is the synchronous version of this call.
When the operation is finished, callback will be called.
You can then call g_file_replace_readwrite_finish() to get
the result of the operation.
an [entity tag][gfile-etag] for the current #GFile, or %NULL to ignore
%TRUE if a backup should be created
a set of #GFileCreateFlags
the [I/O priority][io-priority] of the request
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied
Finishes an asynchronous file replace operation started with g_file_replace_readwrite_async().
a #GAsyncResult
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
Sets an attribute in the file with attribute name attribute to value_p.
Some attributes can be unset by setting type to
%G_FILE_ATTRIBUTE_TYPE_INVALID and value_p to %NULL.
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.
a string containing the attribute's name
The type of the attribute
a pointer to the value (or the pointer itself if the type is a pointer type)
a set of #GFileQueryInfoFlags
optional #GCancellable object, %NULL to ignore
Sets attribute of type %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING to value.
If attribute is of a different type, this operation will fail,
returning %FALSE.
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.
a string containing the attribute's name
a string containing the attribute's new value
a #GFileQueryInfoFlags
optional #GCancellable object, %NULL to ignore
Sets attribute of type %G_FILE_ATTRIBUTE_TYPE_INT32 to value.
If attribute is of a different type, this operation will fail.
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.
a string containing the attribute's name
a #gint32 containing the attribute's new value
a #GFileQueryInfoFlags
optional #GCancellable object, %NULL to ignore
Sets attribute of type %G_FILE_ATTRIBUTE_TYPE_INT64 to value.
If attribute is of a different type, this operation will fail.
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.
a string containing the attribute's name
a #guint64 containing the attribute's new value
a #GFileQueryInfoFlags
optional #GCancellable object, %NULL to ignore
Sets attribute of type %G_FILE_ATTRIBUTE_TYPE_STRING to value.
If attribute is of a different type, this operation will fail.
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.
a string containing the attribute's name
a string containing the attribute's value
#GFileQueryInfoFlags
optional #GCancellable object, %NULL to ignore
Sets attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT32 to value.
If attribute is of a different type, this operation will fail.
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.
a string containing the attribute's name
a #guint32 containing the attribute's new value
a #GFileQueryInfoFlags
optional #GCancellable object, %NULL to ignore
Sets attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT64 to value.
If attribute is of a different type, this operation will fail.
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.
a string containing the attribute's name
a #guint64 containing the attribute's new value
a #GFileQueryInfoFlags
optional #GCancellable object, %NULL to ignore
Asynchronously sets the attributes of file with info.
For more details, see g_file_set_attributes_from_info(), which is the synchronous version of this call.
When the operation is finished, callback will be called.
You can then call g_file_set_attributes_finish() to get
the result of the operation.
a #GFileInfo
a #GFileQueryInfoFlags
the [I/O priority][io-priority] of the request
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback
Finishes setting an attribute started in g_file_set_attributes_async().
a #GAsyncResult
Tries to set all attributes in the #GFileInfo on the target values, not stopping on the first error.
If there is any error during this operation then error will
be set to the first error. Error on particular fields are flagged
by setting the "status" field in the attribute value to
%G_FILE_ATTRIBUTE_STATUS_ERROR_SETTING, which means you can
also detect further errors.
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.
a #GFileInfo
#GFileQueryInfoFlags
optional #GCancellable object, %NULL to ignore
Each object carries around a table of associations from strings to pointers. This function lets you set an association.
If the object already had an association with that name, the old association will be destroyed.
Internally, the key is converted to a #GQuark using g_quark_from_string().
This means a copy of key is kept permanently (even after object has been
finalized) — so it is recommended to only use a small, bounded set of values
for key in your program, to avoid the #GQuark storage growing unbounded.
name of the key
data to associate with that key
Renames file to the specified display name.
The display name is converted from UTF-8 to the correct encoding
for the target filesystem if possible and the file is renamed to this.
If you want to implement a rename operation in the user interface the edit name (%G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME) should be used as the initial value in the rename widget, and then the result after editing should be passed to g_file_set_display_name().
On success the resulting converted filename is returned.
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.
a string
optional #GCancellable object, %NULL to ignore
Asynchronously sets the display name for a given #GFile.
For more details, see g_file_set_display_name() which is the synchronous version of this call.
When the operation is finished, callback will be called.
You can then call g_file_set_display_name_finish() to get
the result of the operation.
a string
the [I/O priority][io-priority] of the request
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied
Finishes setting a display name started with g_file_set_display_name_async().
a #GAsyncResult
Sets a property on an object.
the name of the property to set
the value
Starts a file of type %G_FILE_TYPE_MOUNTABLE.
Using start_operation, you can request callbacks when, for instance,
passwords are needed during authentication.
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.
When the operation is finished, callback will be called.
You can then call g_file_mount_mountable_finish() to get
the result of the operation.
flags affecting the operation
a #GMountOperation, or %NULL to avoid user interaction
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied, or %NULL
Finishes a start operation. See g_file_start_mountable() for details.
Finish an asynchronous start operation that was started with g_file_start_mountable().
a #GAsyncResult
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
name of the key
This function gets back user data pointers stored via
g_object_set_qdata() and removes the data from object
without invoking its destroy() function (if any was
set).
Usually, calling this function is only required to update
user data pointers with a destroy notifier, for example:
void
object_add_to_user_list (GObject *object,
const gchar *new_string)
{
// the quark, naming the object data
GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
// retrieve the old string list
GList *list = g_object_steal_qdata (object, quark_string_list);
// prepend new string
list = g_list_prepend (list, g_strdup (new_string));
// this changed 'list', so we need to set it again
g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
}
static void
free_string_list (gpointer data)
{
GList *node, *list = data;
for (node = list; node; node = node->next)
g_free (node->data);
g_list_free (list);
}
Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().
A #GQuark, naming the user data pointer
Stops a file of type %G_FILE_TYPE_MOUNTABLE.
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.
When the operation is finished, callback will be called.
You can then call g_file_stop_mountable_finish() to get
the result of the operation.
flags affecting the operation
a #GMountOperation, or %NULL to avoid user interaction.
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied, or %NULL
Finishes a stop operation, see g_file_stop_mountable() for details.
Finish an asynchronous stop operation that was started with g_file_stop_mountable().
a #GAsyncResult
Checks if file supports
[thread-default contexts][g-main-context-push-thread-default-context].
If this returns %FALSE, you cannot perform asynchronous operations on
file in a thread that has a thread-default context.
Reverts the effect of a previous call to
g_object_freeze_notify(). The freeze count is decreased on object
and when it reaches zero, queued "notify" signals are emitted.
Duplicate notifications for each property are squashed so that at most one #GObject::notify signal is emitted for each property, in the reverse order in which they have been queued.
It is an error to call this function when the freeze count is zero.
Sends file to the "Trashcan", if possible. This is similar to
deleting it, but the user can recover it before emptying the trashcan.
Not all file systems support trashing, so this call can return the
%G_IO_ERROR_NOT_SUPPORTED error. Since GLib 2.66, the x-gvfs-notrash unix
mount option can be used to disable g_file_trash() support for certain
mounts, the %G_IO_ERROR_NOT_SUPPORTED error will be returned in that case.
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.
optional #GCancellable object, %NULL to ignore
Asynchronously sends file to the Trash location, if possible.
the [I/O priority][io-priority] of the request
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied
Finishes an asynchronous file trashing operation, started with g_file_trash_async().
a #GAsyncResult
Unmounts a file of type G_FILE_TYPE_MOUNTABLE.
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.
When the operation is finished, callback will be called.
You can then call g_file_unmount_mountable_finish() to get
the result of the operation.
flags affecting the operation
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied, or %NULL
Finishes an unmount operation, see g_file_unmount_mountable() for details.
Finish an asynchronous unmount operation that was started with g_file_unmount_mountable().
a #GAsyncResult
Unmounts a file of type %G_FILE_TYPE_MOUNTABLE.
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.
When the operation is finished, callback will be called.
You can then call g_file_unmount_mountable_finish() to get
the result of the operation.
flags affecting the operation
a #GMountOperation, or %NULL to avoid user interaction
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied, or %NULL
Finishes an unmount operation, see g_file_unmount_mountable_with_operation() for details.
Finish an asynchronous unmount operation that was started with g_file_unmount_mountable_with_operation().
a #GAsyncResult
Decreases the reference count of object. When its reference count
drops to 0, the object is finalized (i.e. its memory is freed).
If the pointer to the #GObject may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to %NULL rather than retain a dangling pointer to a potentially invalid #GObject instance. Use g_clear_object() for this.
Gets an output stream for appending data to the file. If the file doesn't already exist it is created.
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.
Some file systems don't allow all file names, and may return an %G_IO_ERROR_INVALID_FILENAME error. If the file is a directory the %G_IO_ERROR_IS_DIRECTORY error will be returned. Other errors are possible too, and depend on what kind of filesystem the file is on.
a set of #GFileCreateFlags
optional #GCancellable object, %NULL to ignore
Asynchronously opens file for appending.
For more details, see g_file_append_to() which is the synchronous version of this call.
When the operation is finished, callback will be called.
You can then call g_file_append_to_finish() to get the result
of the operation.
a set of #GFileCreateFlags
the [I/O priority][io-priority] of the request
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied
Finishes an asynchronous file append operation started with g_file_append_to_async().
#GAsyncResult
Copies the file source to the location specified by destination.
Can not handle recursive copies of directories.
If the flag %G_FILE_COPY_OVERWRITE is specified an already
existing destination file is overwritten.
If the flag %G_FILE_COPY_NOFOLLOW_SYMLINKS is specified then symlinks
will be copied as symlinks, otherwise the target of the
source symlink will be copied.
If the flag %G_FILE_COPY_ALL_METADATA is specified then all the metadata that is possible to copy is copied, not just the default subset (which, for instance, does not include the owner, see #GFileInfo).
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 #GFileProgressCallback 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 source file does not exist, then the %G_IO_ERROR_NOT_FOUND error
is returned, independent on the status of the destination.
If %G_FILE_COPY_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 %G_FILE_COPY_OVERWRITE is specified and the target is a file, then the %G_IO_ERROR_WOULD_RECURSE error is returned.
If you are interested in copying the #GFile object itself (not the on-disk file), see g_file_dup().
destination #GFile
set of #GFileCopyFlags
optional #GCancellable object, %NULL to ignore
function to callback with progress information, or %NULL if progress information is not needed
Copies the file source to the location specified by destination
asynchronously. For details of the behaviour, see g_file_copy().
If progress_callback is not %NULL, then that function that will be called
just like in g_file_copy(). The callback will run in the default main context
of the thread calling g_file_copy_async() — the same context as callback is
run in.
When the operation is finished, callback will be called. You can then call
g_file_copy_finish() to get the result of the operation.
destination #GFile
set of #GFileCopyFlags
the [I/O priority][io-priority] of the request
optional #GCancellable object, %NULL to ignore
Finishes copying the file started with g_file_copy_async().
a #GAsyncResult
Creates a new file and returns an output stream for 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 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.
a set of #GFileCreateFlags
optional #GCancellable object, %NULL to ignore
Asynchronously creates a new file and returns an output stream for writing to it. The file must not already exist.
For more details, see g_file_create() which is the synchronous version of this call.
When the operation is finished, callback will be called.
You can then call g_file_create_finish() to get the result
of the operation.
a set of #GFileCreateFlags
the [I/O priority][io-priority] of the request
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied
Finishes an asynchronous file create operation started with g_file_create_async().
a #GAsyncResult
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.
a set of #GFileCreateFlags
optional #GCancellable object, %NULL to ignore
Asynchronously creates a new file and returns a stream for reading and writing to it. The file must not already exist.
For more details, see g_file_create_readwrite() which is the synchronous version of this call.
When the operation is finished, callback will be called.
You can then call g_file_create_readwrite_finish() to get
the result of the operation.
a set of #GFileCreateFlags
the [I/O priority][io-priority] of the request
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied
Finishes an asynchronous file create operation started with g_file_create_readwrite_async().
a #GAsyncResult
Deletes a file. If the file is a directory, it will only be
deleted if it is empty. This has the same semantics as g_unlink().
If file doesn’t exist, %G_IO_ERROR_NOT_FOUND will be returned. This allows
for deletion to be implemented avoiding
time-of-check to time-of-use races:
|[
g_autoptr(GError) local_error = NULL;
if (!g_file_delete (my_file, my_cancellable, &local_error) &&
!g_error_matches (local_error, G_IO_ERROR, G_IO_ERROR_NOT_FOUND))
{
// deletion failed for some reason other than the file not existing:
// so report the error
g_warning ("Failed to delete %s: %s",
g_file_peek_path (my_file), local_error->message);
}
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.
@virtual
@param cancellable optional #GCancellable object, %NULL to ignore
Asynchronously delete a file. If the file is a directory, it will
only be deleted if it is empty. This has the same semantics as
g_unlink().
the [I/O priority][io-priority] of the request
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied
Finishes deleting a file started with g_file_delete_async().
a #GAsyncResult
Duplicates a #GFile handle. This operation does not duplicate the actual file or directory represented by the #GFile; see g_file_copy() if attempting to copy a file.
g_file_dup() is useful when a second handle is needed to the same underlying file, for use in a separate thread (#GFile is not thread-safe). For use within the same thread, use g_object_ref() to increment the existing object’s reference count.
This call does no blocking I/O.
Starts an asynchronous eject on a mountable.
When this operation has completed, callback will be called with
user_user data, and the operation can be finalized with
g_file_eject_mountable_finish().
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.
flags affecting the operation
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied, or %NULL
Finishes an asynchronous eject operation started by g_file_eject_mountable().
a #GAsyncResult
Starts an asynchronous eject on a mountable.
When this operation has completed, callback will be called with
user_user data, and the operation can be finalized with
g_file_eject_mountable_with_operation_finish().
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.
flags affecting the operation
a #GMountOperation, or %NULL to avoid user interaction
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied, or %NULL
Finishes an asynchronous eject operation started by g_file_eject_mountable_with_operation().
a #GAsyncResult
Gets the requested information about the files in a directory. The result is a #GFileEnumerator object that will give out #GFileInfo objects for all the files in the directory.
The attributes value is a string that specifies the file
attributes that should be gathered. It is not an error if
it's not possible to read a particular requested attribute
from a file - it just won't be set. attributes should
be a comma-separated list of attributes or attribute wildcards.
The wildcard "" means all attributes, and a wildcard like
"standard::" means all attributes in the standard namespace.
An example attribute query be "standard::*,owner::user".
The standard attributes are available as defines, like
%G_FILE_ATTRIBUTE_STANDARD_NAME. %G_FILE_ATTRIBUTE_STANDARD_NAME should
always be specified if you plan to call g_file_enumerator_get_child() or
g_file_enumerator_iterate() on the returned enumerator.
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 the file does not exist, the %G_IO_ERROR_NOT_FOUND error will be returned. If the file is not a directory, the %G_IO_ERROR_NOT_DIRECTORY error will be returned. Other errors are possible too.
an attribute query string
a set of #GFileQueryInfoFlags
optional #GCancellable object, %NULL to ignore
Asynchronously gets the requested information about the files in a directory. The result is a #GFileEnumerator object that will give out #GFileInfo objects for all the files in the directory.
For more details, see g_file_enumerate_children() which is the synchronous version of this call.
When the operation is finished, callback will be called. You can
then call g_file_enumerate_children_finish() to get the result of
the operation.
an attribute query string
a set of #GFileQueryInfoFlags
the [I/O priority][io-priority] of the request
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied
Finishes an async enumerate children operation. See g_file_enumerate_children_async().
a #GAsyncResult
Gets a #GMount for the #GFile.
#GMount is returned only for user interesting locations, see
#GVolumeMonitor. If the #GFileIface for file does not have a #mount,
error will be set to %G_IO_ERROR_NOT_FOUND and %NULL #will be returned.
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.
optional #GCancellable object, %NULL to ignore
Asynchronously gets the mount for the file.
For more details, see g_file_find_enclosing_mount() which is the synchronous version of this call.
When the operation is finished, callback will be called.
You can then call g_file_find_enclosing_mount_finish() to
get the result of the operation.
the [I/O priority][io-priority] of the request
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied
Finishes an asynchronous find mount request. See g_file_find_enclosing_mount_async().
a #GAsyncResult
Gets the base name (the last component of the path) for a given #GFile.
If called for the top level of a system (such as the filesystem root or a uri like sftp://host/) it will return a single directory separator (and on Windows, possibly a drive letter).
The base name is a byte string (not UTF-8). It has no defined encoding or rules other than it may not contain zero bytes. If you want to use filenames in a user interface you should use the display name that you can get by requesting the %G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME attribute with g_file_query_info().
This call does no blocking I/O.
Gets the child of file for a given display_name (i.e. a UTF-8
version of the name). If this function fails, it returns %NULL
and error will be set. This is very useful when constructing a
#GFile for a new file and the user entered the filename in the
user interface, for instance when you select a directory and
type a filename in the file selector.
This call does no blocking I/O.
string to a possible child
Gets the parse name of the file.
A parse name is a UTF-8 string that describes the
file such that one can get the #GFile back using
g_file_parse_name().
This is generally used to show the #GFile as a nice full-pathname kind of string in a user interface, like in a location entry.
For local files with names that can safely be converted to UTF-8 the pathname is used, otherwise the IRI is used (a form of URI that allows UTF-8 characters unescaped).
This call does no blocking I/O.
Gets the local pathname for #GFile, if one exists. If non-%NULL, this is guaranteed to be an absolute, canonical path. It might contain symlinks.
This call does no blocking I/O.
Gets the URI for the file.
This call does no blocking I/O.
Gets the URI scheme for a #GFile. RFC 3986 decodes the scheme as: |[ URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] ```
Common schemes include "file", "http", "ftp", etc.
The scheme can be different from the one used to construct the #GFile, in that it might be replaced with one that is logically equivalent to the #GFile.
This call does no blocking I/O. @virtual
Checks to see if a #GFile has a given URI scheme.
This call does no blocking I/O.
a string containing a URI scheme
Creates a hash value for a #GFile.
This call does no blocking I/O.
Checks to see if a file is native to the platform.
A native file is one expressed in the platform-native filename format, e.g. "C:\Windows" or "/usr/bin/". This does not mean the file is local, as it might be on a locally mounted remote filesystem.
On some systems non-native files may be available using the native filesystem via a userspace filesystem (FUSE), in these cases this call will return %FALSE, but g_file_get_path() will still return a native path.
This call does no blocking I/O.
Creates a directory. Note that this will only create a child directory
of the immediate parent directory of the path or URI given by the #GFile.
To recursively create directories, see g_file_make_directory_with_parents().
This function will fail if the parent directory does not exist, setting
error to %G_IO_ERROR_NOT_FOUND. If the file system doesn't support
creating directories, this function will fail, setting error to
%G_IO_ERROR_NOT_SUPPORTED.
For a local #GFile the newly created directory will have the default (current) ownership and permissions of the current process.
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.
optional #GCancellable object, %NULL to ignore
Asynchronously creates a directory.
the [I/O priority][io-priority] of the request
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied
Finishes an asynchronous directory creation, started with g_file_make_directory_async().
a #GAsyncResult
Creates a symbolic link named file which contains the string
symlink_value.
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.
a string with the path for the target of the new symlink
optional #GCancellable object, %NULL to ignore
Collects the results from an earlier call to g_file_measure_disk_usage_async(). See g_file_measure_disk_usage() for more information.
the #GAsyncResult passed to your #GAsyncReadyCallback
Obtains a directory monitor for the given file. This may fail if directory monitoring is not supported.
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.
It does not make sense for flags to contain
%G_FILE_MONITOR_WATCH_HARD_LINKS, since hard links can not be made to
directories. It is not possible to monitor all the files in a
directory for changes made via hard links; if you want to do this then
you must register individual watches with g_file_monitor().
a set of #GFileMonitorFlags
optional #GCancellable object, %NULL to ignore
Obtains a file monitor for the given file. If no file notification mechanism exists, then regular polling of the file is used.
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 flags contains %G_FILE_MONITOR_WATCH_HARD_LINKS then the monitor
will also attempt to report changes made to the file via another
filename (ie, a hard link). Without this flag, you can only rely on
changes made through the filename contained in file to be
reported. Using this flag may result in an increase in resource
usage, and may not have any effect depending on the #GFileMonitor
backend and/or filesystem type.
a set of #GFileMonitorFlags
optional #GCancellable object, %NULL to ignore
Starts a mount_operation, mounting the volume that contains
the file location.
When this operation has completed, callback will be called with
user_user data, and the operation can be finalized with
g_file_mount_enclosing_volume_finish().
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.
flags affecting the operation
a #GMountOperation or %NULL to avoid user interaction
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied, or %NULL
Finishes a mount operation started by g_file_mount_enclosing_volume().
a #GAsyncResult
Mounts a file of type G_FILE_TYPE_MOUNTABLE.
Using mount_operation, you can request callbacks when, for instance,
passwords are needed during authentication.
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.
When the operation is finished, callback will be called.
You can then call g_file_mount_mountable_finish() to get
the result of the operation.
flags affecting the operation
a #GMountOperation, or %NULL to avoid user interaction
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied, or %NULL
Finishes a mount operation. See g_file_mount_mountable() for details.
Finish an asynchronous mount operation that was started with g_file_mount_mountable().
a #GAsyncResult
Tries to move the file or directory source 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 %G_FILE_COPY_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 #GFileProgressCallback 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 source file does not exist, then the %G_IO_ERROR_NOT_FOUND
error is returned, independent on the status of the destination.
If %G_FILE_COPY_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 %G_FILE_COPY_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).
#GFile pointing to the destination location
set of #GFileCopyFlags
optional #GCancellable object, %NULL to ignore
#GFileProgressCallback function for updates
Asynchronously moves a file source to the location of destination. For details of the behaviour, see g_file_move().
If progress_callback is not %NULL, then that function that will be called
just like in g_file_move(). The callback will run in the default main context
of the thread calling g_file_move_async() — the same context as callback is
run in.
When the operation is finished, callback will be called. You can then call
g_file_move_finish() to get the result of the operation.
#GFile pointing to the destination location
set of #GFileCopyFlags
the [I/O priority][io-priority] of the request
optional #GCancellable object, %NULL to ignore
#GFileProgressCallback function for updates
a #GAsyncReadyCallback to call when the request is satisfied
Finishes an asynchronous file movement, started with g_file_move_async().
a #GAsyncResult
Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.
Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.
Opens an existing file for reading and writing. The result is a #GFileIOStream that can be used to read and write the contents of the file.
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 the file does not exist, the %G_IO_ERROR_NOT_FOUND error will be returned. If the file is a directory, the %G_IO_ERROR_IS_DIRECTORY error 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.
a #GCancellable
Asynchronously opens file for reading and writing.
For more details, see g_file_open_readwrite() which is the synchronous version of this call.
When the operation is finished, callback will be called.
You can then call g_file_open_readwrite_finish() to get
the result of the operation.
the [I/O priority][io-priority] of the request
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied
Finishes an asynchronous file read operation started with g_file_open_readwrite_async().
a #GAsyncResult
Polls a file of type %G_FILE_TYPE_MOUNTABLE.
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.
When the operation is finished, callback will be called.
You can then call g_file_mount_mountable_finish() to get
the result of the operation.
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied, or %NULL
Finishes a poll operation. See g_file_poll_mountable() for details.
Finish an asynchronous poll operation that was polled with g_file_poll_mountable().
a #GAsyncResult
Checks whether file has the prefix specified by prefix.
In other words, if the names of initial elements of file's
pathname match prefix. Only full pathname elements are matched,
so a path like /foo is not considered a prefix of /foobar, only
of /foo/bar.
A #GFile is not a prefix of itself. If you want to check for equality, use g_file_equal().
This call does no I/O, as it works purely on names. As such it can
sometimes return %FALSE even if file is inside a prefix (from a
filesystem point of view), because the prefix of file is an alias
of prefix.
Similar to g_file_query_info(), but obtains information
about the filesystem the file is on, rather than the file itself.
For instance the amount of space available and the type of
the filesystem.
The attributes value is a string that specifies the attributes
that should be gathered. It is not an error if it's not possible
to read a particular requested attribute from a file - it just
won't be set. attributes should be a comma-separated list of
attributes or attribute wildcards. The wildcard "" means all
attributes, and a wildcard like "filesystem::" means all attributes
in the filesystem namespace. The standard namespace for filesystem
attributes is "filesystem". Common attributes of interest are
%G_FILE_ATTRIBUTE_FILESYSTEM_SIZE (the total size of the filesystem
in bytes), %G_FILE_ATTRIBUTE_FILESYSTEM_FREE (number of bytes available),
and %G_FILE_ATTRIBUTE_FILESYSTEM_TYPE (type of the 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 the file does not exist, the %G_IO_ERROR_NOT_FOUND error will be returned. Other errors are possible too, and depend on what kind of filesystem the file is on.
an attribute query string
optional #GCancellable object, %NULL to ignore
Asynchronously gets the requested information about the filesystem
that the specified file is on. The result is a #GFileInfo object
that contains key-value attributes (such as type or size for the
file).
For more details, see g_file_query_filesystem_info() which is the synchronous version of this call.
When the operation is finished, callback will be called. You can
then call g_file_query_info_finish() to get the result of the
operation.
an attribute query string
the [I/O priority][io-priority] of the request
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied
Finishes an asynchronous filesystem info query. See g_file_query_filesystem_info_async().
a #GAsyncResult
Gets the requested information about specified file.
The result is a #GFileInfo object that contains key-value
attributes (such as the type or size of the file).
The attributes value is a string that specifies the file
attributes that should be gathered. It is not an error if
it's not possible to read a particular requested attribute
from a file - it just won't be set. attributes should be a
comma-separated list of attributes or attribute wildcards.
The wildcard "" means all attributes, and a wildcard like
"standard::" means all attributes in the standard namespace.
An example attribute query be "standard::*,owner::user".
The standard attributes are available as defines, like
%G_FILE_ATTRIBUTE_STANDARD_NAME.
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.
For symlinks, normally the information about the target of the
symlink is returned, rather than information about the symlink
itself. However if you pass %G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS
in flags the information about the symlink itself will be returned.
Also, for symlinks that point to non-existing files the information
about the symlink itself will be returned.
If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will be returned. Other errors are possible too, and depend on what kind of filesystem the file is on.
an attribute query string
a set of #GFileQueryInfoFlags
optional #GCancellable object, %NULL to ignore
Asynchronously gets the requested information about specified file.
The result is a #GFileInfo object that contains key-value attributes
(such as type or size for the file).
For more details, see g_file_query_info() which is the synchronous version of this call.
When the operation is finished, callback will be called. You can
then call g_file_query_info_finish() to get the result of the operation.
an attribute query string
a set of #GFileQueryInfoFlags
the [I/O priority][io-priority] of the request
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied
Finishes an asynchronous file info query. See g_file_query_info_async().
a #GAsyncResult
Obtain the list of settable attributes for the file.
Returns the type and full attribute name of all the attributes that can be set on this file. This doesn't mean setting it will always succeed though, you might get an access failure, or some specific file may not support a specific attribute.
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.
optional #GCancellable object, %NULL to ignore
Obtain the list of attribute namespaces where new attributes can be created by a user. An example of this is extended attributes (in the "xattr" namespace).
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.
optional #GCancellable object, %NULL to ignore
Asynchronously opens file for reading.
For more details, see g_file_read() which is the synchronous version of this call.
When the operation is finished, callback will be called.
You can then call g_file_read_finish() to get the result
of the operation.
the [I/O priority][io-priority] of the request
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied
Finishes an asynchronous file read operation started with g_file_read_async().
a #GAsyncResult
Opens a file for reading. The result is a #GFileInputStream that can be used to read the contents of the file.
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 the file does not exist, the %G_IO_ERROR_NOT_FOUND error will be returned. If the file is a directory, the %G_IO_ERROR_IS_DIRECTORY error will be returned. Other errors are possible too, and depend on what kind of filesystem the file is on.
a #GCancellable
Returns an output stream for overwriting the file, possibly creating a backup copy of the file first. If the file doesn't exist, it will be created.
This will try to replace the file in the safest way possible so that any errors during the writing will not affect an already existing copy of the file. For instance, for local files it may write to a temporary file and then atomically rename over the destination when the stream is closed.
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 you pass in a non-%NULL etag value and file already exists, then
this value is compared to the current entity tag of the file, and if
they differ an %G_IO_ERROR_WRONG_ETAG error is returned. This
generally means that the file has been changed since you last read
it. You can get the new etag from g_file_output_stream_get_etag()
after you've finished writing and closed the #GFileOutputStream. When
you load a new file you can use g_file_input_stream_query_info() to
get the etag of the file.
If make_backup is %TRUE, this function will attempt to make a
backup of the current file before overwriting it. If this fails
a %G_IO_ERROR_CANT_CREATE_BACKUP error will be returned. If you
want to replace anyway, try again with make_backup set to %FALSE.
If the file is a directory the %G_IO_ERROR_IS_DIRECTORY error will be returned, and if the file is some other form of non-regular file then a %G_IO_ERROR_NOT_REGULAR_FILE 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.
an optional [entity tag][gfile-etag] for the current #GFile, or #NULL to ignore
%TRUE if a backup should be created
a set of #GFileCreateFlags
optional #GCancellable object, %NULL to ignore
Asynchronously overwrites the file, replacing the contents, possibly creating a backup copy of the file first.
For more details, see g_file_replace() which is the synchronous version of this call.
When the operation is finished, callback will be called.
You can then call g_file_replace_finish() to get the result
of the operation.
an [entity tag][gfile-etag] for the current #GFile, or %NULL to ignore
%TRUE if a backup should be created
a set of #GFileCreateFlags
the [I/O priority][io-priority] of the request
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied
Finishes an asynchronous file replace operation started with g_file_replace_async().
a #GAsyncResult
Returns an output stream for overwriting the file in readwrite mode, possibly creating a backup copy of the file first. If the file doesn't exist, it will be created.
For details about the behaviour, see g_file_replace() which does the same thing but returns an output stream only.
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.
an optional [entity tag][gfile-etag] for the current #GFile, or #NULL to ignore
%TRUE if a backup should be created
a set of #GFileCreateFlags
optional #GCancellable object, %NULL to ignore
Asynchronously overwrites the file in read-write mode, replacing the contents, possibly creating a backup copy of the file first.
For more details, see g_file_replace_readwrite() which is the synchronous version of this call.
When the operation is finished, callback will be called.
You can then call g_file_replace_readwrite_finish() to get
the result of the operation.
an [entity tag][gfile-etag] for the current #GFile, or %NULL to ignore
%TRUE if a backup should be created
a set of #GFileCreateFlags
the [I/O priority][io-priority] of the request
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied
Finishes an asynchronous file replace operation started with g_file_replace_readwrite_async().
a #GAsyncResult
Sets an attribute in the file with attribute name attribute to value_p.
Some attributes can be unset by setting type to
%G_FILE_ATTRIBUTE_TYPE_INVALID and value_p to %NULL.
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.
a string containing the attribute's name
The type of the attribute
a pointer to the value (or the pointer itself if the type is a pointer type)
a set of #GFileQueryInfoFlags
optional #GCancellable object, %NULL to ignore
Asynchronously sets the attributes of file with info.
For more details, see g_file_set_attributes_from_info(), which is the synchronous version of this call.
When the operation is finished, callback will be called.
You can then call g_file_set_attributes_finish() to get
the result of the operation.
a #GFileInfo
a #GFileQueryInfoFlags
the [I/O priority][io-priority] of the request
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback
Finishes setting an attribute started in g_file_set_attributes_async().
a #GAsyncResult
Tries to set all attributes in the #GFileInfo on the target values, not stopping on the first error.
If there is any error during this operation then error will
be set to the first error. Error on particular fields are flagged
by setting the "status" field in the attribute value to
%G_FILE_ATTRIBUTE_STATUS_ERROR_SETTING, which means you can
also detect further errors.
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.
a #GFileInfo
#GFileQueryInfoFlags
optional #GCancellable object, %NULL to ignore
Renames file to the specified display name.
The display name is converted from UTF-8 to the correct encoding
for the target filesystem if possible and the file is renamed to this.
If you want to implement a rename operation in the user interface the edit name (%G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME) should be used as the initial value in the rename widget, and then the result after editing should be passed to g_file_set_display_name().
On success the resulting converted filename is returned.
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.
a string
optional #GCancellable object, %NULL to ignore
Asynchronously sets the display name for a given #GFile.
For more details, see g_file_set_display_name() which is the synchronous version of this call.
When the operation is finished, callback will be called.
You can then call g_file_set_display_name_finish() to get
the result of the operation.
a string
the [I/O priority][io-priority] of the request
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied
Finishes setting a display name started with g_file_set_display_name_async().
a #GAsyncResult
Starts a file of type %G_FILE_TYPE_MOUNTABLE.
Using start_operation, you can request callbacks when, for instance,
passwords are needed during authentication.
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.
When the operation is finished, callback will be called.
You can then call g_file_mount_mountable_finish() to get
the result of the operation.
flags affecting the operation
a #GMountOperation, or %NULL to avoid user interaction
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied, or %NULL
Finishes a start operation. See g_file_start_mountable() for details.
Finish an asynchronous start operation that was started with g_file_start_mountable().
a #GAsyncResult
Stops a file of type %G_FILE_TYPE_MOUNTABLE.
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.
When the operation is finished, callback will be called.
You can then call g_file_stop_mountable_finish() to get
the result of the operation.
flags affecting the operation
a #GMountOperation, or %NULL to avoid user interaction.
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied, or %NULL
Finishes a stop operation, see g_file_stop_mountable() for details.
Finish an asynchronous stop operation that was started with g_file_stop_mountable().
a #GAsyncResult
Sends file to the "Trashcan", if possible. This is similar to
deleting it, but the user can recover it before emptying the trashcan.
Not all file systems support trashing, so this call can return the
%G_IO_ERROR_NOT_SUPPORTED error. Since GLib 2.66, the x-gvfs-notrash unix
mount option can be used to disable g_file_trash() support for certain
mounts, the %G_IO_ERROR_NOT_SUPPORTED error will be returned in that case.
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.
optional #GCancellable object, %NULL to ignore
Asynchronously sends file to the Trash location, if possible.
the [I/O priority][io-priority] of the request
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied
Finishes an asynchronous file trashing operation, started with g_file_trash_async().
a #GAsyncResult
Unmounts a file of type G_FILE_TYPE_MOUNTABLE.
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.
When the operation is finished, callback will be called.
You can then call g_file_unmount_mountable_finish() to get
the result of the operation.
flags affecting the operation
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied, or %NULL
Finishes an unmount operation, see g_file_unmount_mountable() for details.
Finish an asynchronous unmount operation that was started with g_file_unmount_mountable().
a #GAsyncResult
Unmounts a file of type %G_FILE_TYPE_MOUNTABLE.
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.
When the operation is finished, callback will be called.
You can then call g_file_unmount_mountable_finish() to get
the result of the operation.
flags affecting the operation
a #GMountOperation, or %NULL to avoid user interaction
optional #GCancellable object, %NULL to ignore
a #GAsyncReadyCallback to call when the request is satisfied, or %NULL
Finishes an unmount operation, see g_file_unmount_mountable_with_operation() for details.
Finish an asynchronous unmount operation that was started with g_file_unmount_mountable_with_operation().
a #GAsyncResult
This function essentially limits the life time of the closure to
the life time of the object. That is, when the object is finalized,
the closure is invalidated by calling g_closure_invalidate() on
it, in order to prevent invocations of the closure with a finalized
(nonexisting) object. Also, g_object_ref() and g_object_unref() are
added as marshal guards to the closure, to ensure that an extra
reference count is held on object during invocation of the
closure. Usually, this function will be called on closures that
use this object as closure data.
#GClosure to watch
Find the #GParamSpec with the given name for an
interface. Generally, the interface vtable passed in as g_iface
will be the default vtable from g_type_default_interface_ref(), or,
if you know the interface has already been loaded,
g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
name of a property to look up.
Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created #GParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.
This function is meant to be called from the interface's default
vtable initialization function (the class_init member of
#GTypeInfo.) It must not be called after after class_init has
been called for any object types implementing this interface.
If pspec is a floating reference, it will be consumed.
any interface vtable for the interface, or the default vtable for the interface.
the #GParamSpec for the new property
Lists the properties of an interface.Generally, the interface
vtable passed in as g_iface will be the default vtable from
g_type_default_interface_ref(), or, if you know the interface has
already been loaded, g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
Creates a #GFile with the given argument from the command line.
The value of arg can be either a URI, an absolute path or a
relative path resolved relative to the current working directory.
This operation never fails, but the returned object might not
support any I/O operation if arg points to a malformed path.
Note that on Windows, this function expects its argument to be in UTF-8 -- not the system code page. This means that you should not use this function with string from argv as it is passed to main(). g_win32_get_command_line() will return a UTF-8 version of the commandline. #GApplication also uses UTF-8 but g_application_command_line_create_file_for_arg() may be more useful for you there. It is also always possible to use this function with #GOptionContext arguments of type %G_OPTION_ARG_FILENAME.
a command line string
Creates a #GFile with the given argument from the command line.
This function is similar to g_file_new_for_commandline_arg() except that it allows for passing the current working directory as an argument instead of using the current working directory of the process.
This is useful if the commandline argument was given in a context other than the invocation of the current process.
See also g_application_command_line_create_file_for_arg().
a command line string
the current working directory of the commandline
Opens a file in the preferred directory for temporary files (as returned by g_get_tmp_dir()) and returns a #GFile and #GFileIOStream pointing to it.
tmpl should be a string in the GLib file name encoding
containing a sequence of six 'X' characters, and containing no
directory components. If it is %NULL, a default template is used.
Unlike the other #GFile constructors, this will return %NULL if a temporary file could not be created.
Template for the file name, as in g_file_open_tmp(), or %NULL for a default template
Creates a new instance of a #GObject subtype and sets its properties.
Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.
the type id of the #GObject subtype to instantiate
an array of #GParameter
#GFile is a high level abstraction for manipulating files on a virtual file system. #GFiles are lightweight, immutable objects that do no I/O upon creation. It is necessary to understand that #GFile objects do not represent files, merely an identifier for a file. All file content I/O is implemented as streaming operations (see #GInputStream and #GOutputStream).
To construct a #GFile, you can use:
One way to think of a #GFile is as an abstraction of a pathname. For normal files the system pathname is what is stored internally, but as #GFiles are extensible it could also be something else that corresponds to a pathname in a userspace implementation of a filesystem.
#GFiles make up hierarchies of directories and files that correspond to the files on a filesystem. You can move through the file system with #GFile using g_file_get_parent() to get an identifier for the parent directory, g_file_get_child() to get a child within a directory, g_file_resolve_relative_path() to resolve a relative path between two #GFiles. There can be multiple hierarchies, so you may not end up at the same root if you repeatedly call g_file_get_parent() on two different files.
All #GFiles have a basename (get with g_file_get_basename()). These names are byte strings that are used to identify the file on the filesystem (relative to its parent directory) and there is no guarantees that they have any particular charset encoding or even make any sense at all. If you want to use filenames in a user interface you should use the display name that you can get by requesting the %G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME attribute with g_file_query_info(). This is guaranteed to be in UTF-8 and can be used in a user interface. But always store the real basename or the #GFile to use to actually access the file, because there is no way to go from a display name to the actual name.
Using #GFile as an identifier has the same weaknesses as using a path in that there may be multiple aliases for the same file. For instance, hard or soft links may cause two different #GFiles to refer to the same file. Other possible causes for aliases are: case insensitive filesystems, short and long names on FAT/NTFS, or bind mounts in Linux. If you want to check if two #GFiles point to the same file you can query for the %G_FILE_ATTRIBUTE_ID_FILE attribute. Note that #GFile does some trivial canonicalization of pathnames passed in, so that trivial differences in the path string used at creation (duplicated slashes, slash at end of path, "." or ".." path segments, etc) does not create different #GFiles.
Many #GFile operations have both synchronous and asynchronous versions to suit your application. Asynchronous versions of synchronous functions simply have _async() appended to their function names. The asynchronous I/O functions call a #GAsyncReadyCallback which is then used to finalize the operation, producing a GAsyncResult which is then passed to the function's matching _finish() operation.
It is highly recommended to use asynchronous calls when running within a shared main loop, such as in the main thread of an application. This avoids I/O operations blocking other sources on the main loop from being dispatched. Synchronous I/O operations should be performed from worker threads. See the [introduction to asynchronous programming section][async-programming] for more.
Some #GFile operations almost always take a noticeable amount of time, and so do not have synchronous analogs. Notable cases include:
Entity Tags # {#gfile-etag}
One notable feature of #GFiles are entity tags, or "etags" for short. Entity tags are somewhat like a more abstract version of the traditional mtime, and can be used to quickly determine if the file has been modified from the version on the file system. See the HTTP 1.1 specification for HTTP Etag headers, which are a very similar concept.