GNOME_IS_VFS_VOLUME()

#define GNOME_IS_VFS_VOLUME(o)       (G_TYPE_CHECK_INSTANCE_TYPE ((o), GNOME_VFS_TYPE_VOLUME))

GNOME_IS_VFS_VOLUME_CLASS()

#define GNOME_IS_VFS_VOLUME_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), GNOME_VFS_TYPE_VOLUME))

GNOME_VFS_TYPE_VOLUME

#define GNOME_VFS_TYPE_VOLUME        (gnome_vfs_volume_get_type ())

GNOME_VFS_VOLUME()

#define GNOME_VFS_VOLUME(o)          (G_TYPE_CHECK_INSTANCE_CAST ((o), GNOME_VFS_TYPE_VOLUME, GnomeVFSVolume))

GNOME_VFS_VOLUME_CLASS()

#define GNOME_VFS_VOLUME_CLASS(k)    (G_TYPE_CHECK_CLASS_CAST((k), GNOME_VFS_TYPE_VOLUME, GnomeVFSVolumeClass))

GnomeVFSVolume

typedef struct _GnomeVFSVolume GnomeVFSVolume;

GnomeVFSVolumeClass

typedef struct {
	GObjectClass parent_class;
} GnomeVFSVolumeClass;

GnomeVFSVolumeOpCallback ()

void        (*GnomeVFSVolumeOpCallback)     (gboolean succeeded,
                                             char *error,
                                             char *detailed_error,
                                             gpointer user_data);

Note that if succeeded is FALSE and error, detailed_error are both empty strings the client is not supposed to display a dialog as an external mount/umount/eject helper will have done so.

Since 2.6

enum GnomeVFSVolumeType

typedef enum {
	GNOME_VFS_VOLUME_TYPE_MOUNTPOINT,
	GNOME_VFS_VOLUME_TYPE_VFS_MOUNT,
	GNOME_VFS_VOLUME_TYPE_CONNECTED_SERVER
} GnomeVFSVolumeType;

gnome_vfs_volume_compare ()

gint        gnome_vfs_volume_compare        (GnomeVFSVolume *a,
                                             GnomeVFSVolume *b);

Compares two GnomeVFSVolume objects a and b. Two GnomeVFSVolume objects referring to different volumes are guaranteed to not return 0 when comparing them, if they refer to the same volume 0 is returned.

The resulting gint should be used to determine the order in which a and b are displayed in graphical user interfces.

The comparison algorithm first of all peeks the device type of a and b, they will be sorted in the following order:

Afterwards, the display name of a and b is compared using a locale-sensitive sorting algorithm, which involves g_utf8_collate_key().

If two volumes have the same display name, their unique ID is compared which can be queried using gnome_vfs_volume_get_id().

Since 2.6

gnome_vfs_volume_eject ()

void        gnome_vfs_volume_eject          (GnomeVFSVolume *volume,
                                             GnomeVFSVolumeOpCallback callback,
                                             gpointer user_data);

Requests ejection of a GnomeVFSVolume.

Before the unmount operation is executed, the GnomeVFSVolume::pre-unmount signal is emitted.

If the volume is a mount point (its type is GNOME_VFS_VOLUME_TYPE_MOUNTPOINT), it is unmounted, and if it refers to a disc, it is also ejected.

If the volume is a special VFS mount, i.e. its type is GNOME_VFS_VOLUME_TYPE_VFS_MOUNT, it is ejected.

If the volume is a connected server, it is removed from the list of connected servers.

Otherwise, no further action is done.

Since 2.6

gnome_vfs_volume_get_activation_uri ()

char*       gnome_vfs_volume_get_activation_uri
                                            (GnomeVFSVolume *volume);

Returns the activation URI of a GnomeVFSVolume.

The returned URI usually refers to a valid location. You can check the validity of the location by calling gnome_vfs_uri_new() with the URI, and checking whether the return value is not NULL.

Since 2.6

gnome_vfs_volume_get_device_path ()

char*       gnome_vfs_volume_get_device_path
                                            (GnomeVFSVolume *volume);

Returns the device path of a GnomeVFSVolume.

For HAL volumes, this returns the value of the volume's "block.device" key. For UNIX mounts, it returns the mntent's mnt_fsname entry.

Otherwise, it returns NULL.

Since 2.6

gnome_vfs_volume_get_device_type ()

GnomeVFSDeviceType gnome_vfs_volume_get_device_type
                                            (GnomeVFSVolume *volume);

Returns the GnomeVFSDeviceType of the volume.

Since 2.6

gnome_vfs_volume_get_display_name ()

char*       gnome_vfs_volume_get_display_name
                                            (GnomeVFSVolume *volume);

Returns the display name of the volume.

Since 2.6

gnome_vfs_volume_get_drive ()

GnomeVFSDrive* gnome_vfs_volume_get_drive   (GnomeVFSVolume *volume);

Since 2.6

gnome_vfs_volume_get_filesystem_type ()

char*       gnome_vfs_volume_get_filesystem_type
                                            (GnomeVFSVolume *volume);

Returns a string describing the file system on volume, or NULL if no information on the underlying file system is available.

The file system may be used to provide special functionality that depends on the file system type, for instance to determine whether trashing is supported (cf. gnome_vfs_volume_handles_trash()).

For HAL mounts, this returns the value of the "volume.fstype" key, for traditional UNIX mounts it is set to the mntent's mnt_type key, for connected servers, NULL is returned.

As of GnomeVFS 2.15.4, the following file systems are recognized by GnomeVFS:

Since 2.6

gnome_vfs_volume_get_hal_udi ()

char*       gnome_vfs_volume_get_hal_udi    (GnomeVFSVolume *volume);

Returns the HAL UDI of a GnomeVFSVolume.

For HAL volumes, this matches the value of the "info.udi" key, for other volumes it is NULL.

Since 2.6

gnome_vfs_volume_get_icon ()

char*       gnome_vfs_volume_get_icon       (GnomeVFSVolume *volume);

Since 2.6

gnome_vfs_volume_get_id ()

gulong      gnome_vfs_volume_get_id         (GnomeVFSVolume *volume);

Returns the ID of the volume,

Two GnomeVFSVolumes are guaranteed to refer to the same volume if they have the same ID.

Since 2.6

gnome_vfs_volume_get_type ()

GType       gnome_vfs_volume_get_type       (void);

gnome_vfs_volume_get_volume_type ()

GnomeVFSVolumeType gnome_vfs_volume_get_volume_type
                                            (GnomeVFSVolume *volume);

Returns the GnomeVFSVolumeType of the volume.

Since 2.6

gnome_vfs_volume_handles_trash ()

gboolean    gnome_vfs_volume_handles_trash  (GnomeVFSVolume *volume);

Returns whether the file system on a volume supports trashing of files.

If the volume has an AutoFS file system (i.e. gnome_vfs_volume_get_device_type() returns GNOME_VFS_DEVICE_TYPE_AUTOFS), or if the volume is mounted read-only (gnome_vfs_volume_is_read_only() returns TRUE), it is assumed to not support trashing of files.

Otherwise, if the volume provides file system information, it is determined whether the file system supports trashing of files. See gnome_vfs_volume_get_filesystem_type() for details which volumes provide file system information, and which file systems currently support a trash.

Since 2.6

gnome_vfs_volume_is_mounted ()

gboolean    gnome_vfs_volume_is_mounted     (GnomeVFSVolume *volume);

Returns whether the file system on a volume is currently mounted.

For HAL volumes, this reflects the value of the "volume.is_mounted" key, for traditional UNIX mounts and connected servers, TRUE is returned, because their existence implies that they are mounted.

Since 2.6

gnome_vfs_volume_is_read_only ()

gboolean    gnome_vfs_volume_is_read_only   (GnomeVFSVolume *volume);

Returns whether the file system on a volume is read-only.

For HAL volumes, the "volume.is_mounted_read_only" key is authoritative, for traditional UNIX mounts it returns TRUE if the mount was done with the "ro" option. For servers, FALSE is returned.

Since 2.6

gnome_vfs_volume_is_user_visible ()

gboolean    gnome_vfs_volume_is_user_visible
                                            (GnomeVFSVolume *volume);

Returns whether the volume is visible to the user. This should be used by applications to determine whether it is included in user interfaces listing available volumes.

Since 2.6

gnome_vfs_volume_ref ()

GnomeVFSVolume* gnome_vfs_volume_ref        (GnomeVFSVolume *volume);

Increases the refcount of the volume by 1, if it is not NULL.

Since 2.6

gnome_vfs_volume_type_get_type ()

GType       gnome_vfs_volume_type_get_type  (void);

gnome_vfs_volume_unmount ()

void        gnome_vfs_volume_unmount        (GnomeVFSVolume *volume,
                                             GnomeVFSVolumeOpCallback callback,
                                             gpointer user_data);

Note that gnome_vfs_volume_unmount() may also invoke gnome_vfs_volume_eject(), if the volume signals that it should be ejected when it is unmounted. This may be true for CD-ROMs, USB sticks and other devices, depending on the backend providing the volume.

Since 2.6

gnome_vfs_volume_unref ()

void        gnome_vfs_volume_unref          (GnomeVFSVolume *volume);

Decreases the refcount of the volume by 1, if it is not NULL.

Since 2.6

gnome_vfs_connect_to_server ()

void        gnome_vfs_connect_to_server     (const char *uri,
                                             const char *display_name,
                                             const char *icon);

This function adds a server connection to the specified uri, which is displayed in user interfaces with the specified display_name and icon.

If this function is invoked successfully, the created server shows up in the list of mounted volumes of the GnomeVFSVolumeMonitor, which can be queried using gnome_vfs_volume_monitor_get_mounted_volumes().

Since 2.6