g_mount_operation_new ()

GMountOperation *
g_mount_operation_new (void);

Creates a new mount operation.

g_mount_operation_get_username ()

const char *
g_mount_operation_get_username (GMountOperation *op);

Get the user name from the mount operation.

g_mount_operation_set_username ()

void
g_mount_operation_set_username (GMountOperation *op,
                                const char *username);

Sets the user name within op to username .

g_mount_operation_get_password ()

const char *
g_mount_operation_get_password (GMountOperation *op);

Gets a password from the mount operation.

g_mount_operation_set_password ()

void
g_mount_operation_set_password (GMountOperation *op,
                                const char *password);

Sets the mount operation's password to password .

g_mount_operation_get_anonymous ()

gboolean
g_mount_operation_get_anonymous (GMountOperation *op);

Check to see whether the mount operation is being used for an anonymous user.

g_mount_operation_set_anonymous ()

void
g_mount_operation_set_anonymous (GMountOperation *op,
                                 gboolean anonymous);

Sets the mount operation to use an anonymous user if anonymous is TRUE.

g_mount_operation_get_domain ()

const char *
g_mount_operation_get_domain (GMountOperation *op);

Gets the domain of the mount operation.

g_mount_operation_set_domain ()

void
g_mount_operation_set_domain (GMountOperation *op,
                              const char *domain);

Sets the mount operation's domain.

g_mount_operation_get_password_save ()

GPasswordSave
g_mount_operation_get_password_save (GMountOperation *op);

Gets the state of saving passwords for the mount operation.

g_mount_operation_set_password_save ()

void
g_mount_operation_set_password_save (GMountOperation *op,
                                     GPasswordSave save);

Sets the state of saving passwords for the mount operation.

g_mount_operation_get_choice ()

int
g_mount_operation_get_choice (GMountOperation *op);

Gets a choice from the mount operation.

g_mount_operation_set_choice ()

void
g_mount_operation_set_choice (GMountOperation *op,
                              int choice);

Sets a default choice for the mount operation.

g_mount_operation_get_is_tcrypt_hidden_volume ()

gboolean
g_mount_operation_get_is_tcrypt_hidden_volume
                               (GMountOperation *op);

Check to see whether the mount operation is being used for a TCRYPT hidden volume.

Since: 2.58

g_mount_operation_set_is_tcrypt_hidden_volume ()

void
g_mount_operation_set_is_tcrypt_hidden_volume
                               (GMountOperation *op,
                                gboolean hidden_volume);

Sets the mount operation to use a hidden volume if hidden_volume is TRUE.

Since: 2.58

g_mount_operation_get_is_tcrypt_system_volume ()

gboolean
g_mount_operation_get_is_tcrypt_system_volume
                               (GMountOperation *op);

Check to see whether the mount operation is being used for a TCRYPT system volume.

Since: 2.58

g_mount_operation_set_is_tcrypt_system_volume ()

void
g_mount_operation_set_is_tcrypt_system_volume
                               (GMountOperation *op,
                                gboolean system_volume);

Sets the mount operation to use a system volume if system_volume is TRUE.

Since: 2.58

g_mount_operation_get_pim ()

guint
g_mount_operation_get_pim (GMountOperation *op);

Gets a PIM from the mount operation.

Since: 2.58

g_mount_operation_set_pim ()

void
g_mount_operation_set_pim (GMountOperation *op,
                           guint pim);

Sets the mount operation's PIM to pim .

Since: 2.58

g_mount_operation_reply ()

void
g_mount_operation_reply (GMountOperation *op,
                         GMountOperationResult result);

Emits the “reply” signal.

enum GAskPasswordFlags

GAskPasswordFlags are used to request specific information from the user, or to notify the user of their choices in an authentication situation.

enum GPasswordSave

GPasswordSave is used to indicate the lifespan of a saved password.

Gvfs stores passwords in the Gnome keyring when this flag allows it to, and later retrieves it again from there.

GMountOperation

typedef struct _GMountOperation GMountOperation;

Class for providing authentication methods for mounting operations, such as mounting a file locally, or authenticating with a server.

enum GMountOperationResult

GMountOperationResult is returned as a result when a request for information is send by the mounting operation.

The “anonymous” property

  “anonymous”                gboolean

Whether to use an anonymous user when authenticating.

Owner: GMountOperation

Flags: Read / Write

Default value: FALSE

The “choice” property

  “choice”                   int

The index of the user's choice when a question is asked during the mount operation. See the “ask-question” signal.

Owner: GMountOperation

Flags: Read / Write

Allowed values: >= 0

Default value: 0

The “domain” property

  “domain”                   char *

The domain to use for the mount operation.

Owner: GMountOperation

Flags: Read / Write

Default value: NULL

The “is-tcrypt-hidden-volume” property

  “is-tcrypt-hidden-volume”  gboolean

Whether the device to be unlocked is a TCRYPT hidden volume. See the VeraCrypt documentation.

Owner: GMountOperation

Flags: Read / Write

Default value: FALSE

Since: 2.58

The “is-tcrypt-system-volume” property

  “is-tcrypt-system-volume”  gboolean

Whether the device to be unlocked is a TCRYPT system volume. In this context, a system volume is a volume with a bootloader and operating system installed. This is only supported for Windows operating systems. For further documentation, see the VeraCrypt documentation.

Owner: GMountOperation

Flags: Read / Write

Default value: FALSE

Since: 2.58

The “password” property

  “password”                 char *

The password that is used for authentication when carrying out the mount operation.

Owner: GMountOperation

Flags: Read / Write

Default value: NULL

The “password-save” property

  “password-save”            GPasswordSave

Determines if and how the password information should be saved.

Owner: GMountOperation

Flags: Read / Write

Default value: G_PASSWORD_SAVE_NEVER

The “pim” property

  “pim”                      guint

The VeraCrypt PIM value, when unlocking a VeraCrypt volume. See the VeraCrypt documentation.html).

Owner: GMountOperation

Flags: Read / Write

Default value: 0

Since: 2.58

The “username” property

  “username”                 char *

The user name that is used for authentication when carrying out the mount operation.

Owner: GMountOperation

Flags: Read / Write

Default value: NULL

The “aborted” signal

void
user_function (GMountOperation *gmountoperation,
               gpointer         user_data)

Emitted by the backend when e.g. a device becomes unavailable while a mount operation is in progress.

Implementations of GMountOperation should handle this signal by dismissing open password dialogs.

Flags: Run Last

Since: 2.20

The “ask-password” signal

void
user_function (GMountOperation  *op,
               char             *message,
               char             *default_user,
               char             *default_domain,
               GAskPasswordFlags flags,
               gpointer          user_data)

Emitted when a mount operation asks the user for a password.

If the message contains a line break, the first line should be presented as a heading. For example, it may be used as the primary text in a GtkMessageDialog.

Flags: Run Last

The “ask-question” signal

void
user_function (GMountOperation *op,
               char            *message,
               GStrv            choices,
               gpointer         user_data)

Emitted when asking the user a question and gives a list of choices for the user to choose from.

If the message contains a line break, the first line should be presented as a heading. For example, it may be used as the primary text in a GtkMessageDialog.

Flags: Run Last

The “reply” signal

void
user_function (GMountOperation      *op,
               GMountOperationResult result,
               gpointer              user_data)

Emitted when the user has replied to the mount operation.

Flags: Run Last

The “show-processes” signal

void
user_function (GMountOperation *op,
               char            *message,
               GArray          *processes,
               GStrv            choices,
               gpointer         user_data)

Emitted when one or more processes are blocking an operation e.g. unmounting/ejecting a GMount or stopping a GDrive.

Note that this signal may be emitted several times to update the list of blocking processes as processes close files. The application should only respond with g_mount_operation_reply() to the latest signal (setting “choice” to the choice the user made).

If the message contains a line break, the first line should be presented as a heading. For example, it may be used as the primary text in a GtkMessageDialog.

Flags: Run Last

Since: 2.22

The “show-unmount-progress” signal

void
user_function (GMountOperation *op,
               char            *message,
               gint64           time_left,
               gint64           bytes_left,
               gpointer         user_data)

Emitted when an unmount operation has been busy for more than some time (typically 1.5 seconds).

When unmounting or ejecting a volume, the kernel might need to flush pending data in its buffers to the volume stable storage, and this operation can take a considerable amount of time. This signal may be emitted several times as long as the unmount operation is outstanding, and then one last time when the operation is completed, with bytes_left set to zero.

Implementations of GMountOperation should handle this signal by showing an UI notification, and then dismiss it, or show another notification of completion, when bytes_left reaches zero.

If the message contains a line break, the first line should be presented as a heading. For example, it may be used as the primary text in a GtkMessageDialog.

Flags: Run Last

Since: 2.34