| UDisks Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Implemented Interfaces | Prerequisites | Known Implementations | Properties | Signals | ||||
UDisksFilesystemUDisksFilesystem — Generated C code for the org.freedesktop.UDisks2.Filesystem D-Bus interface |
UDisksFilesystem; struct UDisksFilesystemIface; GDBusInterfaceInfo * udisks_filesystem_interface_info (void); guint udisks_filesystem_override_properties (GObjectClass *klass,guint property_id_begin); void udisks_filesystem_call_mount (UDisksFilesystem *proxy,GVariant *arg_options,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data); gboolean udisks_filesystem_call_mount_finish (UDisksFilesystem *proxy,gchar **out_mount_path,GAsyncResult *res,GError **error); gboolean udisks_filesystem_call_mount_sync (UDisksFilesystem *proxy,GVariant *arg_options,gchar **out_mount_path,GCancellable *cancellable,GError **error); void udisks_filesystem_complete_mount (UDisksFilesystem *object,GDBusMethodInvocation *invocation,const gchar *mount_path); void udisks_filesystem_call_unmount (UDisksFilesystem *proxy,GVariant *arg_options,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data); gboolean udisks_filesystem_call_unmount_finish (UDisksFilesystem *proxy,GAsyncResult *res,GError **error); gboolean udisks_filesystem_call_unmount_sync (UDisksFilesystem *proxy,GVariant *arg_options,GCancellable *cancellable,GError **error); void udisks_filesystem_complete_unmount (UDisksFilesystem *object,GDBusMethodInvocation *invocation); void udisks_filesystem_call_set_label (UDisksFilesystem *proxy,const gchar *arg_label,GVariant *arg_options,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data); gboolean udisks_filesystem_call_set_label_finish (UDisksFilesystem *proxy,GAsyncResult *res,GError **error); gboolean udisks_filesystem_call_set_label_sync (UDisksFilesystem *proxy,const gchar *arg_label,GVariant *arg_options,GCancellable *cancellable,GError **error); void udisks_filesystem_complete_set_label (UDisksFilesystem *object,GDBusMethodInvocation *invocation); const gchar *const * udisks_filesystem_get_mount_points (UDisksFilesystem *object); gchar ** udisks_filesystem_dup_mount_points (UDisksFilesystem *object); void udisks_filesystem_set_mount_points (UDisksFilesystem *object,const gchar *const *value); struct UDisksFilesystemProxy; struct UDisksFilesystemProxyClass; void udisks_filesystem_proxy_new (GDBusConnection *connection,GDBusProxyFlags flags,const gchar *name,const gchar *object_path,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data); UDisksFilesystem * udisks_filesystem_proxy_new_finish (GAsyncResult *res,GError **error); UDisksFilesystem * udisks_filesystem_proxy_new_sync (GDBusConnection *connection,GDBusProxyFlags flags,const gchar *name,const gchar *object_path,GCancellable *cancellable,GError **error); void udisks_filesystem_proxy_new_for_bus (GBusType bus_type,GDBusProxyFlags flags,const gchar *name,const gchar *object_path,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data); UDisksFilesystem * udisks_filesystem_proxy_new_for_bus_finish (GAsyncResult *res,GError **error); UDisksFilesystem * udisks_filesystem_proxy_new_for_bus_sync (GBusType bus_type,GDBusProxyFlags flags,const gchar *name,const gchar *object_path,GCancellable *cancellable,GError **error); struct UDisksFilesystemSkeleton; struct UDisksFilesystemSkeletonClass; UDisksFilesystem * udisks_filesystem_skeleton_new (void);
GInterface +----UDisksFilesystem
GObject
+----GDBusProxy
+----UDisksFilesystemProxy
GObject
+----GDBusInterfaceSkeleton
+----UDisksFilesystemSkeleton
+----UDisksLinuxFilesystem
UDisksFilesystemProxy implements GDBusInterface, GInitable, GAsyncInitable and UDisksFilesystem.
UDisksFilesystemSkeleton implements GDBusInterface and UDisksFilesystem.
UDisksFilesystem is implemented by UDisksFilesystemProxy, UDisksFilesystemSkeleton and UDisksLinuxFilesystem.
This section contains code for working with the org.freedesktop.UDisks2.Filesystem D-Bus interface in C.
typedef struct _UDisksFilesystem UDisksFilesystem;
Abstract interface type for the D-Bus interface org.freedesktop.UDisks2.Filesystem.
struct UDisksFilesystemIface {
GTypeInterface parent_iface;
gboolean (*handle_mount) (
UDisksFilesystem *object,
GDBusMethodInvocation *invocation,
GVariant *arg_options);
gboolean (*handle_set_label) (
UDisksFilesystem *object,
GDBusMethodInvocation *invocation,
const gchar *arg_label,
GVariant *arg_options);
gboolean (*handle_unmount) (
UDisksFilesystem *object,
GDBusMethodInvocation *invocation,
GVariant *arg_options);
const gchar *const * (*get_mount_points) (UDisksFilesystem *object);
};
Virtual table for the D-Bus interface org.freedesktop.UDisks2.Filesystem.
| The parent interface. | |
| Handler for the "handle-mount" signal. | |
| Handler for the "handle-set-label" signal. | |
| Handler for the "handle-unmount" signal. | |
| Getter for the "mount-points" property. |
GDBusInterfaceInfo * udisks_filesystem_interface_info (void);
Gets a machine-readable description of the org.freedesktop.UDisks2.Filesystem D-Bus interface.
Returns : |
A GDBusInterfaceInfo. Do not free. [transfer none] |
guint udisks_filesystem_override_properties (GObjectClass *klass,guint property_id_begin);
Overrides all GObject properties in the UDisksFilesystem interface for a concrete class. The properties are overridden in the order they are defined.
|
The class structure for a GObject-derived class. |
|
The property id to assign to the first overridden property. |
Returns : |
The last property id. |
void udisks_filesystem_call_mount (UDisksFilesystem *proxy,GVariant *arg_options,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data);
Asynchronously invokes the Mount() D-Bus method on proxy.
When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from.
You can then call udisks_filesystem_call_mount_finish() to get the result of the operation.
See udisks_filesystem_call_mount_sync() for the synchronous, blocking version of this method.
|
A UDisksFilesystemProxy. |
|
Argument to pass with the method invocation. |
|
A GCancellable or NULL. [allow-none]
|
|
A GAsyncReadyCallback to call when the request is satisfied or NULL. |
|
User data to pass to callback. |
gboolean udisks_filesystem_call_mount_finish (UDisksFilesystem *proxy,gchar **out_mount_path,GAsyncResult *res,GError **error);
Finishes an operation started with udisks_filesystem_call_mount().
|
A UDisksFilesystemProxy. |
|
Return location for return parameter or NULL to ignore. [out]
|
|
The GAsyncResult obtained from the GAsyncReadyCallback passed to udisks_filesystem_call_mount(). |
|
Return location for error or NULL. |
Returns : |
TRUE if the call succeded, FALSE if error is set. [skip]
|
gboolean udisks_filesystem_call_mount_sync (UDisksFilesystem *proxy,GVariant *arg_options,gchar **out_mount_path,GCancellable *cancellable,GError **error);
Synchronously invokes the Mount() D-Bus method on proxy. The calling thread is blocked until a reply is received.
See udisks_filesystem_call_mount() for the asynchronous version of this method.
|
A UDisksFilesystemProxy. |
|
Argument to pass with the method invocation. |
|
Return location for return parameter or NULL to ignore. [out]
|
|
A GCancellable or NULL. [allow-none]
|
|
Return location for error or NULL. |
Returns : |
TRUE if the call succeded, FALSE if error is set. [skip]
|
void udisks_filesystem_complete_mount (UDisksFilesystem *object,GDBusMethodInvocation *invocation,const gchar *mount_path);
Helper function used in service implementations to finish handling invocations of the Mount() D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.
This method will free invocation, you cannot use it afterwards.
|
A UDisksFilesystem. |
|
A GDBusMethodInvocation. [transfer full] |
|
Parameter to return. |
void udisks_filesystem_call_unmount (UDisksFilesystem *proxy,GVariant *arg_options,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data);
Asynchronously invokes the Unmount() D-Bus method on proxy.
When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from.
You can then call udisks_filesystem_call_unmount_finish() to get the result of the operation.
See udisks_filesystem_call_unmount_sync() for the synchronous, blocking version of this method.
|
A UDisksFilesystemProxy. |
|
Argument to pass with the method invocation. |
|
A GCancellable or NULL. [allow-none]
|
|
A GAsyncReadyCallback to call when the request is satisfied or NULL. |
|
User data to pass to callback. |
gboolean udisks_filesystem_call_unmount_finish (UDisksFilesystem *proxy,GAsyncResult *res,GError **error);
Finishes an operation started with udisks_filesystem_call_unmount().
|
A UDisksFilesystemProxy. |
|
The GAsyncResult obtained from the GAsyncReadyCallback passed to udisks_filesystem_call_unmount(). |
|
Return location for error or NULL. |
Returns : |
TRUE if the call succeded, FALSE if error is set. [skip]
|
gboolean udisks_filesystem_call_unmount_sync (UDisksFilesystem *proxy,GVariant *arg_options,GCancellable *cancellable,GError **error);
Synchronously invokes the Unmount() D-Bus method on proxy. The calling thread is blocked until a reply is received.
See udisks_filesystem_call_unmount() for the asynchronous version of this method.
|
A UDisksFilesystemProxy. |
|
Argument to pass with the method invocation. |
|
A GCancellable or NULL. [allow-none]
|
|
Return location for error or NULL. |
Returns : |
TRUE if the call succeded, FALSE if error is set. [skip]
|
void udisks_filesystem_complete_unmount (UDisksFilesystem *object,GDBusMethodInvocation *invocation);
Helper function used in service implementations to finish handling invocations of the Unmount() D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.
This method will free invocation, you cannot use it afterwards.
|
A UDisksFilesystem. |
|
A GDBusMethodInvocation. [transfer full] |
void udisks_filesystem_call_set_label (UDisksFilesystem *proxy,const gchar *arg_label,GVariant *arg_options,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data);
Asynchronously invokes the SetLabel() D-Bus method on proxy.
When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from.
You can then call udisks_filesystem_call_set_label_finish() to get the result of the operation.
See udisks_filesystem_call_set_label_sync() for the synchronous, blocking version of this method.
|
A UDisksFilesystemProxy. |
|
Argument to pass with the method invocation. |
|
Argument to pass with the method invocation. |
|
A GCancellable or NULL. [allow-none]
|
|
A GAsyncReadyCallback to call when the request is satisfied or NULL. |
|
User data to pass to callback. |
gboolean udisks_filesystem_call_set_label_finish (UDisksFilesystem *proxy,GAsyncResult *res,GError **error);
Finishes an operation started with udisks_filesystem_call_set_label().
|
A UDisksFilesystemProxy. |
|
The GAsyncResult obtained from the GAsyncReadyCallback passed to udisks_filesystem_call_set_label(). |
|
Return location for error or NULL. |
Returns : |
TRUE if the call succeded, FALSE if error is set. [skip]
|
gboolean udisks_filesystem_call_set_label_sync (UDisksFilesystem *proxy,const gchar *arg_label,GVariant *arg_options,GCancellable *cancellable,GError **error);
Synchronously invokes the SetLabel() D-Bus method on proxy. The calling thread is blocked until a reply is received.
See udisks_filesystem_call_set_label() for the asynchronous version of this method.
|
A UDisksFilesystemProxy. |
|
Argument to pass with the method invocation. |
|
Argument to pass with the method invocation. |
|
A GCancellable or NULL. [allow-none]
|
|
Return location for error or NULL. |
Returns : |
TRUE if the call succeded, FALSE if error is set. [skip]
|
void udisks_filesystem_complete_set_label (UDisksFilesystem *object,GDBusMethodInvocation *invocation);
Helper function used in service implementations to finish handling invocations of the SetLabel() D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.
This method will free invocation, you cannot use it afterwards.
|
A UDisksFilesystem. |
|
A GDBusMethodInvocation. [transfer full] |
const gchar *const * udisks_filesystem_get_mount_points (UDisksFilesystem *object);
Gets the value of the "MountPoints" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
object was constructed. Use udisks_filesystem_dup_mount_points() if on another thread.
|
A UDisksFilesystem. |
Returns : |
The property value or NULL if the property is not set. Do not free the returned value, it belongs to object. [transfer none]
|
gchar ** udisks_filesystem_dup_mount_points (UDisksFilesystem *object);
Gets a copy of the "MountPoints" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
|
A UDisksFilesystem. |
Returns : |
The property value or NULL if the property is not set. The returned value should be freed with g_strfreev(). [transfer full]
|
void udisks_filesystem_set_mount_points (UDisksFilesystem *object,const gchar *const *value);
Sets the "MountPoints" D-Bus property to value.
Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side.
|
A UDisksFilesystem. |
|
The value to set. |
struct UDisksFilesystemProxy;
The UDisksFilesystemProxy structure contains only private data and should only be accessed using the provided API.
struct UDisksFilesystemProxyClass {
GDBusProxyClass parent_class;
};
Class structure for UDisksFilesystemProxy.
void udisks_filesystem_proxy_new (GDBusConnection *connection,GDBusProxyFlags flags,const gchar *name,const gchar *object_path,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data);
Asynchronously creates a proxy for the D-Bus interface org.freedesktop.UDisks2.Filesystem. See g_dbus_proxy_new() for more details.
When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from.
You can then call udisks_filesystem_proxy_new_finish() to get the result of the operation.
See udisks_filesystem_proxy_new_sync() for the synchronous, blocking version of this constructor.
|
A GDBusConnection. |
|
Flags from the GDBusProxyFlags enumeration. |
|
A bus name (well-known or unique) or NULL if connection is not a message bus connection. [allow-none]
|
|
An object path. |
|
A GCancellable or NULL. [allow-none]
|
|
A GAsyncReadyCallback to call when the request is satisfied. |
|
User data to pass to callback. |
UDisksFilesystem * udisks_filesystem_proxy_new_finish (GAsyncResult *res,GError **error);
Finishes an operation started with udisks_filesystem_proxy_new().
|
The GAsyncResult obtained from the GAsyncReadyCallback passed to udisks_filesystem_proxy_new(). |
|
Return location for error or NULL
|
Returns : |
The constructed proxy object or NULL if error is set. [transfer full][type UDisksFilesystemProxy]
|
UDisksFilesystem * udisks_filesystem_proxy_new_sync (GDBusConnection *connection,GDBusProxyFlags flags,const gchar *name,const gchar *object_path,GCancellable *cancellable,GError **error);
Synchronously creates a proxy for the D-Bus interface org.freedesktop.UDisks2.Filesystem. See g_dbus_proxy_new_sync() for more details.
The calling thread is blocked until a reply is received.
See udisks_filesystem_proxy_new() for the asynchronous version of this constructor.
|
A GDBusConnection. |
|
Flags from the GDBusProxyFlags enumeration. |
|
A bus name (well-known or unique) or NULL if connection is not a message bus connection. [allow-none]
|
|
An object path. |
|
A GCancellable or NULL. [allow-none]
|
|
Return location for error or NULL
|
Returns : |
The constructed proxy object or NULL if error is set. [transfer full][type UDisksFilesystemProxy]
|
void udisks_filesystem_proxy_new_for_bus (GBusType bus_type,GDBusProxyFlags flags,const gchar *name,const gchar *object_path,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data);
Like udisks_filesystem_proxy_new() but takes a GBusType instead of a GDBusConnection.
When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from.
You can then call udisks_filesystem_proxy_new_for_bus_finish() to get the result of the operation.
See udisks_filesystem_proxy_new_for_bus_sync() for the synchronous, blocking version of this constructor.
|
A GBusType. |
|
Flags from the GDBusProxyFlags enumeration. |
|
A bus name (well-known or unique). |
|
An object path. |
|
A GCancellable or NULL. [allow-none]
|
|
A GAsyncReadyCallback to call when the request is satisfied. |
|
User data to pass to callback. |
UDisksFilesystem * udisks_filesystem_proxy_new_for_bus_finish (GAsyncResult *res,GError **error);
Finishes an operation started with udisks_filesystem_proxy_new_for_bus().
|
The GAsyncResult obtained from the GAsyncReadyCallback passed to udisks_filesystem_proxy_new_for_bus(). |
|
Return location for error or NULL
|
Returns : |
The constructed proxy object or NULL if error is set. [transfer full][type UDisksFilesystemProxy]
|
UDisksFilesystem * udisks_filesystem_proxy_new_for_bus_sync (GBusType bus_type,GDBusProxyFlags flags,const gchar *name,const gchar *object_path,GCancellable *cancellable,GError **error);
Like udisks_filesystem_proxy_new_sync() but takes a GBusType instead of a GDBusConnection.
The calling thread is blocked until a reply is received.
See udisks_filesystem_proxy_new_for_bus() for the asynchronous version of this constructor.
|
A GBusType. |
|
Flags from the GDBusProxyFlags enumeration. |
|
A bus name (well-known or unique). |
|
An object path. |
|
A GCancellable or NULL. [allow-none]
|
|
Return location for error or NULL
|
Returns : |
The constructed proxy object or NULL if error is set. [transfer full][type UDisksFilesystemProxy]
|
struct UDisksFilesystemSkeleton;
The UDisksFilesystemSkeleton structure contains only private data and should only be accessed using the provided API.
struct UDisksFilesystemSkeletonClass {
GDBusInterfaceSkeletonClass parent_class;
};
Class structure for UDisksFilesystemSkeleton.
UDisksFilesystem * udisks_filesystem_skeleton_new (void);
Creates a skeleton object for the D-Bus interface org.freedesktop.UDisks2.Filesystem.
Returns : |
The skeleton object. [transfer full][type UDisksFilesystemSkeleton] |
"mount-points" property "mount-points" GStrv : Read / Write
Represents the D-Bus property "MountPoints".
Since the D-Bus property for this GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.
"handle-mount" signalgboolean user_function (UDisksFilesystem *object,
GDBusMethodInvocation *invocation,
GVariant *arg_options,
gpointer user_data) : Run Last
Signal emitted when a remote caller is invoking the Mount() D-Bus method.
If a signal handler returns TRUE, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call udisks_filesystem_complete_mount() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the G_DBUS_ERROR_UNKNOWN_METHOD error is returned.
|
A UDisksFilesystem. |
|
A GDBusMethodInvocation. |
|
Argument passed by remote caller. |
|
user data set when the signal handler was connected. |
Returns : |
TRUE if the invocation was handled, FALSE to let other signal handlers run. |
"handle-set-label" signalgboolean user_function (UDisksFilesystem *object,
GDBusMethodInvocation *invocation,
gchar *arg_label,
GVariant *arg_options,
gpointer user_data) : Run Last
Signal emitted when a remote caller is invoking the SetLabel() D-Bus method.
If a signal handler returns TRUE, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call udisks_filesystem_complete_set_label() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the G_DBUS_ERROR_UNKNOWN_METHOD error is returned.
|
A UDisksFilesystem. |
|
A GDBusMethodInvocation. |
|
Argument passed by remote caller. |
|
Argument passed by remote caller. |
|
user data set when the signal handler was connected. |
Returns : |
TRUE if the invocation was handled, FALSE to let other signal handlers run. |
"handle-unmount" signalgboolean user_function (UDisksFilesystem *object,
GDBusMethodInvocation *invocation,
GVariant *arg_options,
gpointer user_data) : Run Last
Signal emitted when a remote caller is invoking the Unmount() D-Bus method.
If a signal handler returns TRUE, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call udisks_filesystem_complete_unmount() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the G_DBUS_ERROR_UNKNOWN_METHOD error is returned.
|
A UDisksFilesystem. |
|
A GDBusMethodInvocation. |
|
Argument passed by remote caller. |
|
user data set when the signal handler was connected. |
Returns : |
TRUE if the invocation was handled, FALSE to let other signal handlers run. |