![]() |
![]() |
![]() |
GIO Reference Manual | ![]() |
---|---|---|---|---|
GFile; GFileIface; enum GFileQueryInfoFlags; enum GFileCreateFlags; enum GFileCopyFlags; enum GFileMonitorFlags; void (*GFileProgressCallback) (goffset current_num_bytes, goffset total_num_bytes, gpointer user_data); gboolean (*GFileReadMoreCallback) (const char *file_contents, goffset file_size, gpointer callback_data); GFile* g_file_new_for_path (const char *path); GFile* g_file_new_for_uri (const char *uri); GFile* g_file_new_for_commandline_arg (const char *arg); GFile* g_file_parse_name (const char *parse_name); GFile* g_file_dup (GFile *file); guint g_file_hash (gconstpointer file); gboolean g_file_equal (GFile *file1, GFile *file2); char* g_file_get_basename (GFile *file); char* g_file_get_path (GFile *file); char* g_file_get_uri (GFile *file); char* g_file_get_parse_name (GFile *file); GFile* g_file_get_parent (GFile *file); GFile* g_file_get_child (GFile *file, const char *name); GFile* g_file_get_child_for_display_name (GFile *file, const char *display_name, GError **error); gboolean g_file_contains_file (GFile *parent, GFile *descendant); char* g_file_get_relative_path (GFile *parent, GFile *descendant); GFile* g_file_resolve_relative_path (GFile *file, const char *relative_path); gboolean g_file_is_native (GFile *file); gboolean g_file_has_uri_scheme (GFile *file, const char *uri_scheme); char* g_file_get_uri_scheme (GFile *file); GFileInputStream* g_file_read (GFile *file, GCancellable *cancellable, GError **error); void g_file_read_async (GFile *file, int io_priority, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data); GFileInputStream* g_file_read_finish (GFile *file, GAsyncResult *res, GError **error); GFileOutputStream* g_file_append_to (GFile *file, GFileCreateFlags flags, GCancellable *cancellable, GError **error); GFileOutputStream* g_file_create (GFile *file, GFileCreateFlags flags, GCancellable *cancellable, GError **error); GFileOutputStream* g_file_replace (GFile *file, const char *etag, gboolean make_backup, GFileCreateFlags flags, GCancellable *cancellable, GError **error); void g_file_append_to_async (GFile *file, GFileCreateFlags flags, int io_priority, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data); GFileOutputStream* g_file_append_to_finish (GFile *file, GAsyncResult *res, GError **error); void g_file_create_async (GFile *file, GFileCreateFlags flags, int io_priority, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data); GFileOutputStream* g_file_create_finish (GFile *file, GAsyncResult *res, GError **error); void g_file_replace_async (GFile *file, const char *etag, gboolean make_backup, GFileCreateFlags flags, int io_priority, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data); GFileOutputStream* g_file_replace_finish (GFile *file, GAsyncResult *res, GError **error); GFileInfo* g_file_query_info (GFile *file, const char *attributes, GFileQueryInfoFlags flags, GCancellable *cancellable, GError **error); void g_file_query_info_async (GFile *file, const char *attributes, GFileQueryInfoFlags flags, int io_priority, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data); GFileInfo* g_file_query_info_finish (GFile *file, GAsyncResult *res, GError **error); GFileInfo* g_file_query_filesystem_info (GFile *file, const char *attributes, GCancellable *cancellable, GError **error); GVolume* g_file_find_enclosing_volume (GFile *file, GCancellable *cancellable, GError **error); GFileEnumerator* g_file_enumerate_children (GFile *file, const char *attributes, GFileQueryInfoFlags flags, GCancellable *cancellable, GError **error); void g_file_enumerate_children_async (GFile *file, const char *attributes, GFileQueryInfoFlags flags, int io_priority, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data); GFileEnumerator* g_file_enumerate_children_finish (GFile *file, GAsyncResult *res, GError **error); GFile* g_file_set_display_name (GFile *file, const char *display_name, GCancellable *cancellable, GError **error); void g_file_set_display_name_async (GFile *file, const char *display_name, int io_priority, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data); GFile* g_file_set_display_name_finish (GFile *file, GAsyncResult *res, GError **error); gboolean g_file_delete (GFile *file, GCancellable *cancellable, GError **error); gboolean g_file_trash (GFile *file, GCancellable *cancellable, GError **error); gboolean g_file_copy (GFile *source, GFile *destination, GFileCopyFlags flags, GCancellable *cancellable, GFileProgressCallback progress_callback, gpointer progress_callback_data, GError **error); gboolean g_file_move (GFile *source, GFile *destination, GFileCopyFlags flags, GCancellable *cancellable, GFileProgressCallback progress_callback, gpointer progress_callback_data, GError **error); gboolean g_file_make_directory (GFile *file, GCancellable *cancellable, GError **error); gboolean g_file_make_symbolic_link (GFile *file, const char *symlink_value, GCancellable *cancellable, GError **error); GFileAttributeInfoList* g_file_query_settable_attributes (GFile *file, GCancellable *cancellable, GError **error); GFileAttributeInfoList* g_file_query_writable_namespaces (GFile *file, GCancellable *cancellable, GError **error); gboolean g_file_set_attribute (GFile *file, const char *attribute, const GFileAttributeValue *value, GFileQueryInfoFlags flags, GCancellable *cancellable, GError **error); gboolean g_file_set_attributes_from_info (GFile *file, GFileInfo *info, GFileQueryInfoFlags flags, GCancellable *cancellable, GError **error); void g_file_set_attributes_async (GFile *file, GFileInfo *info, GFileQueryInfoFlags flags, int io_priority, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data); gboolean g_file_set_attributes_finish (GFile *file, GAsyncResult *result, GFileInfo **info, GError **error); gboolean g_file_set_attribute_string (GFile *file, const char *attribute, const char *value, GFileQueryInfoFlags flags, GCancellable *cancellable, GError **error); gboolean g_file_set_attribute_byte_string (GFile *file, const char *attribute, const char *value, GFileQueryInfoFlags flags, GCancellable *cancellable, GError **error); gboolean g_file_set_attribute_uint32 (GFile *file, const char *attribute, guint32 value, GFileQueryInfoFlags flags, GCancellable *cancellable, GError **error); gboolean g_file_set_attribute_int32 (GFile *file, const char *attribute, gint32 value, GFileQueryInfoFlags flags, GCancellable *cancellable, GError **error); gboolean g_file_set_attribute_uint64 (GFile *file, const char *attribute, guint64 value, GFileQueryInfoFlags flags, GCancellable *cancellable, GError **error); gboolean g_file_set_attribute_int64 (GFile *file, const char *attribute, gint64 value, GFileQueryInfoFlags flags, GCancellable *cancellable, GError **error); void g_mount_for_location (GFile *location, GMountOperation *mount_operation, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data); gboolean g_mount_for_location_finish (GFile *location, GAsyncResult *result, GError **error); void g_file_mount_mountable (GFile *file, GMountOperation *mount_operation, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data); GFile* g_file_mount_mountable_finish (GFile *file, GAsyncResult *result, GError **error); void g_file_unmount_mountable (GFile *file, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data); gboolean g_file_unmount_mountable_finish (GFile *file, GAsyncResult *result, GError **error); void g_file_eject_mountable (GFile *file, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data); gboolean g_file_eject_mountable_finish (GFile *file, GAsyncResult *result, GError **error); GDirectoryMonitor* g_file_monitor_directory (GFile *file, GFileMonitorFlags flags, GCancellable *cancellable); GFileMonitor* g_file_monitor_file (GFile *file, GFileMonitorFlags flags, GCancellable *cancellable); gboolean g_file_load_contents (GFile *file, GCancellable *cancellable, char **contents, gsize *length, char **etag_out, GError **error); void g_file_load_contents_async (GFile *file, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data); gboolean g_file_load_contents_finish (GFile *file, GAsyncResult *res, char **contents, gsize *length, char **etag_out, GError **error); void g_file_load_partial_contents_async (GFile *file, GCancellable *cancellable, GFileReadMoreCallback read_more_callback, GAsyncReadyCallback callback, gpointer user_data); gboolean g_file_load_partial_contents_finish (GFile *file, GAsyncResult *res, char **contents, gsize *length, char **etag_out, GError **error); gboolean g_file_replace_contents (GFile *file, const char *contents, gsize length, const char *etag, gboolean make_backup, GFileCreateFlags flags, char **new_etag, GCancellable *cancellable, GError **error); void g_file_replace_contents_async (GFile *file, const char *contents, gsize length, const char *etag, gboolean make_backup, GFileCreateFlags flags, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data); gboolean g_file_replace_contents_finish (GFile *file, GAsyncResult *res, char **new_etag, GError **error);
typedef struct { GTypeInterface g_iface; /* Virtual Table */ GFile * (*dup) (GFile *file); guint (*hash) (GFile *file); gboolean (*equal) (GFile *file1, GFile *file2); gboolean (*is_native) (GFile *file); gboolean (*has_uri_scheme) (GFile *file, const char *uri_scheme); char * (*get_uri_scheme) (GFile *file); char * (*get_basename) (GFile *file); char * (*get_path) (GFile *file); char * (*get_uri) (GFile *file); char * (*get_parse_name) (GFile *file); GFile * (*get_parent) (GFile *file); gboolean (*contains_file) (GFile *parent, GFile *descendant); char * (*get_relative_path) (GFile *parent, GFile *descendant); GFile * (*resolve_relative_path) (GFile *file, const char *relative_path); GFile * (*get_child_for_display_name) (GFile *file, const char *display_name, GError **error); GFileEnumerator * (*enumerate_children) (GFile *file, const char *attributes, GFileQueryInfoFlags flags, GCancellable *cancellable, GError **error); void (*enumerate_children_async) (GFile *file, const char *attributes, GFileQueryInfoFlags flags, int io_priority, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data); GFileEnumerator * (*enumerate_children_finish) (GFile *file, GAsyncResult *res, GError **error); GFileInfo * (*query_info) (GFile *file, const char *attributes, GFileQueryInfoFlags flags, GCancellable *cancellable, GError **error); void (*query_info_async) (GFile *file, const char *attributes, GFileQueryInfoFlags flags, int io_priority, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data); GFileInfo * (*query_info_finish) (GFile *file, GAsyncResult *res, GError **error); GFileInfo * (*query_filesystem_info)(GFile *file, const char *attributes, GCancellable *cancellable, GError **error); void (*_query_filesystem_info_async) (void); void (*_query_filesystem_info_finish) (void); GVolume * (*find_enclosing_volume)(GFile *file, GCancellable *cancellable, GError **error); void (*find_enclosing_volume_async)(GFile *file, int io_priority, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data); GVolume * (*find_enclosing_volume_finish)(GFile *file, GAsyncResult *res, GError **error); GFile * (*set_display_name) (GFile *file, const char *display_name, GCancellable *cancellable, GError **error); void (*set_display_name_async) (GFile *file, const char *display_name, int io_priority, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data); GFile * (*set_display_name_finish) (GFile *file, GAsyncResult *res, GError **error); GFileAttributeInfoList * (*query_settable_attributes) (GFile *file, GCancellable *cancellable, GError **error); void (*_query_settable_attributes_async) (void); void (*_query_settable_attributes_finish) (void); GFileAttributeInfoList * (*query_writable_namespaces) (GFile *file, GCancellable *cancellable, GError **error); void (*_query_writable_namespaces_async) (void); void (*_query_writable_namespaces_finish) (void); gboolean (*set_attribute) (GFile *file, const char *attribute, const GFileAttributeValue *value, GFileQueryInfoFlags flags, GCancellable *cancellable, GError **error); gboolean (*set_attributes_from_info) (GFile *file, GFileInfo *info, GFileQueryInfoFlags flags, GCancellable *cancellable, GError **error); void (*set_attributes_async) (GFile *file, GFileInfo *info, GFileQueryInfoFlags flags, int io_priority, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data); gboolean (*set_attributes_finish) (GFile *file, GAsyncResult *result, GFileInfo **info, GError **error); GFileInputStream * (*read) (GFile *file, GCancellable *cancellable, GError **error); void (*read_async) (GFile *file, int io_priority, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data); GFileInputStream * (*read_finish) (GFile *file, GAsyncResult *res, GError **error); GFileOutputStream * (*append_to) (GFile *file, GFileCreateFlags flags, GCancellable *cancellable, GError **error); void (*append_to_async) (GFile *file, GFileCreateFlags flags, int io_priority, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data); GFileOutputStream * (*append_to_finish) (GFile *file, GAsyncResult *res, GError **error); GFileOutputStream * (*create) (GFile *file, GFileCreateFlags flags, GCancellable *cancellable, GError **error); void (*create_async) (GFile *file, GFileCreateFlags flags, int io_priority, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data); GFileOutputStream * (*create_finish) (GFile *file, GAsyncResult *res, GError **error); GFileOutputStream * (*replace) (GFile *file, const char *etag, gboolean make_backup, GFileCreateFlags flags, GCancellable *cancellable, GError **error); void (*replace_async) (GFile *file, const char *etag, gboolean make_backup, GFileCreateFlags flags, int io_priority, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data); GFileOutputStream * (*replace_finish) (GFile *file, GAsyncResult *res, GError **error); gboolean (*delete_file) (GFile *file, GCancellable *cancellable, GError **error); void (*_delete_file_async) (void); void (*_delete_file_finish) (void); gboolean (*trash) (GFile *file, GCancellable *cancellable, GError **error); void (*_trash_async) (void); void (*_trash_finish) (void); gboolean (*make_directory) (GFile *file, GCancellable *cancellable, GError **error); void (*_make_directory_async) (void); void (*_make_directory_finish) (void); gboolean (*make_symbolic_link) (GFile *file, const char *symlink_value, GCancellable *cancellable, GError **error); void (*_make_symbolic_link_async) (void); void (*_make_symbolic_link_finish) (void); gboolean (*copy) (GFile *source, GFile *destination, GFileCopyFlags flags, GCancellable *cancellable, GFileProgressCallback progress_callback, gpointer progress_callback_data, GError **error); void (*_copy_async) (void); void (*_copy_finish) (void); gboolean (*move) (GFile *source, GFile *destination, GFileCopyFlags flags, GCancellable *cancellable, GFileProgressCallback progress_callback, gpointer progress_callback_data, GError **error); void (*_move_async) (void); void (*_move_finish) (void); void (*mount_mountable) (GFile *file, GMountOperation *mount_operation, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data); GFile * (*mount_mountable_finish) (GFile *file, GAsyncResult *result, GError **error); void (*unmount_mountable) (GFile *file, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data); gboolean (*unmount_mountable_finish) (GFile *file, GAsyncResult *result, GError **error); void (*eject_mountable) (GFile *file, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data); gboolean (*eject_mountable_finish) (GFile *file, GAsyncResult *result, GError **error); void (*mount_for_location) (GFile *location, GMountOperation *mount_operation, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data); gboolean (*mount_for_location_finish) (GFile *location, GAsyncResult *result, GError **error); GDirectoryMonitor* (*monitor_dir) (GFile *file, GFileMonitorFlags flags, GCancellable *cancellable); GFileMonitor* (*monitor_file) (GFile *file, GFileMonitorFlags flags, GCancellable *cancellable); /* Padding for future expansion */ void (*_g_reserved1) (void); void (*_g_reserved2) (void); void (*_g_reserved3) (void); void (*_g_reserved4) (void); void (*_g_reserved5) (void); void (*_g_reserved6) (void); void (*_g_reserved7) (void); void (*_g_reserved8) (void); void (*_g_reserved9) (void); void (*_g_reserved10) (void); void (*_g_reserved11) (void); void (*_g_reserved12) (void); void (*_g_reserved13) (void); void (*_g_reserved14) (void); void (*_g_reserved15) (void); void (*_g_reserved16) (void); void (*_g_reserved17) (void); void (*_g_reserved18) (void); void (*_g_reserved19) (void); void (*_g_reserved20) (void); } GFileIface;
typedef enum { G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS = (1<<0) } GFileQueryInfoFlags;
typedef enum { G_FILE_CREATE_FLAGS_NONE = 0, G_FILE_CREATE_FLAGS_PRIVATE = (1<<0) } GFileCreateFlags;
typedef enum { G_FILE_COPY_OVERWRITE = (1<<0), G_FILE_COPY_BACKUP = (1<<1), G_FILE_COPY_NOFOLLOW_SYMLINKS = (1<<2), G_FILE_COPY_ALL_METADATA = (1<<3) } GFileCopyFlags;
typedef enum { G_FILE_MONITOR_FLAGS_NONE = 0, G_FILE_MONITOR_FLAGS_MONITOR_MOUNTS = (1<<0) } GFileMonitorFlags;
void (*GFileProgressCallback) (goffset current_num_bytes, goffset total_num_bytes, gpointer user_data);
|
|
|
|
|
gboolean (*GFileReadMoreCallback) (const char *file_contents, goffset file_size, gpointer callback_data);
|
|
|
|
|
|
Returns : |
GFile* g_file_new_for_path (const char *path);
Constructs a GFile for given path
. This operation never
fails, but the returned object might not support any I/O
operation if the path
is malformed.
|
a string containing a relative or absolute path. |
Returns : |
a new GFile for the given path .
|
GFile* g_file_new_for_uri (const char *uri);
This operation never fails, but the returned object
might not support any I/O operation if the uri
is malformed or if the uri type is not supported.
|
a string containing a URI. |
Returns : |
a GFile for the given uri .
|
GFile* g_file_new_for_commandline_arg (const char *arg);
Attempts to generate a GFile with the given line from the command line argument.
|
a command line string. |
Returns : |
a new GFile. |
GFile* g_file_parse_name (const char *parse_name);
Constructs a GFile with the given parse_name
,
looked up by GVfs. This operation never fails,
but the returned object might not support any I/O
operation if the parse_name
cannot be parsed by GVfs.
|
a file name or path to be parsed. |
Returns : |
a new GFile. |
GFile* g_file_get_child_for_display_name (GFile *file, const char *display_name, GError **error);
GFile* g_file_resolve_relative_path (GFile *file, const char *relative_path);
gboolean g_file_is_native (GFile *file);
|
input GFile. |
Returns : |
TRUE if file is native.
TODO: Explain what "native" means.
|
GFileInputStream* g_file_read (GFile *file, GCancellable *cancellable, GError **error);
Reads a whole file into a GFileInputStream. Fails returning NULL
if
given GFile points to a directory.
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 an
operation was partially finished when the operation was cancelled the
partial result will be returned, without an error.
|
GFile to read. |
|
a GCancellable |
|
a GError. |
Returns : |
GFileInputStream or NULL .
|
void g_file_read_async (GFile *file, int io_priority, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data);
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 an
operation was partially finished when the operation was cancelled the
partial result will be returned, without an error.
Asynchronously reads file
. For the synchronous version of this function,
see g_file_read()
.
|
input GFile. |
|
the io priority of the request. the io priority of the request. |
|
optional GCancellable object, NULL to ignore.
|
|
a GAsyncReadyCallback. |
|
a gpointer. |
GFileInputStream* g_file_read_finish (GFile *file, GAsyncResult *res, GError **error);
|
input GFile. |
|
|
|
a GAsyncResult. |
Returns : |
a GFileInputStream or NULL if there was an error.
|
GFileOutputStream* g_file_append_to (GFile *file, GFileCreateFlags flags, GCancellable *cancellable, GError **error);
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 an
operation was partially finished when the operation was cancelled the
partial result will be returned, without an error.
|
input GFile. |
|
a set of GFileCreateFlags. |
|
optional GCancellable object, NULL to ignore.
|
|
|
Returns : |
a GFileOutputStream. |
GFileOutputStream* g_file_create (GFile *file, GFileCreateFlags flags, GCancellable *cancellable, GError **error);
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 an
operation was partially finished when the operation was cancelled the
partial result will be returned, without an error.
|
input GFile. |
|
a set of GFileCreateFlags. |
|
optional GCancellable object, NULL to ignore.
|
|
a GError. |
Returns : |
a GFileOutputStream for the newly created file, or
NULL on error.
|
GFileOutputStream* g_file_replace (GFile *file, const char *etag, gboolean make_backup, GFileCreateFlags flags, GCancellable *cancellable, GError **error);
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 an
operation was partially finished when the operation was cancelled the
partial result will be returned, without an error.
|
input GFile. |
|
an Entity Tag for the current GFile. |
|
a gboolean. |
|
a set of GFileCreateFlags. |
|
optional GCancellable object, NULL to ignore.
|
|
|
Returns : |
a GFileOutputStream or NULL on error. If make_backup is TRUE ,
this function will attempt to make a backup of the current file.
|
void g_file_append_to_async (GFile *file, GFileCreateFlags flags, int io_priority, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data);
Readies a file for appending data asynchronously.
For the synchronous version of this function, see
g_file_append_to()
.
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 an
operation was partially finished when the operation was cancelled the
partial result will be returned, without an error.
|
input GFile. |
|
a set of GFileCreateFlags. |
|
the io priority of the request. the io priority of the request. |
|
optional GCancellable object, NULL to ignore.
|
|
a GAsyncReadyCallback. |
|
a gpointer. |
GFileOutputStream* g_file_append_to_finish (GFile *file, GAsyncResult *res, GError **error);
|
input GFile. |
|
GAsyncResult |
|
a GError. |
Returns : |
a valid GFileOutputStream or NULL upon error.
|
void g_file_create_async (GFile *file, GFileCreateFlags flags, int io_priority, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data);
Creates a new file asynchronously. For the synchronous version of
this function, see g_file_create()
.
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 an
operation was partially finished when the operation was cancelled the
partial result will be returned, without an error.
|
input GFile. |
|
a set of GFileCreateFlags. |
|
the io priority of the request. the io priority of the request. |
|
optional GCancellable object, NULL to ignore.
|
|
a GAsyncReadyCallback. |
|
a gpointer. |
GFileOutputStream* g_file_create_finish (GFile *file, GAsyncResult *res, GError **error);
|
input GFile. |
|
|
|
a GAsyncResult. |
Returns : |
a GFileOutputStream. |
void g_file_replace_async (GFile *file, const char *etag, gboolean make_backup, GFileCreateFlags flags, int io_priority, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data);
Replaces a file's contents. For the synchronous version of this
function, see g_file_replace()
. If make_backup
is TRUE
, this function
will attempt to make a backup of the current 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 an
operation was partially finished when the operation was cancelled the
partial result will be returned, without an error.
|
input GFile. |
|
an Entity Tag for the current GFile. |
|
a gboolean. |
|
a set of GFileCreateFlags. |
|
the io priority of the request. the io priority of the request. |
|
optional GCancellable object, NULL to ignore.
|
|
a GAsyncReadyCallback. |
|
a gpointer. |
GFileOutputStream* g_file_replace_finish (GFile *file, GAsyncResult *res, GError **error);
Finishes replacing the contents of the file started by
g_file_replace_async()
.
|
input GFile. |
|
|
|
a GAsyncResult. |
Returns : |
a GFileOutputStream, or NULL if an error has occured.
|
GFileInfo* g_file_query_info (GFile *file, const char *attributes, GFileQueryInfoFlags flags, GCancellable *cancellable, GError **error);
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 an
operation was partially finished when the operation was cancelled the
partial result will be returned, without an error.
|
input GFile. |
|
a string. |
|
a set of GFileQueryInfoFlags. |
|
optional GCancellable object, NULL to ignore.
|
|
a GError. |
Returns : |
a GFileInfo for the given file , or NULL on error.
|
void g_file_query_info_async (GFile *file, const char *attributes, GFileQueryInfoFlags flags, int io_priority, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data);
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 an
operation was partially finished when the operation was cancelled the
partial result will be returned, without an error.
|
input GFile. |
|
a string. |
|
a set of GFileQueryInfoFlags. |
|
the io priority of the request. the io priority of the request. |
|
optional GCancellable object, NULL to ignore.
|
|
a GAsyncReadyCallback. |
|
a gpointer. |
GFileInfo* g_file_query_info_finish (GFile *file, GAsyncResult *res, GError **error);
Finishes an asynchronous file info query. If the operation failed,
returns NULL
and set error
appropriately if present.
|
input GFile. |
|
|
|
a GAsyncResult. |
Returns : |
GFileInfo for given file or NULL .
|
GFileInfo* g_file_query_filesystem_info (GFile *file, const char *attributes, GCancellable *cancellable, GError **error);
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 an
operation was partially finished when the operation was cancelled the
partial result will be returned, without an error.
|
input GFile. |
|
a string. |
|
optional GCancellable object, NULL to ignore.
|
|
a GError. |
Returns : |
a GFileInfo or NULl if there was an error.
|
GVolume* g_file_find_enclosing_volume (GFile *file, GCancellable *cancellable, GError **error);
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 an
operation was partially finished when the operation was cancelled the
partial result will be returned, without an error.
|
input GFile. |
|
optional GCancellable object, NULL to ignore.
|
|
a GError. |
Returns : |
a GVolume where the file is located.
|
GFileEnumerator* g_file_enumerate_children (GFile *file, const char *attributes, GFileQueryInfoFlags flags, GCancellable *cancellable, GError **error);
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 an
operation was partially finished when the operation was cancelled the
partial result will be returned, without an error.
|
input GFile. |
|
a string. |
|
GFileQueryInfoFlags field. |
|
optional GCancellable object, NULL to ignore.
|
|
GError for error reporting. |
Returns : |
NULL if cancelled or if GFile's backend doesn't
support GFileEnumerator. Returns a GFileEnumerator if successful.
|
void g_file_enumerate_children_async (GFile *file, const char *attributes, GFileQueryInfoFlags flags, int io_priority, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data);
Asynchronously enumerates the children of the given 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 an
operation was partially finished when the operation was cancelled the
partial result will be returned, without an error.
|
input GFile. |
|
a string. |
|
a set of GFileQueryInfoFlags. |
|
the io priority of the request. the io priority of the request. |
|
optional GCancellable object, NULL to ignore.
|
|
a GAsyncReadyCallback. |
|
a gpointer. |
GFileEnumerator* g_file_enumerate_children_finish (GFile *file, GAsyncResult *res, GError **error);
|
input GFile. |
|
a GAsyncResult. |
|
a GError. |
Returns : |
a GFileEnumerator or NULL if an error occurred.
|
GFile* g_file_set_display_name (GFile *file, const char *display_name, GCancellable *cancellable, GError **error);
|
input GFile. |
|
a string. |
|
optional GCancellable object, NULL to ignore.
|
|
a GError. |
Returns : |
a GFile, or NULL if there was an error.
For the asynchronous version of this function, see
g_file_set_display_name_async() .
|
void g_file_set_display_name_async (GFile *file, const char *display_name, int io_priority, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data);
Asynchronously sets the display name for a given GFile.
For the synchronous version of this function, see
g_file_set_display_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. If an
operation was partially finished when the operation was cancelled the
partial result will be returned, without an error.
|
input GFile. |
|
a string. |
|
the io priority of the request. the io priority of the request. |
|
optional GCancellable object, NULL to ignore.
|
|
a GAsyncReadyCallback. |
|
a gpointer. |
GFile* g_file_set_display_name_finish (GFile *file, GAsyncResult *res, GError **error);
|
input GFile. |
|
|
|
a GAsyncResult. |
Returns : |
a GFile or NULL on error.
|
gboolean g_file_delete (GFile *file, GCancellable *cancellable, GError **error);
|
input GFile. |
|
optional GCancellable object, NULL to ignore.
|
|
a GError. |
Returns : |
TRUE if the file was deleted. FALSE otherwise.
|
gboolean g_file_trash (GFile *file, GCancellable *cancellable, GError **error);
This function sends the object to the virtual "Trash" location. If the
GFile interface does not have a corresponding "Trash" location, this function
returns FALSE
, and will set error
appropriately.
|
GFile to location to send to trash. |
|
optional GCancellable object, NULL to ignore.
|
|
GError for possible failures. |
Returns : |
TRUE on successful trash, FALSE otherwise.
|
gboolean g_file_copy (GFile *source, GFile *destination, GFileCopyFlags flags, GCancellable *cancellable, GFileProgressCallback progress_callback, gpointer progress_callback_data, GError **error);
List of possible errors resulting from g_file_copy()
:
source dest flags res
- * * G_IO_ERROR_NOT_FOUND
file - * ok
file * 0 G_IO_ERROR_EXISTS
file file overwr ok
file dir overwr G_IO_ERROR_IS_DIRECTORY
dir - * G_IO_ERROR_WOULD_RECURSE
dir * 0 G_IO_ERROR_EXISTS
dir dir overwr G_IO_ERROR_IS_DIRECTORY
dir file overwr G_IO_ERROR_WOULD_RECURSE
|
input GFile. |
|
destination GFile |
|
set of GFileCopyFlags |
|
optional GCancellable object, NULL to ignore.
|
|
function to callback with progress information |
|
userdata to pass to progress_callback
|
|
GError to set on error |
Returns : |
TRUE on success, FALSE otherwise.
|
gboolean g_file_move (GFile *source, GFile *destination, GFileCopyFlags flags, GCancellable *cancellable, GFileProgressCallback progress_callback, gpointer progress_callback_data, GError **error);
List of possible returns from g_file_move()
with given source,
destination, and flags:
source dest flags results in - * * G_IO_ERROR_NOT_FOUND file - * ok file * 0 G_IO_ERROR_EXISTS file file overwr ok file dir overwr G_IO_ERROR_IS_DIRECTORY
dir - * ok || G_IO_ERROR_WOULD_RECURSE dir * 0 G_IO_ERROR_EXISTS dir dir overwr G_IO_ERROR_IS_DIRECTORY dir file overwr ok || G_IO_ERROR_WOULD_RECURSE
|
GFile* pointing to the source location. |
|
GFile* pointing to the destination location. |
|
GFileCopyFlags enum. |
|
optional GCancellable object, NULL to ignore.
|
|
GFileProgressCallback function for updates. |
|
gpointer to user data for the callback function. |
|
GError for returning error conditions. |
Returns : |
TRUE on successful move, FALSE otherwise.
|
gboolean g_file_make_directory (GFile *file, GCancellable *cancellable, GError **error);
|
input GFile. |
|
optional GCancellable object, NULL to ignore.
|
|
a GError. |
Returns : |
TRUE on successful creation, FALSE otherwise.
|
gboolean g_file_make_symbolic_link (GFile *file, const char *symlink_value, GCancellable *cancellable, GError **error);
|
input GFile. |
|
a string with the name of the new symlink. |
|
optional GCancellable object, NULL to ignore.
|
|
a GError. |
Returns : |
TRUE on the creation of a new symlink, FALSE otherwise.
|
GFileAttributeInfoList* g_file_query_settable_attributes (GFile *file, GCancellable *cancellable, GError **error);
|
input GFile. |
|
optional GCancellable object, NULL to ignore.
|
|
a GError. |
Returns : |
the type and full attribute name of all the attributes that the file can set. 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. |
GFileAttributeInfoList* g_file_query_writable_namespaces (GFile *file, GCancellable *cancellable, GError **error);
|
input GFile. |
|
optional GCancellable object, NULL to ignore.
|
|
a GError. |
Returns : |
a GFileAttributeInfoList of attribute namespaces where the user can create their own attribute names, such as extended attributes. |
gboolean g_file_set_attribute (GFile *file, const char *attribute, const GFileAttributeValue *value, GFileQueryInfoFlags flags, GCancellable *cancellable, GError **error);
|
input GFile. |
|
a string containing the attribute's name. |
|
GFileAttributeValue |
|
GFileQueryInfoFlags |
|
optional GCancellable object, NULL to ignore.
|
|
a GError. |
Returns : |
TRUE if the attribute was correctly set, FALSE
otherwise.
|
gboolean g_file_set_attributes_from_info (GFile *file, GFileInfo *info, GFileQueryInfoFlags flags, GCancellable *cancellable, GError **error);
Tries to set all attributes in the GFileInfo on the target values, not stopping on the first error.
|
input GFile. |
|
a GFileInfo. |
|
GFileQueryInfoFlags |
|
optional GCancellable object, NULL to ignore.
|
|
a GError. |
Returns : |
TRUE if there was any error, and 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 .
|
void g_file_set_attributes_async (GFile *file, GFileInfo *info, GFileQueryInfoFlags flags, int io_priority, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data);
Asynchronously sets the attributes of file
with info
and flags
.
For the synchronous version of this function, see g_file_set_attributes()
.
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 an
operation was partially finished when the operation was cancelled the
partial result will be returned, without an error.
|
input GFile. |
|
a GFileInfo. |
|
a GFileQueryInfoFlags. |
|
the io priority of the request. the io priority of the request. |
|
optional GCancellable object, NULL to ignore.
|
|
a GAsyncReadyCallback. |
|
a gpointer. |
gboolean g_file_set_attributes_finish (GFile *file, GAsyncResult *result, GFileInfo **info, GError **error);
|
input GFile. |
|
a GAsyncResult. |
|
a GFileInfo. |
|
a GError. |
Returns : |
TRUE if the attributes were set correctly, FALSE otherwise.
|
gboolean g_file_set_attribute_string (GFile *file, const char *attribute, const char *value, GFileQueryInfoFlags flags, GCancellable *cancellable, GError **error);
|
input GFile. |
|
a string containing the attribute's name. |
|
a string containing the attribute's value. |
|
GFileQueryInfoFlags. |
|
optional GCancellable object, NULL to ignore.
|
|
a GError. |
Returns : |
TRUE if the attribute was successfully set to value
in the file , FALSE otherwise.
|
gboolean g_file_set_attribute_byte_string (GFile *file, const char *attribute, const char *value, GFileQueryInfoFlags flags, GCancellable *cancellable, GError **error);
|
|
|
|
|
|
|
|
|
|
|
|
Returns : |
gboolean g_file_set_attribute_uint32 (GFile *file, const char *attribute, guint32 value, GFileQueryInfoFlags flags, GCancellable *cancellable, GError **error);
|
input GFile. |
|
a string containing the attribute's name. |
|
a guint32 containing the attribute's new value. |
|
a GFileQueryInfoFlags. |
|
optional GCancellable object, NULL to ignore.
|
|
a GError. |
Returns : |
TRUE if the attribute was successfully set to value
in the file , FALSE otherwise.
|
gboolean g_file_set_attribute_int32 (GFile *file, const char *attribute, gint32 value, GFileQueryInfoFlags flags, GCancellable *cancellable, GError **error);
|
input GFile. |
|
a string containing the attribute's name. |
|
a gint32 containing the attribute's new value. |
|
a GFileQueryInfoFlags. |
|
optional GCancellable object, NULL to ignore.
|
|
a GError. |
Returns : |
TRUE if the attribute was successfully set to value
in the file , FALSE otherwise.
|
gboolean g_file_set_attribute_uint64 (GFile *file, const char *attribute, guint64 value, GFileQueryInfoFlags flags, GCancellable *cancellable, GError **error);
|
input GFile. |
|
a string containing the attribute's name. |
|
a guint64 containing the attribute's new value. |
|
a GFileQueryInfoFlags. |
|
optional GCancellable object, NULL to ignore.
|
|
a GError. |
Returns : |
TRUE if the attribute was successfully set to value
in the file , FALSE otherwise.
|
gboolean g_file_set_attribute_int64 (GFile *file, const char *attribute, gint64 value, GFileQueryInfoFlags flags, GCancellable *cancellable, GError **error);
|
input GFile. |
|
a string containing the attribute's name. |
|
a guint64 containing the attribute's new value. |
|
a GFileQueryInfoFlags. |
|
optional GCancellable object, NULL to ignore.
|
|
a GError. |
Returns : |
TRUE if the attribute was successfully set to value
in the file , FALSE otherwise.
|
void g_mount_for_location (GFile *location, GMountOperation *mount_operation, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data);
Starts the mount_operation
, mounting the volume at location
. This
operation is cancellable with cancellable
. When the operation has
completed, callback
will be called with user data. To finish
the operation, call g_mount_for_location_finish()
with the
GAsyncResult returned by the callback
.
|
input GFile. |
|
a GMountOperation. |
|
optional GCancellable object, NULL to ignore.
|
|
a GAsyncReadyCallback. |
|
a gpointer. |
gboolean g_mount_for_location_finish (GFile *location, GAsyncResult *result, GError **error);
Finishes an Asynchronous mount operation.
|
input GFile. |
|
a GAsyncResult. |
|
a GError. |
Returns : |
TRUE if the mount was finished successfully. If FALSE and
error is present, it will be set appropriately.
|
void g_file_mount_mountable (GFile *file, GMountOperation *mount_operation, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data);
Mounts a mountable file using mount_operation
, if possible.
|
input GFile. |
|
a GMountOperation. |
|
optional GCancellable object, NULL to ignore.
|
|
a GAsyncReadyCallback. |
|
a gpointer. |
GFile* g_file_mount_mountable_finish (GFile *file, GAsyncResult *result, GError **error);
|
input GFile. |
|
a GAsyncResult. |
|
a GError. |
Returns : |
a GFile or NULL on error.
|
void g_file_unmount_mountable (GFile *file, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data);
|
input GFile. |
|
optional GCancellable object, NULL to ignore.
|
|
a GAsyncReadyCallback. |
|
a gpointer. |
gboolean g_file_unmount_mountable_finish (GFile *file, GAsyncResult *result, GError **error);
|
input GFile. |
|
a GAsyncResult. |
|
a GError. |
Returns : |
TRUE if the operation finished successfully. FALSE
otherwise.
|
void g_file_eject_mountable (GFile *file, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data);
|
input GFile. |
|
optional GCancellable object, NULL to ignore.
|
|
a GAsyncReadyCallback. |
|
a gpointer. |
gboolean g_file_eject_mountable_finish (GFile *file, GAsyncResult *result, GError **error);
|
input GFile. |
|
a GAsyncResult. |
|
a GError. |
Returns : |
TRUE if the file was ejected successfully. FALSE
otherwise.
|
GDirectoryMonitor* g_file_monitor_directory (GFile *file, GFileMonitorFlags flags, GCancellable *cancellable);
|
input GFile. |
|
a set of GFileMonitorFlags. |
|
optional GCancellable object, NULL to ignore.
|
Returns : |
a GDirectoryMonitor for the given file ,
or NULL on error.
|
GFileMonitor* g_file_monitor_file (GFile *file, GFileMonitorFlags flags, GCancellable *cancellable);
|
input GFile. |
|
a set of GFileMonitorFlags. |
|
optional GCancellable object, NULL to ignore.
|
Returns : |
a GFileMonitor for the given file ,
or NULL on error.
|
gboolean g_file_load_contents (GFile *file, GCancellable *cancellable, char **contents, gsize *length, char **etag_out, GError **error);
|
input GFile. |
|
optional GCancellable object, NULL to ignore.
|
|
|
|
|
|
a pointer to the current entity tag for the document. |
|
a GError. |
Returns : |
TRUE if the file 's contents were successfully loaded.
FALSE if there were errors. The length of the loaded data will be
put into length , the contents in contents .
|
void g_file_load_contents_async (GFile *file, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data);
Starts an asynchronous load of the file
's contents. When the load operation
has completed, callback
will be called with userdata
. 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. If an
operation was partially finished when the operation was cancelled the
partial result will be returned, without an error.
|
input GFile. |
|
optional GCancellable object, NULL to ignore.
|
|
a GAsyncReadyCallback. |
|
a gpointer. |
gboolean g_file_load_contents_finish (GFile *file, GAsyncResult *res, char **contents, gsize *length, char **etag_out, GError **error);
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. If etag_out
is present, it will be set to the new entity
tag for the file
.
|
input GFile. |
|
|
|
an array of strings. |
|
a pointer to a gsize. |
|
a pointer to a string to get the new entity tag. |
|
a GAsyncResult. |
Returns : |
TRUE if the load was successful. If FALSE and error is
present, it will be set appropriately.
|
void g_file_load_partial_contents_async (GFile *file, GCancellable *cancellable, GFileReadMoreCallback read_more_callback, GAsyncReadyCallback callback, gpointer user_data);
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 an
operation was partially finished when the operation was cancelled the
partial result will be returned, without an error.
|
input GFile. |
|
optional GCancellable object, NULL to ignore.
|
|
a GFileReadMoreCallback. |
|
a GAsyncReadyCallback. |
|
a gpointer. |
gboolean g_file_load_partial_contents_finish (GFile *file, GAsyncResult *res, char **contents, gsize *length, char **etag_out, GError **error);
|
input GFile. |
|
|
|
a pointer to where the contents of the file will be placed. |
|
a pointer to the location where the content's length will be placed. |
|
a pointer to the current entity tag for the document. |
|
a GAsyncResult. |
Returns : |
TRUE if the load was successful. If FALSE and error is
present, it will be set appropriately.
|
gboolean g_file_replace_contents (GFile *file, const char *contents, gsize length, const char *etag, gboolean make_backup, GFileCreateFlags flags, char **new_etag, GCancellable *cancellable, GError **error);
Replaces the contents of file
with contents
of length
. The old
etag
will be replaced with the new_etag
. If make_backup
is TRUE
,
this function will attempt to make a backup of 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 an
operation was partially finished when the operation was cancelled the
partial result will be returned, without an error.
|
input GFile. |
|
|
|
a gsize. |
|
the old entity tag for the document. |
|
a gboolean. |
|
a set of GFileCreateFlags. |
|
a new entity tag for the document. |
|
optional GCancellable object, NULL to ignore.
|
|
a GError. |
Returns : |
TRUE if successful. If an error
has occured, this function will return FALSE and set error
appropriately if present.
|
void g_file_replace_contents_async (GFile *file, const char *contents, gsize length, const char *etag, gboolean make_backup, GFileCreateFlags flags, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data);
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 an
operation was partially finished when the operation was cancelled the
partial result will be returned, without an error.
If make_backup
is TRUE
, this function will attempt to
make a backup of file
.
|
input GFile. |
|
string of contents to replace the file with. |
|
length of the contents string.
|
|
a new entity tag for the file .
|
|
a gboolean. |
|
a set of GFileCreateFlags. |
|
optional GCancellable object, NULL to ignore.
|
|
a GAsyncReadyCallback. |
|
a gpointer. |
gboolean g_file_replace_contents_finish (GFile *file, GAsyncResult *res, char **new_etag, GError **error);
Finishes an asynchronous replace of the given file
.
This function will take ownership of the new_etag
, if present.
|
input GFile. |
|
|
|
a pointer to the new entity tag string for the contents of the file. |
|
a GAsyncResult. |
Returns : |
TRUE on success, FALSE on failure.
|