Functions
g_mount_get_name ()
char *
g_mount_get_name (GMount *mount);
Gets the name of mount
.
Returns
the name for the given mount
.
The returned string should be freed with g_free()
when no longer needed.
g_mount_get_uuid ()
char *
g_mount_get_uuid (GMount *mount);
Gets the UUID for the mount
. The reference is typically based on
the file system UUID for the mount in question and should be
considered an opaque string. Returns NULL if there is no UUID
available.
Returns
the UUID for mount
or NULL if no UUID
can be computed.
The returned string should be freed with g_free()
when no longer needed.
[nullable][transfer full]
g_mount_get_icon ()
GIcon *
g_mount_get_icon (GMount *mount);
Gets the icon for mount
.
Returns
a GIcon.
The returned object should be unreffed with
g_object_unref() when no longer needed.
[transfer full]
g_mount_get_symbolic_icon ()
GIcon *
g_mount_get_symbolic_icon (GMount *mount);
Gets the symbolic icon for mount
.
Returns
a GIcon.
The returned object should be unreffed with
g_object_unref() when no longer needed.
[transfer full]
Since: 2.34
g_mount_get_drive ()
GDrive *
g_mount_get_drive (GMount *mount);
Gets the drive for the mount
.
This is a convenience method for getting the GVolume and then
using that object to get the GDrive.
Returns
a GDrive or NULL if mount
is not
associated with a volume or a drive.
The returned object should be unreffed with
g_object_unref() when no longer needed.
[transfer full][nullable]
g_mount_get_root ()
GFile *
g_mount_get_root (GMount *mount);
Gets the root directory on mount
.
Returns
a GFile.
The returned object should be unreffed with
g_object_unref() when no longer needed.
[transfer full]
g_mount_get_volume ()
GVolume *
g_mount_get_volume (GMount *mount);
Gets the volume for the mount
.
Returns
a GVolume or NULL if mount
is not
associated with a volume.
The returned object should be unreffed with
g_object_unref() when no longer needed.
[transfer full][nullable]
g_mount_get_default_location ()
GFile *
g_mount_get_default_location (GMount *mount);
Gets the default location of mount
. The default location of the given
mount
is a path that reflects the main entry point for the user (e.g.
the home directory, or the root of the volume).
Returns
a GFile.
The returned object should be unreffed with
g_object_unref() when no longer needed.
[transfer full]
g_mount_can_unmount ()
gboolean
g_mount_can_unmount (GMount *mount);
Checks if mount
can be unmounted.
Returns
TRUE if the mount
can be unmounted.
g_mount_unmount_finish ()
gboolean
g_mount_unmount_finish (GMount *mount,
GAsyncResult *result,
GError **error);
Finishes unmounting a mount. If any errors occurred during the operation,
error
will be set to contain the errors and FALSE will be returned.
Returns
TRUE if the mount was successfully unmounted. FALSE otherwise.
g_mount_unmount_with_operation_finish ()
gboolean
g_mount_unmount_with_operation_finish (GMount *mount,
GAsyncResult *result,
GError **error);
Finishes unmounting a mount. If any errors occurred during the operation,
error
will be set to contain the errors and FALSE will be returned.
Returns
TRUE if the mount was successfully unmounted. FALSE otherwise.
Since: 2.22
g_mount_remount ()
void
g_mount_remount (GMount *mount,
GMountMountFlags flags,
GMountOperation *mount_operation,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
Remounts a mount. This is an asynchronous operation, and is
finished by calling g_mount_remount_finish() with the mount
and GAsyncResults data returned in the callback
.
Remounting is useful when some setting affecting the operation
of the volume has been changed, as these may need a remount to
take affect. While this is semantically equivalent with unmounting
and then remounting not all backends might need to actually be
unmounted.
g_mount_remount_finish ()
gboolean
g_mount_remount_finish (GMount *mount,
GAsyncResult *result,
GError **error);
Finishes remounting a mount. If any errors occurred during the operation,
error
will be set to contain the errors and FALSE will be returned.
Returns
TRUE if the mount was successfully remounted. FALSE otherwise.
g_mount_can_eject ()
gboolean
g_mount_can_eject (GMount *mount);
Checks if mount
can be ejected.
Returns
TRUE if the mount
can be ejected.
g_mount_eject_finish ()
gboolean
g_mount_eject_finish (GMount *mount,
GAsyncResult *result,
GError **error);
Finishes ejecting a mount. If any errors occurred during the operation,
error
will be set to contain the errors and FALSE will be returned.
Returns
TRUE if the mount was successfully ejected. FALSE otherwise.
g_mount_eject_with_operation_finish ()
gboolean
g_mount_eject_with_operation_finish (GMount *mount,
GAsyncResult *result,
GError **error);
Finishes ejecting a mount. If any errors occurred during the operation,
error
will be set to contain the errors and FALSE will be returned.
Returns
TRUE if the mount was successfully ejected. FALSE otherwise.
Since: 2.22
g_mount_guess_content_type ()
void
g_mount_guess_content_type (GMount *mount,
gboolean force_rescan,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
Tries to guess the type of content stored on mount
. Returns one or
more textual identifiers of well-known content types (typically
prefixed with "x-content/"), e.g. x-content/image-dcf for camera
memory cards. See the
shared-mime-info
specification for more on x-content types.
This is an asynchronous operation (see
g_mount_guess_content_type_sync() for the synchronous version), and
is finished by calling g_mount_guess_content_type_finish() with the
mount
and GAsyncResult data returned in the callback
.
Since: 2.18
g_mount_guess_content_type_finish ()
gchar **
g_mount_guess_content_type_finish (GMount *mount,
GAsyncResult *result,
GError **error);
Finishes guessing content types of mount
. If any errors occurred
during the operation, error
will be set to contain the errors and
FALSE will be returned. In particular, you may get an
G_IO_ERROR_NOT_SUPPORTED if the mount does not support content
guessing.
Returns
a NULL-terminated array of content types or NULL on error.
Caller should free this array with g_strfreev() when done with it.
[transfer full][element-type utf8]
Since: 2.18
g_mount_guess_content_type_sync ()
gchar **
g_mount_guess_content_type_sync (GMount *mount,
gboolean force_rescan,
GCancellable *cancellable,
GError **error);
Tries to guess the type of content stored on mount
. Returns one or
more textual identifiers of well-known content types (typically
prefixed with "x-content/"), e.g. x-content/image-dcf for camera
memory cards. See the
shared-mime-info
specification for more on x-content types.
This is a synchronous operation and as such may block doing IO;
see g_mount_guess_content_type() for the asynchronous version.
Returns
a NULL-terminated array of content types or NULL on error.
Caller should free this array with g_strfreev() when done with it.
[transfer full][element-type utf8]
Since: 2.18
g_mount_is_shadowed ()
gboolean
g_mount_is_shadowed (GMount *mount);
Determines if mount
is shadowed. Applications or libraries should
avoid displaying mount
in the user interface if it is shadowed.
A mount is said to be shadowed if there exists one or more user
visible objects (currently GMount objects) with a root that is
inside the root of mount
.
One application of shadow mounts is when exposing a single file
system that is used to address several logical volumes. In this
situation, a GVolumeMonitor implementation would create two
GVolume objects (for example, one for the camera functionality of
the device and one for a SD card reader on the device) with
activation URIs gphoto2://[usb:001,002]/store1/
and gphoto2://[usb:001,002]/store2/. When the
underlying mount (with root
gphoto2://[usb:001,002]/) is mounted, said
GVolumeMonitor implementation would create two GMount objects
(each with their root matching the corresponding volume activation
root) that would shadow the original mount.
The proxy monitor in GVfs 2.26 and later, automatically creates and
manage shadow mounts (and shadows the underlying mount) if the
activation root on a GVolume is set.
Returns
TRUE if mount
is shadowed.
Since: 2.20
g_mount_shadow ()
void
g_mount_shadow (GMount *mount);
Increments the shadow count on mount
. Usually used by
GVolumeMonitor implementations when creating a shadow mount for
mount
, see g_mount_is_shadowed() for more information. The caller
will need to emit the “changed” signal on mount
manually.
Since: 2.20
g_mount_unshadow ()
void
g_mount_unshadow (GMount *mount);
Decrements the shadow count on mount
. Usually used by
GVolumeMonitor implementations when destroying a shadow mount for
mount
, see g_mount_is_shadowed() for more information. The caller
will need to emit the “changed” signal on mount
manually.
Since: 2.20
g_mount_get_sort_key ()
const gchar *
g_mount_get_sort_key (GMount *mount);
Gets the sort key for mount
, if any.
Returns
Sorting key for mount
or NULL if no such key is available.
[nullable]
Since: 2.32
Types and Values
GMount
typedef struct _GMount GMount;
A handle to an object implementing the GMountIface interface.
struct GMountIface
struct GMountIface {
GTypeInterface g_iface;
/* signals */
void (* changed) (GMount *mount);
void (* unmounted) (GMount *mount);
/* Virtual Table */
GFile * (* get_root) (GMount *mount);
char * (* get_name) (GMount *mount);
GIcon * (* get_icon) (GMount *mount);
char * (* get_uuid) (GMount *mount);
GVolume * (* get_volume) (GMount *mount);
GDrive * (* get_drive) (GMount *mount);
gboolean (* can_unmount) (GMount *mount);
gboolean (* can_eject) (GMount *mount);
void (* unmount) (GMount *mount,
GMountUnmountFlags flags,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
gboolean (* unmount_finish) (GMount *mount,
GAsyncResult *result,
GError **error);
void (* eject) (GMount *mount,
GMountUnmountFlags flags,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
gboolean (* eject_finish) (GMount *mount,
GAsyncResult *result,
GError **error);
void (* remount) (GMount *mount,
GMountMountFlags flags,
GMountOperation *mount_operation,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
gboolean (* remount_finish) (GMount *mount,
GAsyncResult *result,
GError **error);
void (* guess_content_type) (GMount *mount,
gboolean force_rescan,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
gchar ** (* guess_content_type_finish) (GMount *mount,
GAsyncResult *result,
GError **error);
gchar ** (* guess_content_type_sync) (GMount *mount,
gboolean force_rescan,
GCancellable *cancellable,
GError **error);
/* Signal, not VFunc */
void (* pre_unmount) (GMount *mount);
void (* unmount_with_operation) (GMount *mount,
GMountUnmountFlags flags,
GMountOperation *mount_operation,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
gboolean (* unmount_with_operation_finish) (GMount *mount,
GAsyncResult *result,
GError **error);
void (* eject_with_operation) (GMount *mount,
GMountUnmountFlags flags,
GMountOperation *mount_operation,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
gboolean (* eject_with_operation_finish) (GMount *mount,
GAsyncResult *result,
GError **error);
GFile * (* get_default_location) (GMount *mount);
const gchar * (* get_sort_key) (GMount *mount);
GIcon * (* get_symbolic_icon) (GMount *mount);
};
Interface for implementing operations for mounts.
enum GMountMountFlags
Flags used when mounting a mount.
enum GMountUnmountFlags
Flags used when an unmounting a mount.