GMount

GMount — Mount management

Synopsis


#include <gio.h>


                    GMount;
                    GMountIface;
gboolean            g_mount_can_unmount                 (GMount *mount);
GDrive*             g_mount_get_drive                   (GMount *mount);
GIcon*              g_mount_get_icon                    (GMount *mount);
char*               g_mount_get_name                    (GMount *mount);
GFile*              g_mount_get_root                    (GMount *mount);
GVolume*            g_mount_get_volume                  (GMount *mount);
void                g_mount_unmount                     (GMount *mount,
                                                         GMountUnmountFlags flags,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
gboolean            g_mount_unmount_finish              (GMount *mount,
                                                         GAsyncResult *result,
                                                         GError **error);


Object Hierarchy


  GInterface
   +----GMount

Prerequisites

GMount requires GObject.

Description

The GMount interface represents user-visible mounts. Note, when porting from GnomeVFS, GMount is the moral equivalent of GnomeVFSVolume.

Unmounting a GMount instance is an asynchronous operation. For more information about asynchronous operations, see GAsyncReady and GSimpleAsyncReady. To unmount a GMount instance, first call g_mount_unmount() with (at least) the GMount instance and a GAsyncReadyCallback. The callback will be fired when the operation has resolved (either with success or failure), and a GAsyncReady structure will be passed to the callback. That callback should then call g_mount_unmount_finish() with the GMount and the GAsyncReady data to see if the operation was completed successfully. If an error is present when g_mount_unmount_finish() is called, then it will be filled with any error information.

Details

GMount

typedef struct _GMount GMount;

A handle to an object implementing the GMountIface interface.


GMountIface

typedef struct {
  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,
					      GMountOperation     *mount_operation,
                                              GCancellable    *cancellable,
                                              GAsyncReadyCallback callback,
                                              gpointer         user_data);
  gboolean           (*remount_finish)       (GMount         *mount,
                                              GAsyncResult    *result,
                                              GError         **error);
} GMountIface;

Interface for implementing operations for mounts.

GTypeInterface g_iface;

The parent interface.

changed ()

Changed signal that is emitted when the mount's state has changed.

unmounted ()

The unmounted signal that is emitted when the GMount have been unmounted. If the recipient is holding references to the object they should release them so the object can be finalized.

get_root ()

Gets a GFile to the root directory of the GMount.

get_name ()

Gets a string containing the name of the GMount.

get_icon ()

Gets a GIcon for the GMount.

get_uuid ()

Gets the UUID for the GMount. 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.

get_volume ()

Gets a GVolume the mount is located on. Returns NULL if the GMount is not associated with a GVolume.

get_drive ()

Gets a GDrive the volume of the mount is located on. Returns NULL if the GMount is not associated with a GDrive or a GVolume. This is convenience method for getting the GVolume and using that to get the GDrive.

can_unmount ()

Checks if a GMount can be unmounted.

can_eject ()

Checks if a GMount can be ejected.

unmount ()

Starts unmounting a GMount.

unmount_finish ()

Finishes an unmounting operation.

eject ()

Starts ejecting a GMount.

eject_finish ()

Finishes an eject operation.

remount ()

remount_finish ()


g_mount_can_unmount ()

gboolean            g_mount_can_unmount                 (GMount *mount);

Checks if mount can be mounted.

mount :

a GMount.

Returns :

TRUE if the mount can be unmounted.

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.

mount :

a GMount.

Returns :

a GDrive or NULL if mount is not associated with a volume or a drive.

g_mount_get_icon ()

GIcon*              g_mount_get_icon                    (GMount *mount);

Gets the icon for mount.

mount :

a GMount.

Returns :

a GIcon.

g_mount_get_name ()

char*               g_mount_get_name                    (GMount *mount);

Gets the name of mount.

mount :

a GMount.

Returns :

the name for the given mount. The returned string should be freed when no longer needed.

g_mount_get_root ()

GFile*              g_mount_get_root                    (GMount *mount);

Gets the root directory on mount.

mount :

a GMount.

Returns :

a GFile.

g_mount_get_volume ()

GVolume*            g_mount_get_volume                  (GMount *mount);

Gets the volume for the mount.

mount :

a GMount.

Returns :

a GVolume or NULL if mount is not associated with a volume.

g_mount_unmount ()

void                g_mount_unmount                     (GMount *mount,
                                                         GMountUnmountFlags flags,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Unmounts a mount. This is an asynchronous operation, and is finished by calling g_mount_unmount_finish() with the mount and GAsyncResults data returned in the callback.

mount :

a GMount.

flags :

flags affecting the operation

cancellable :

optional GCancellable object, NULL to ignore.

callback :

a GAsyncReadyCallback.

user_data :

user data passed to callback.

g_mount_unmount_finish ()

gboolean            g_mount_unmount_finish              (GMount *mount,
                                                         GAsyncResult *result,
                                                         GError **error);

Finishes unmounting a mount. If any errors occured during the operation, error will be set to contain the errors and FALSE will be returned.

mount :

a GMount.

result :

a GAsyncResult.

error :

a GError location to store the error occuring, or NULL to ignore.

Returns :

TRUE if the mount was successfully unmounted. FALSE otherwise.