![]() |
![]() |
![]() |
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_commandline_arg (const char *arg);
|
|
Returns : |
a new GFile. |
guint g_file_hash (gconstpointer file);
|
gconstpointer to a GFile. |
Returns : |
0 if file is not a GFile, otherwise a
guint containing a hash of the GFile. This function
is intended for easily hashing a GFile to add to a
GHashTable or similar data structure.
TODO: What is the hash representative of, the name?
contents? path? implementation specific?
|
char* g_file_get_uri (GFile *file);
|
input GFile. |
Returns : |
string to the GFile's Universal Resource Identifier (URI), or NULL if given GFile is invalid. TODO: is the returned string owned by GIO? |
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.
|
GFile to read. |
|
GCancellable |
|
GError. |
Returns : |
GFileInputStream or NULL .
|
void g_file_read_async (GFile *file, int io_priority, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data);
|
input GFile. |
|
|
|
GCancellable interrupt object. |
|
|
|
GFileInputStream* g_file_read_finish (GFile *file, GAsyncResult *res, GError **error);
|
input GFile. |
|
|
|
|
Returns : |
GFileOutputStream* g_file_append_to (GFile *file, GFileCreateFlags flags, GCancellable *cancellable, GError **error);
|
input GFile. |
|
|
|
GCancellable interrupt object. |
|
|
Returns : |
GFileOutputStream* g_file_create (GFile *file, GFileCreateFlags flags, GCancellable *cancellable, GError **error);
|
input GFile. |
|
|
|
GCancellable interrupt object. |
|
|
Returns : |
GFileOutputStream* g_file_replace (GFile *file, const char *etag, gboolean make_backup, GFileCreateFlags flags, GCancellable *cancellable, GError **error);
|
input GFile. |
|
|
|
|
|
|
|
GCancellable interrupt object. |
|
|
Returns : |
void g_file_append_to_async (GFile *file, GFileCreateFlags flags, int io_priority, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data);
|
input GFile. |
|
|
|
|
|
GCancellable interrupt object. |
|
|
|
GFileOutputStream* g_file_append_to_finish (GFile *file, GAsyncResult *res, GError **error);
|
input GFile. |
|
GAsyncResult |
|
|
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);
|
input GFile. |
|
|
|
|
|
GCancellable interrupt object. |
|
|
|
GFileOutputStream* g_file_create_finish (GFile *file, GAsyncResult *res, GError **error);
|
input GFile. |
|
|
|
|
Returns : |
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);
|
input GFile. |
|
|
|
|
|
|
|
|
|
GCancellable interrupt object. |
|
|
|
GFileOutputStream* g_file_replace_finish (GFile *file, GAsyncResult *res, GError **error);
|
input GFile. |
|
|
|
|
Returns : |
GFileOutputStream. |
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);
|
input GFile. |
|
|
|
|
|
|
|
|
|
|
|
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);
|
input GFile. |
|
|
|
|
|
|
Returns : |
GVolume* g_file_find_enclosing_volume (GFile *file, GCancellable *cancellable, GError **error);
|
input GFile. |
|
|
|
|
Returns : |
GFileEnumerator* g_file_enumerate_children (GFile *file, const char *attributes, GFileQueryInfoFlags flags, GCancellable *cancellable, GError **error);
|
input GFile. |
|
|
|
GFileQueryInfoFlags field. |
|
GCancellable interrupt object. |
|
GError for error reporting. |
Returns : |
NULL if cancelled or if GFile's backend doesn't
support GFileEnumerator. Returns a pointer to 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);
|
input GFile. |
|
|
|
|
|
|
|
|
|
|
|
GFileEnumerator* g_file_enumerate_children_finish (GFile *file, GAsyncResult *res, GError **error);
|
input GFile. |
|
|
|
|
Returns : |
GFileEnumerator. |
GFile* g_file_set_display_name (GFile *file, const char *display_name, GCancellable *cancellable, GError **error);
|
input GFile. |
|
|
|
GCancellable interrupt object. |
|
|
Returns : |
void g_file_set_display_name_async (GFile *file, const char *display_name, int io_priority, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data);
|
input GFile. |
|
|
|
|
|
GCancellable interrupt object. |
|
|
|
GFile* g_file_set_display_name_finish (GFile *file, GAsyncResult *res, GError **error);
|
input GFile. |
|
|
|
|
Returns : |
gboolean g_file_delete (GFile *file, GCancellable *cancellable, GError **error);
|
input GFile. |
|
GCancellable interrupt object. |
|
|
Returns : |
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. |
|
GCancellable interrupt object. |
|
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 |
|
GCancellable interrupt object. |
|
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. |
|
GCancellable interrupt object. |
|
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. |
|
GCancellable interrupt object. |
|
|
Returns : |
gboolean g_file_make_symbolic_link (GFile *file, const char *symlink_value, GCancellable *cancellable, GError **error);
|
input GFile. |
|
|
|
GCancellable interrupt object. |
|
|
Returns : |
GFileAttributeInfoList* g_file_query_settable_attributes (GFile *file, GCancellable *cancellable, GError **error);
|
input GFile. |
|
GCancellable interrupt object. |
|
|
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. |
|
GCancellable interrupt object. |
|
|
Returns : |
the list 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. |
|
the attribute to set's name. |
|
GFileAttributeValue |
|
GFileQueryInfoFlags |
|
GCancellable interrupt object. |
|
|
Returns : |
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. |
|
|
|
GFileQueryInfoFlags |
|
GCancellable interrupt object. |
|
|
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);
|
input GFile. |
|
|
|
|
|
|
|
GCancellable interrupt object. |
|
|
|
gboolean g_file_set_attributes_finish (GFile *file, GAsyncResult *result, GFileInfo **info, GError **error);
|
input GFile. |
|
|
|
|
|
|
Returns : |
gboolean g_file_set_attribute_string (GFile *file, const char *attribute, const char *value, GFileQueryInfoFlags flags, GCancellable *cancellable, GError **error);
|
input GFile. |
|
|
|
|
|
|
|
GCancellable interrupt object. |
|
|
Returns : |
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. |
|
|
|
|
|
|
|
GCancellable interrupt object. |
|
|
Returns : |
gboolean g_file_set_attribute_int32 (GFile *file, const char *attribute, gint32 value, GFileQueryInfoFlags flags, GCancellable *cancellable, GError **error);
|
input GFile. |
|
|
|
|
|
|
|
GCancellable interrupt object. |
|
|
Returns : |
gboolean g_file_set_attribute_uint64 (GFile *file, const char *attribute, guint64 value, GFileQueryInfoFlags flags, GCancellable *cancellable, GError **error);
|
input GFile. |
|
|
|
|
|
|
|
GCancellable interrupt object. |
|
|
Returns : |
gboolean g_file_set_attribute_int64 (GFile *file, const char *attribute, gint64 value, GFileQueryInfoFlags flags, GCancellable *cancellable, GError **error);
|
input GFile. |
|
|
|
|
|
|
|
GCancellable interrupt object. |
|
|
Returns : |
void g_mount_for_location (GFile *location, GMountOperation *mount_operation, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data);
|
input GFile. |
|
|
|
GCancellable interrupt object. |
|
|
|
gboolean g_mount_for_location_finish (GFile *location, GAsyncResult *result, GError **error);
|
input GFile. |
|
|
|
|
Returns : |
void g_file_mount_mountable (GFile *file, GMountOperation *mount_operation, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data);
|
input GFile. |
|
|
|
GCancellable interrupt object. |
|
|
|
GFile* g_file_mount_mountable_finish (GFile *file, GAsyncResult *result, GError **error);
|
input GFile. |
|
|
|
|
Returns : |
void g_file_unmount_mountable (GFile *file, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data);
|
input GFile. |
|
GCancellable interrupt object. |
|
|
|
gboolean g_file_unmount_mountable_finish (GFile *file, GAsyncResult *result, GError **error);
|
input GFile. |
|
|
|
|
Returns : |
void g_file_eject_mountable (GFile *file, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data);
|
input GFile. |
|
GCancellable interrupt object. |
|
|
|
gboolean g_file_eject_mountable_finish (GFile *file, GAsyncResult *result, GError **error);
|
input GFile. |
|
|
|
|
Returns : |
GDirectoryMonitor* g_file_monitor_directory (GFile *file, GFileMonitorFlags flags, GCancellable *cancellable);
|
input GFile. |
|
GFileMonitorFlags enum |
|
GCancellable interrupt object. |
Returns : |
GDirectoryMonitor |
GFileMonitor* g_file_monitor_file (GFile *file, GFileMonitorFlags flags, GCancellable *cancellable);
|
input GFile. |
|
GFileMonitorFlags enum |
|
GCancellable interrupt object. |
Returns : |
GFileMonitor |
gboolean g_file_load_contents (GFile *file, GCancellable *cancellable, char **contents, gsize *length, char **etag_out, GError **error);
|
input GFile. |
|
GCancellable interrupt object. |
|
|
|
|
|
|
|
|
Returns : |
void g_file_load_contents_async (GFile *file, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data);
|
input GFile. |
|
GCancellable interrupt object. |
|
|
|
gboolean g_file_load_contents_finish (GFile *file, GAsyncResult *res, char **contents, gsize *length, char **etag_out, GError **error);
|
input GFile. |
|
|
|
|
|
|
|
|
|
|
Returns : |
void g_file_load_partial_contents_async (GFile *file, GCancellable *cancellable, GFileReadMoreCallback read_more_callback, GAsyncReadyCallback callback, gpointer user_data);
|
input GFile. |
|
GCancellable interrupt object. |
|
|
|
|
|
gboolean g_file_load_partial_contents_finish (GFile *file, GAsyncResult *res, char **contents, gsize *length, char **etag_out, GError **error);
|
input GFile. |
|
|
|
|
|
|
|
|
|
|
Returns : |
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);
|
input GFile. |
|
|
|
|
|
|
|
|
|
|
|
|
|
GCancellable interrupt object. |
|
|
Returns : |
TRUE if successful, FALSE on 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);
|
input GFile. |
|
string of contents to add to the file. |
|
length of the contents string.
|
|
|
|
gboolean to indicate if a backup of the file should be made. |
|
GFileCreateFlags to set the mode. |
|
GCancellable interrupt object. |
|
|
|
gboolean g_file_replace_contents_finish (GFile *file, GAsyncResult *res, char **new_etag, GError **error);
This function will take ownership of new_etag
.
|
input GFile. |
|
|
|
|
|
|
Returns : |
TRUE on success, FALSE on failure.
|