### Start Source: https://storaged.org/doc/udisks2-api/latest/gdbus-org.freedesktop.UDisks2.MDRaid.html Starts the RAID array. ```APIDOC ## Start ### Description Starts the RAID array. ### Parameters - **options** (a{sv}) - Required - Options for the operation. ``` -------------------------------- ### Start() Source: https://storaged.org/doc/udisks2-api/latest/gdbus-org.freedesktop.UDisks2.MDRaid.html Starts the RAID array. Supports an optional 'start-degraded' boolean flag to allow starting even if some members are missing. ```APIDOC ## Start(a{sv} options) ### Description Starts the RAID array. If the options parameter contains the key 'start-degraded' with the value TRUE, the array will be started even if some members are missing. ### Parameters - **options** (a{sv}) - Required - Options including 'start-degraded' (boolean). ``` -------------------------------- ### Start() Source: https://storaged.org/doc/udisks2-api/latest/gdbus-org.freedesktop.UDisks2.Swapspace.html Activates the swap device. ```APIDOC ## Start(IN a{sv} options) ### Description Activates the swap device. ### Parameters - **options** (a{sv}) - Required - Options (currently unused except for standard options). ``` -------------------------------- ### org.freedesktop.UDisks2.MDRaid.Start() Source: https://storaged.org/doc/udisks2-api/latest/api-index.html Starts the MD RAID array. ```APIDOC ## org.freedesktop.UDisks2.MDRaid.Start() ### Description Starts the MD RAID array. ``` -------------------------------- ### SmartSelftestStart Source: https://storaged.org/doc/udisks2-api/latest/gdbus-org.freedesktop.UDisks2.Drive.Ata.html Starts a SMART self-test on the drive. ```APIDOC ## SmartSelftestStart ### Description Starts a SMART self-test on the drive. ### Parameters - **type** (s) - The type of self-test to perform. - **options** (a{sv}) - Options for the operation. ``` -------------------------------- ### Start RAID Array Source: https://storaged.org/doc/udisks2-api/latest/gdbus-org.freedesktop.UDisks2.MDRaid.html Starts the RAID array. Use the 'start-degraded' option to allow starting even if some members are missing. ```text Start (IN a{sv} options); ``` -------------------------------- ### Start Swapspace Asynchronously Source: https://storaged.org/doc/udisks2-api/latest/UDisksSwapspace.html Initiates the Start() D-Bus method call asynchronously. ```c void udisks_swapspace_call_start (_UDisksSwapspace *proxy_, _GVariant *arg_options_, _GCancellable *cancellable_, _GAsyncReadyCallback callback_, _gpointer user_data_); ``` -------------------------------- ### udisks_provider_start Function Source: https://storaged.org/doc/udisks2-api/latest/UDisksProvider.html Starts the provider instance. ```c void udisks_provider_start (_UDisksProvider *provider_); ``` -------------------------------- ### Start Swapspace Synchronously Source: https://storaged.org/doc/udisks2-api/latest/UDisksSwapspace.html Invokes the Start() D-Bus method synchronously, blocking the calling thread until completion. ```c gboolean udisks_swapspace_call_start_sync (_UDisksSwapspace *proxy_, _GVariant *arg_options_, _GCancellable *cancellable_, _GError **error_); ``` -------------------------------- ### org.freedesktop.UDisks2.Drive.Ata.SmartSelftestStart() Source: https://storaged.org/doc/udisks2-api/latest/api-index.html Starts a S.M.A.R.T. self-test on the ATA drive. ```APIDOC ## org.freedesktop.UDisks2.Drive.Ata.SmartSelftestStart() ### Description Starts a S.M.A.R.T. self-test on the ATA drive. ``` -------------------------------- ### udisks_provider_start Source: https://storaged.org/doc/udisks2-api/latest/UDisksProvider.html Starts the specified UDisksProvider instance. ```APIDOC ## void udisks_provider_start (UDisksProvider *provider) ### Description Starts the provider. ### Parameters - **provider** (UDisksProvider*) - Required - A UDisksProvider instance. ``` -------------------------------- ### Complete Start method invocation Source: https://storaged.org/doc/udisks2-api/latest/UDisksMDRaid.html Helper for service implementations to finalize handling of a Start D-Bus method invocation. ```c void udisks_mdraid_complete_start (_UDisksMDRaid *object_, _GDBusMethodInvocation *invocation_); ``` -------------------------------- ### udisks_spawned_job_start Source: https://storaged.org/doc/udisks2-api/latest/UDisksSpawnedJob.html Starts the execution of the spawned job. ```APIDOC ## udisks_spawned_job_start ### Description Starts the job. Connect to the “spawned-job-completed” or “completed” signals to get notified when the job is done. ### Signature void udisks_spawned_job_start (UDisksSpawnedJob *job); ### Parameters - **job** (UDisksSpawnedJob *) - The job to start. ``` -------------------------------- ### org.freedesktop.UDisks2.Manager.LoopSetup() Source: https://storaged.org/doc/udisks2-api/latest/api-index.html Sets up a new loop device. ```APIDOC ## org.freedesktop.UDisks2.Manager.LoopSetup() ### Description Sets up a new loop device using the UDisks2 Manager interface. ### Method Method call on D-Bus interface org.freedesktop.UDisks2.Manager ``` -------------------------------- ### org.freedesktop.UDisks2.Swapspace.Start() Source: https://storaged.org/doc/udisks2-api/latest/api-index.html Activates the swapspace. ```APIDOC ## org.freedesktop.UDisks2.Swapspace.Start() ### Description Starts (activates) the swapspace. ### Method D-Bus Method Call ``` -------------------------------- ### Handle Start Signal Source: https://storaged.org/doc/udisks2-api/latest/UDisksSwapspace.html Signal handler for the Start D-Bus method invocation. ```C gboolean user_function (UDisksSwapspace *object, GDBusMethodInvocation *invocation, GVariant *arg_options, gpointer user_data) ``` -------------------------------- ### Finish Start Operation Source: https://storaged.org/doc/udisks2-api/latest/UDisksSwapspace.html Completes the asynchronous Start() operation and retrieves the result. ```c gboolean udisks_swapspace_call_start_finish (_UDisksSwapspace *proxy_, _GAsyncResult *res_, _GError **error_); ``` -------------------------------- ### LoopSetup Method Source: https://storaged.org/doc/udisks2-api/latest/gdbus-org.freedesktop.UDisks2.Manager.html Creates a block device for a given file descriptor. ```D-Bus LoopSetup (IN h fd, IN a{sv} options, OUT o resulting_device); ``` -------------------------------- ### Finish asynchronous Start operation Source: https://storaged.org/doc/udisks2-api/latest/UDisksMDRaid.html Completes an asynchronous Start operation initiated by udisks_mdraid_call_start(). ```c gboolean udisks_mdraid_call_start_finish (_UDisksMDRaid *proxy_, _GAsyncResult *res_, _GError **error_); ``` -------------------------------- ### Sample UDisks2 Configuration File Source: https://storaged.org/doc/udisks2-api/latest/mount_options.html A basic example of the configuration file structure used for defining default mount options. ```ini [defaults] ``` -------------------------------- ### Synchronously invoke Start method Source: https://storaged.org/doc/udisks2-api/latest/UDisksMDRaid.html Blocks the calling thread until the Start D-Bus method completes on the proxy. ```c gboolean udisks_mdraid_call_start_sync (_UDisksMDRaid *proxy_, _GVariant *arg_options_, _GCancellable *cancellable_, _GError **error_); ``` -------------------------------- ### Finish SMART self-test start operation Source: https://storaged.org/doc/udisks2-api/latest/UDisksDriveAta.html Completes an asynchronous SMART self-test start operation initiated by udisks_drive_ata_call_smart_selftest_start(). ```c gboolean udisks_drive_ata_call_smart_selftest_start_finish (_UDisksDriveAta *proxy_, _GAsyncResult *res_, _GError **error_); ``` -------------------------------- ### Create a new UDisksLinuxNVMeFabrics instance Source: https://storaged.org/doc/udisks2-api/latest/udisks2-UDisksLinuxNVMeFabrics.html Initializes a new instance. The returned object must be freed using g_object_unref(). ```c UDisksNVMeFabrics * udisks_linux_nvme_fabrics_new (void); ``` -------------------------------- ### Asynchronously start a RAID array Source: https://storaged.org/doc/udisks2-api/latest/UDisksMDRaid.html Invokes the Start D-Bus method asynchronously. Use the corresponding finish function to retrieve the result. ```c void udisks_mdraid_call_start (_UDisksMDRaid *proxy_, _GVariant *arg_options_, _GCancellable *cancellable_, _GAsyncReadyCallback callback_, _gpointer user_data_); ``` -------------------------------- ### Check Device Setup by User Source: https://storaged.org/doc/udisks2-api/latest/udisks2-Utilities.html Verifies if a specific device object has been set up by the given user ID. ```C gboolean udisks_daemon_util_setup_by_user (_UDisksDaemon *daemon_, _UDisksObject *object_, _uid_t user_); ``` -------------------------------- ### udisks_linux_drive_object_get_siblings Source: https://storaged.org/doc/udisks2-api/latest/UDisksLinuxDriveObject.html Gets the siblings for the object, if any. ```APIDOC ## udisks_linux_drive_object_get_siblings ### Description Gets the siblings for the object, if any. ### Parameters - **object** (UDisksLinuxDriveObject) - Required - The drive object. ### Returns A GList of UDisksLinuxDriveObject instances. The returned list should be freed with g_list_free() after each element has been freed with g_object_unref(). ``` -------------------------------- ### Create Asynchronous Filesystem Proxy Source: https://storaged.org/doc/udisks2-api/latest/UDisksFilesystem.html Asynchronously initializes a proxy for the org.freedesktop.UDisks2.Filesystem interface. ```c void udisks_filesystem_proxy_new (_GDBusConnection *connection_, _GDBusProxyFlags flags_, _const gchar *name_, _const gchar *object_path_, _GCancellable *cancellable_, _GAsyncReadyCallback callback_, _gpointer user_data_); ``` -------------------------------- ### udisks_client_get_drive_siblings Source: https://storaged.org/doc/udisks2-api/latest/UDisksClient.html Gets all siblings for a drive. ```APIDOC ## udisks_client_get_drive_siblings ### Description Gets all siblings for the specified drive. ### Parameters - **client** (UDisksClient) - Required - A UDisksClient. - **drive** (UDisksDrive) - Required - A UDisksDrive. ### Returns A list of UDisksDrive instances. The returned list should be freed with g_list_free() after each element has been freed with g_object_unref(). ``` -------------------------------- ### SmartSelftestStart Source: https://storaged.org/doc/udisks2-api/latest/gdbus-org.freedesktop.UDisks2.NVMe.Controller.html Starts a device selftest operation on all active namespaces accessible through the controller. ```APIDOC ## SmartSelftestStart(IN s type, IN a{sv} options) ### Description Starts a device selftest operation on all active namespaces accessible through the controller. The operation runs in the background. ### Parameters - **type** (s) - Required - The type of test to run (valid values: 'short', 'extended', 'vendor-specific'). - **options** (a{sv}) - Required - Options for the operation. ``` -------------------------------- ### udisks_client_get_manager Source: https://storaged.org/doc/udisks2-api/latest/UDisksClient.html Gets the UDisksManager interface. ```APIDOC ## udisks_client_get_manager ### Description Retrieves the UDisksManager interface on the well-known /org/freedesktop/UDisks2/Manager object. ### Parameters - **client** (UDisksClient) - Required - The UDisksClient instance. ### Returns - **UDisksManager** - The manager interface, or NULL if the daemon is not running. ``` -------------------------------- ### Create a new UDisksLinuxDrive instance Source: https://storaged.org/doc/udisks2-api/latest/UDisksLinuxDrive.html Initializes a new instance of the drive. The returned object must be freed using g_object_unref(). ```c UDisksDrive * udisks_linux_drive_new (_void_); ``` -------------------------------- ### udisks_volume_group_call_remove_device_finish Source: https://storaged.org/doc/udisks2-api/latest/UDisksVolumeGroup.html Finishes an operation started with udisks_volume_group_call_remove_device(). ```APIDOC ## udisks_volume_group_call_remove_device_finish ### Description Finishes an operation started with udisks_volume_group_call_remove_device(). ### Parameters - **proxy** (_UDisksVolumeGroup*) - Required - A UDisksVolumeGroupProxy. - **res** (_GAsyncResult*) - Required - The GAsyncResult obtained from the GAsyncReadyCallback. - **error** (_GError**) - Required - Return location for error or NULL. ### Returns - **gboolean** - TRUE if the call succeeded, FALSE if error is set. ``` -------------------------------- ### PartitionTable Methods Source: https://storaged.org/doc/udisks2-api/latest/gdbus-org.freedesktop.UDisks2.PartitionTable.html Methods available for creating partitions and formatting them on a block device. ```dbus CreatePartition (IN t offset, IN t size, IN s type, IN s name, IN a{sv} options, OUT o created_partition); CreatePartitionAndFormat (IN t offset, IN t size, IN s type, IN s name, IN a{sv} options, IN s format_type, IN a{sv} format_options, OUT o created_partition); ``` -------------------------------- ### udisks_volume_group_call_delete_finish Source: https://storaged.org/doc/udisks2-api/latest/UDisksVolumeGroup.html Finishes an operation started with udisks_volume_group_call_delete. ```APIDOC ## udisks_volume_group_call_delete_finish ### Description Finishes an operation started with `udisks_volume_group_call_delete()`. ### Parameters - **proxy** (_UDisksVolumeGroup*) - A UDisksVolumeGroupProxy. - **res** (_GAsyncResult*) - The GAsyncResult obtained from the GAsyncReadyCallback. - **error** (_GError**) - Return location for error or NULL. ### Returns `TRUE` if the call succeeded, `FALSE` if error is set. ``` -------------------------------- ### Create a new UDisksLinuxFilesystem instance Source: https://storaged.org/doc/udisks2-api/latest/UDisksLinuxFilesystem.html Initializes a new instance of the filesystem interface. The returned object must be freed using g_object_unref(). ```c UDisksFilesystem * udisks_linux_filesystem_new (_void_); ``` -------------------------------- ### udisks_nvme_controller_call_smart_selftest_start Source: https://storaged.org/doc/udisks2-api/latest/UDisksNVMeController.html Asynchronously invokes the SmartSelftestStart D-Bus method on the provided proxy. ```APIDOC ## udisks_nvme_controller_call_smart_selftest_start ### Description Asynchronously invokes the `SmartSelftestStart()` D-Bus method on the proxy. When the operation finishes, the provided callback is invoked. ### Parameters - **proxy** (_UDisksNVMeController*) - A UDisksNVMeControllerProxy. - **arg_type** (_const gchar*) - Argument to pass with the method invocation. - **arg_options** (_GVariant*) - Argument to pass with the method invocation. - **cancellable** (_GCancellable*) - A GCancellable or NULL. - **callback** (_GAsyncReadyCallback*) - A GAsyncReadyCallback to call when the request is satisfied or NULL. - **user_data** (_gpointer*) - User data to pass to callback. ``` -------------------------------- ### udisks_swapspace_call_start Source: https://storaged.org/doc/udisks2-api/latest/UDisksSwapspace.html Asynchronously invokes the Start() D-Bus method on the provided proxy object. ```APIDOC ## void udisks_swapspace_call_start (UDisksSwapspace *proxy, GVariant *arg_options, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data) ### Description Asynchronously invokes the Start() D-Bus method on the proxy. When the operation is finished, the callback will be invoked in the thread-default main loop. ### Parameters - **proxy** (UDisksSwapspace*) - Required - A UDisksSwapspaceProxy. - **arg_options** (GVariant*) - Required - Argument to pass with the method invocation. - **cancellable** (GCancellable*) - Optional - A GCancellable or NULL. - **callback** (GAsyncReadyCallback) - Required - A GAsyncReadyCallback to call when the request is satisfied. - **user_data** (gpointer) - Required - User data to pass to the callback. ``` -------------------------------- ### udisks_volume_group_call_add_device_finish Source: https://storaged.org/doc/udisks2-api/latest/UDisksVolumeGroup.html Finishes an operation started with udisks_volume_group_call_add_device(). ```APIDOC ## udisks_volume_group_call_add_device_finish ### Description Finishes an asynchronous AddDevice operation and retrieves the result. ### Parameters - **proxy** (UDisksVolumeGroup*) - Required - A UDisksVolumeGroupProxy. - **res** (GAsyncResult*) - Required - The GAsyncResult obtained from the callback. - **error** (GError**) - Optional - Return location for error or NULL. ### Returns - **gboolean** - TRUE if the call succeeded, FALSE if error is set. ``` -------------------------------- ### Create a new UDisksLinuxProvider Source: https://storaged.org/doc/udisks2-api/latest/UDisksLinuxProvider.html Initializes a new provider instance associated with a UDisksDaemon. ```c UDisksLinuxProvider * udisks_linux_provider_new (_UDisksDaemon *daemon_); ``` -------------------------------- ### udisks_volume_group_proxy_new_finish Source: https://storaged.org/doc/udisks2-api/latest/UDisksVolumeGroup.html Finishes an operation started with udisks_volume_group_proxy_new. ```APIDOC ## udisks_volume_group_proxy_new_finish ### Description Finishes an operation started with udisks_volume_group_proxy_new. ### Parameters - **res** (GAsyncResult) - Required - The GAsyncResult obtained from the GAsyncReadyCallback. - **error** (GError**) - Required - Return location for error or NULL. ### Returns - **UDisksVolumeGroup*** - The constructed proxy object or NULL if error is set. ``` -------------------------------- ### udisks_vdo_volume_proxy_new_finish Source: https://storaged.org/doc/udisks2-api/latest/UDisksVDOVolume.html Finishes an operation started with udisks_vdo_volume_proxy_new. ```APIDOC ## udisks_vdo_volume_proxy_new_finish ### Description Finishes an operation started with udisks_vdo_volume_proxy_new(). ### Parameters - **res** (GAsyncResult) - Required - The GAsyncResult obtained from the GAsyncReadyCallback. - **error** (GError**) - Required - Return location for error or NULL. ### Returns - **UDisksVDOVolume*** - The constructed proxy object or NULL if error is set. ``` -------------------------------- ### Create NVMe proxy asynchronously Source: https://storaged.org/doc/udisks2-api/latest/UDisksManagerNVMe.html Asynchronously initializes a proxy for the NVMe manager interface. ```C void udisks_manager_nvme_proxy_new (_GDBusConnection *connection_, _GDBusProxyFlags flags_, _const gchar *name_, _const gchar *object_path_, _GCancellable *cancellable_, _GAsyncReadyCallback callback_, _gpointer user_data_); ``` -------------------------------- ### udisks_block_proxy_new_finish Source: https://storaged.org/doc/udisks2-api/latest/UDisksBlock.html Finishes an operation started with udisks_block_proxy_new. ```APIDOC ## udisks_block_proxy_new_finish ### Description Finishes an operation started with udisks_block_proxy_new. ### Parameters - **res** (GAsyncResult) - Required - The GAsyncResult obtained from the GAsyncReadyCallback. - **error** (GError) - Optional - Return location for error or NULL. ### Returns - **UDisksBlock** - The constructed proxy object or NULL if error is set. ``` -------------------------------- ### CreatePartitionAndFormat Source: https://storaged.org/doc/udisks2-api/latest/gdbus-org.freedesktop.UDisks2.PartitionTable.html Creates a new partition and immediately formats it with the specified filesystem type. ```APIDOC ## CreatePartitionAndFormat ### Description Combines the creation of a partition and the formatting of the resulting block device into a single operation. ### Parameters - **offset** (t) - Required - The desired offset where the partition should be created, in bytes. - **size** (t) - Required - The desired size of the partition, in bytes (0 for maximal size). - **type** (s) - Required - The type of partition to create. - **name** (s) - Required - The name for the new partition. - **options** (a{sv}) - Required - Additional options including 'partition-type' and 'partition-uuid'. - **format_type** (s) - Required - The type of filesystem to use for formatting. - **format_options** (a{sv}) - Required - Options for the formatting process. ### Response - **created_partition** (o) - An object path to the created block device object implementing the org.freedesktop.UDisks2.Partition interface. ``` -------------------------------- ### udisks_partition_proxy_new_finish Source: https://storaged.org/doc/udisks2-api/latest/UDisksPartition.html Finishes an operation started with udisks_partition_proxy_new. ```APIDOC ## udisks_partition_proxy_new_finish ### Description Finishes an operation started with udisks_partition_proxy_new. ### Parameters - **res** (GAsyncResult) - Required - The GAsyncResult obtained from the GAsyncReadyCallback. - **error** (GError **) - Required - Return location for error or NULL. ### Returns - **UDisksPartition*** - The constructed proxy object or NULL if error is set. ``` -------------------------------- ### Filesystem Interface Methods Source: https://storaged.org/doc/udisks2-api/latest/gdbus-org.freedesktop.UDisks2.Filesystem.html Overview of all available methods for the Filesystem interface. ```dbus SetLabel (IN s label, IN a{sv} options); SetUUID (IN s uuid, IN a{sv} options); Mount (IN a{sv} options, OUT s mount_path); Unmount (IN a{sv} options); Resize (IN t size, IN a{sv} options); Check (IN a{sv} options, OUT b consistent); Repair (IN a{sv} options, OUT b repaired); TakeOwnership (IN a{sv} options); ``` -------------------------------- ### udisks_nvme_controller_proxy_new_finish Source: https://storaged.org/doc/udisks2-api/latest/UDisksNVMeController.html Finishes an operation started with udisks_nvme_controller_proxy_new. ```APIDOC ## udisks_nvme_controller_proxy_new_finish ### Description Finishes an operation started with udisks_nvme_controller_proxy_new. ### Parameters - **res** (GAsyncResult) - Required - The GAsyncResult obtained from the GAsyncReadyCallback. - **error** (GError **) - Required - Return location for error or NULL. ### Returns - **UDisksNVMeController*** - The constructed proxy object or NULL if error is set. ``` -------------------------------- ### udisks_nvme_controller_call_smart_selftest_start_sync Source: https://storaged.org/doc/udisks2-api/latest/UDisksNVMeController.html Synchronously invokes the SmartSelftestStart D-Bus method on the provided proxy. ```APIDOC ## udisks_nvme_controller_call_smart_selftest_start_sync ### Description Synchronously invokes the `SmartSelftestStart()` D-Bus method on the proxy. The calling thread is blocked until a reply is received. ### Parameters - **proxy** (_UDisksNVMeController*) - A UDisksNVMeControllerProxy. - **arg_type** (_const gchar*) - Argument to pass with the method invocation. - **arg_options** (_GVariant*) - Argument to pass with the method invocation. - **cancellable** (_GCancellable*) - A GCancellable or NULL. - **error** (_GError**) - Return location for error or NULL. ### Returns - **gboolean** - TRUE if the call succeeded, FALSE if error is set. ``` -------------------------------- ### udisks_manager_call_can_check_finish Source: https://storaged.org/doc/udisks2-api/latest/UDisksManager.html Finishes an operation started with udisks_manager_call_can_check(). ```APIDOC ## udisks_manager_call_can_check_finish ### Description Finishes an operation started with `udisks_manager_call_can_check()`. ### Parameters - **proxy** (_UDisksManager*) - A UDisksManagerProxy. - **out_available** (_GVariant**) - Return location for return parameter or NULL to ignore. - **res** (_GAsyncResult*) - The GAsyncResult obtained from the GAsyncReadyCallback. - **error** (_GError**) - Return location for error or NULL. ### Returns - **gboolean** - TRUE if the call succeeded, FALSE if error is set. ``` -------------------------------- ### LoopSetup(h fd, a{sv} options) Source: https://storaged.org/doc/udisks2-api/latest/gdbus-org.freedesktop.UDisks2.Manager.html Creates a block device for the file represented by the provided file descriptor. ```APIDOC ## LoopSetup(h fd, a{sv} options) ### Description Creates a block device for the file represented by fd. ### Parameters - **fd** (h) - Required - An index for the file descriptor to use. - **options** (a{sv}) - Optional - Configuration options including offset, size, read-only, no-part-scan, and sector-size. ### Returns - **resulting_device** (o) - An object path to the object implementing the org.freedesktop.UDisks2.Block interface. ``` -------------------------------- ### udisks_partition_call_resize_finish Source: https://storaged.org/doc/udisks2-api/latest/UDisksPartition.html Finishes an operation started with udisks_partition_call_resize(). ```APIDOC ## udisks_partition_call_resize_finish ### Description Finishes an operation started with `udisks_partition_call_resize()`. ### Parameters - **proxy** (_UDisksPartition *) - A UDisksPartitionProxy. - **res** (GAsyncResult *) - The GAsyncResult obtained from the GAsyncReadyCallback. - **error** (GError **) - Return location for error or NULL. ### Returns - **gboolean** - TRUE if the call succeeded, FALSE if error is set. ``` -------------------------------- ### UDisksLoop Setup-by-uid Property Source: https://storaged.org/doc/udisks2-api/latest/UDisksLoop.html Represents the SetupByUID D-Bus property. It is readable on both client and service sides, but only writable on the service side. ```c “setup-by-uid” guint ``` -------------------------------- ### udisks_mdraid_proxy_new_finish Source: https://storaged.org/doc/udisks2-api/latest/UDisksMDRaid.html Finishes an operation started with udisks_mdraid_proxy_new. ```APIDOC ## udisks_mdraid_proxy_new_finish ### Description Finishes an operation started with udisks_mdraid_proxy_new. ### Parameters - **res** (GAsyncResult) - Required - The GAsyncResult obtained from the GAsyncReadyCallback. - **error** (GError **) - Required - Return location for error or NULL. ### Returns - **UDisksMDRaid*** - The constructed proxy object or NULL if error is set. ``` -------------------------------- ### udisks_manager_call_loop_setup Source: https://storaged.org/doc/udisks2-api/latest/UDisksManager.html Asynchronously invokes the LoopSetup() D-Bus method on the provided proxy. ```APIDOC ## udisks_manager_call_loop_setup ### Description Asynchronously invokes the LoopSetup() D-Bus method on proxy. When the operation is finished, callback will be invoked in the thread-default main loop. ### Parameters - **proxy** (UDisksManagerProxy) - A UDisksManagerProxy. - **arg_fd** (GVariant*) - Argument to pass with the method invocation. - **arg_options** (GVariant*) - Argument to pass with the method invocation. - **fd_list** (GUnixFDList*) - A GUnixFDList or NULL. - **cancellable** (GCancellable*) - A GCancellable or NULL. - **callback** (GAsyncReadyCallback) - A GAsyncReadyCallback to call when the request is satisfied or NULL. - **user_data** (gpointer) - User data to pass to callback. ``` -------------------------------- ### udisks_manager_proxy_new_finish Source: https://storaged.org/doc/udisks2-api/latest/UDisksManager.html Finishes an operation started with udisks_manager_proxy_new(). ```APIDOC ## udisks_manager_proxy_new_finish ### Description Finishes an operation started with udisks_manager_proxy_new(). ### Signature UDisksManager * udisks_manager_proxy_new_finish (_GAsyncResult *res_, _GError **error_); ### Parameters - **res** (GAsyncResult) - Required - The GAsyncResult obtained from the GAsyncReadyCallback. - **error** (GError) - Required - Return location for error or NULL. ### Returns - **UDisksManager** - The constructed proxy object or NULL if error is set. ``` -------------------------------- ### udisks_daemon_util_setup_by_user Source: https://storaged.org/doc/udisks2-api/latest/udisks2-Utilities.html Checks whether the device represented by object has been setup by user. ```APIDOC ## udisks_daemon_util_setup_by_user ### Description Checks whether the device represented by object (if any) has been setup by user. ### Parameters - **daemon** (UDisksDaemon) - Required - A UDisksDaemon. - **object** (UDisksObject) - Required - The GDBusObject that the call is on. - **user** (uid_t) - Required - The user in question. ### Returns - **gboolean** - TRUE if object has been set-up by user, FALSE if not. ``` -------------------------------- ### Udev Rule for Mount Options Source: https://storaged.org/doc/udisks2-api/latest/mount_options.html Example of a udev rule file used to set mount options for block devices. ```udev SUBSYSTEM!="block", GOTO="udisks_mount_options_end" ENV{DM_MULTIPATH_DEVICE_PATH}=="1", GOTO="udisks_mount_options_end" ENV{DM_UDEV_DISABLE_OTHER_RULES_FLAG}=="?*", GOTO="udisks_mount_options_end" # Additional mount options passed to udisksd to allow sysadmins to restrict mount to read-only or "noexec" # for example: # # ENV{UDISKS_MOUNT_OPTIONS_DEFAULTS}="ro,noexec" # ENV{UDISKS_MOUNT_OPTIONS_ALLOW}="exec,noexec,nodev,nosuid,atime,noatime,nodiratime,ro,sync,dirsync,noload" # # Use specific charset for FAT filesystems # # ENV{ID_FS_TYPE}=="vfat", \ # ENV{UDISKS_MOUNT_OPTIONS_VFAT_DEFAULTS}="uid=$UID,gid=$GID,shortname=mixed,utf8=0,iocharset=iso8859-15,showexec,flush" # # Mount all USB devices read-only # # SUBSYSTEMS=="usb", ENV{ID_FS_USAGE}=="filesystem", ENV{UDISKS_MOUNT_OPTIONS_DEFAULTS}="ro" LABEL="udisks_mount_options_end" ``` -------------------------------- ### udisks_manager_iscsi_initiator_call_set_initiator_name_finish Source: https://storaged.org/doc/udisks2-api/latest/UDisksManagerISCSIInitiator.html Finishes an operation started with udisks_manager_iscsi_initiator_call_set_initiator_name(). ```APIDOC ## udisks_manager_iscsi_initiator_call_set_initiator_name_finish ### Description Finishes an operation started with udisks_manager_iscsi_initiator_call_set_initiator_name(). ### Parameters - **proxy** (_UDisksManagerISCSIInitiator*) - A UDisksManagerISCSIInitiatorProxy. - **res** (_GAsyncResult*) - The GAsyncResult obtained from the GAsyncReadyCallback. - **error** (_GError**) - Return location for error or NULL. ### Returns - **gboolean** - TRUE if the call succeeded, FALSE if error is set. ``` -------------------------------- ### Create an asynchronous UDisksMDRaid proxy Source: https://storaged.org/doc/udisks2-api/latest/UDisksMDRaid.html Asynchronously initializes a proxy for the org.freedesktop.UDisks2.MDRaid interface. ```c void udisks_mdraid_proxy_new (_GDBusConnection *connection_, _GDBusProxyFlags flags_, _const gchar *name_, _const gchar *object_path_, _GCancellable *cancellable_, _GAsyncReadyCallback callback_, _gpointer user_data_); ``` -------------------------------- ### udisks_block_call_rescan_finish Source: https://storaged.org/doc/udisks2-api/latest/UDisksBlock.html Finishes an operation started with udisks_block_call_rescan(). ```APIDOC ## udisks_block_call_rescan_finish ### Description Finishes an operation started with udisks_block_call_rescan(). ### Parameters - **proxy** (UDisksBlock*) - A UDisksBlockProxy. - **res** (GAsyncResult*) - The GAsyncResult obtained from the GAsyncReadyCallback. - **error** (GError**) - Return location for error or NULL. ### Returns - **gboolean** - TRUE if the call succeeded, FALSE if error is set. ``` -------------------------------- ### SmartSelftestStart Method Source: https://storaged.org/doc/udisks2-api/latest/gdbus-org.freedesktop.UDisks2.Drive.Ata.html Initiates a SMART self-test of the specified type (short, extended, conveyance, or offline). ```D-Bus SmartSelftestStart (IN s type, IN a{sv} options); ``` -------------------------------- ### udisks_loop_get_setup_by_uid Source: https://storaged.org/doc/udisks2-api/latest/UDisksLoop.html Retrieves the value of the SetupByUID D-Bus property. ```APIDOC ## udisks_loop_get_setup_by_uid ### Description Gets the value of the "SetupByUID" D-Bus property. ### Parameters - **object** (UDisksLoop*) - The UDisksLoop object. ### Returns - **guint** - The property value. ``` -------------------------------- ### udisks_logical_volume_call_rename_finish Source: https://storaged.org/doc/udisks2-api/latest/UDisksLogicalVolume.html Finishes an operation started with udisks_logical_volume_call_rename(). ```APIDOC ## udisks_logical_volume_call_rename_finish ### Description Finishes an operation started with udisks_logical_volume_call_rename(). ### Parameters - **proxy** (_UDisksLogicalVolume*) - Required - A UDisksLogicalVolumeProxy. - **out_result** (_gchar**) - Optional - Return location for return parameter or NULL to ignore. - **res** (_GAsyncResult*) - Required - The GAsyncResult obtained from the GAsyncReadyCallback. - **error** (_GError**) - Required - Return location for error or NULL. ### Returns - **gboolean** - TRUE if the call succeeded, FALSE if error is set. ``` -------------------------------- ### udisks_block_call_format_finish Source: https://storaged.org/doc/udisks2-api/latest/UDisksBlock.html Finishes an operation started with udisks_block_call_format(). ```APIDOC ## udisks_block_call_format_finish ### Description Finishes an operation started with `udisks_block_call_format()`. ### Parameters - **proxy** (_UDisksBlock*) - A UDisksBlockProxy. - **res** (_GAsyncResult*) - The GAsyncResult obtained from the GAsyncReadyCallback. - **error** (_GError**) - Return location for error or NULL. ### Returns - **gboolean** - TRUE if the call succeeded, FALSE if error is set. ``` -------------------------------- ### Create UDisksLoop Proxy Source: https://storaged.org/doc/udisks2-api/latest/UDisksLoop.html Asynchronously initializes a proxy for the org.freedesktop.UDisks2.Loop D-Bus interface. ```c void udisks_loop_proxy_new (_GDBusConnection *connection_, _GDBusProxyFlags flags_, _const gchar *name_, _const gchar *object_path_, _GCancellable *cancellable_, _GAsyncReadyCallback callback_, _gpointer user_data_); ``` -------------------------------- ### udisks_manager_iscsi_initiator_call_discover_send_targets_finish Source: https://storaged.org/doc/udisks2-api/latest/UDisksManagerISCSIInitiator.html Finishes an operation started with udisks_manager_iscsi_initiator_call_discover_send_targets(). ```APIDOC ## udisks_manager_iscsi_initiator_call_discover_send_targets_finish ### Description Finishes an operation started with udisks_manager_iscsi_initiator_call_discover_send_targets(). ### Parameters - **proxy** (_UDisksManagerISCSIInitiator*) - A UDisksManagerISCSIInitiatorProxy. - **out_nodes** (_GVariant**) - Return location for return parameter or NULL to ignore. - **out_nodes_cnt** (_gint*) - Return location for return parameter or NULL to ignore. - **res** (_GAsyncResult*) - The GAsyncResult obtained from the GAsyncReadyCallback. - **error** (_GError**) - Return location for error or NULL. ### Returns - **gboolean** - TRUE if the call succeeded, FALSE if error is set. ``` -------------------------------- ### udisks_nvme_namespace_proxy_new_finish Source: https://storaged.org/doc/udisks2-api/latest/UDisksNVMeNamespace.html Finishes an operation started with udisks_nvme_namespace_proxy_new. ```APIDOC ## udisks_nvme_namespace_proxy_new_finish ### Description Finishes an operation started with udisks_nvme_namespace_proxy_new and returns the constructed proxy object. ### Parameters - **res** (GAsyncResult) - Required - The GAsyncResult obtained from the GAsyncReadyCallback. - **error** (GError **) - Optional - Return location for error or NULL. ### Returns - **UDisksNVMeNamespace*** - The constructed proxy object or NULL if error is set. ``` -------------------------------- ### Asynchronously start SMART self-test Source: https://storaged.org/doc/udisks2-api/latest/UDisksDriveAta.html Invokes the SmartSelftestStart D-Bus method asynchronously on the specified proxy. ```c void udisks_drive_ata_call_smart_selftest_start (_UDisksDriveAta *proxy_, _const gchar *arg_type_, _GVariant *arg_options_, _GCancellable *cancellable_, _GAsyncReadyCallback callback_, _gpointer user_data_); ``` -------------------------------- ### Create an asynchronous proxy for UDisksVDOVolume Source: https://storaged.org/doc/udisks2-api/latest/UDisksVDOVolume.html Asynchronously initializes a proxy for the VDOVolume interface. Use the callback to handle the result and call the finish function. ```c void udisks_vdo_volume_proxy_new (_GDBusConnection *connection_, _GDBusProxyFlags flags_, _const gchar *name_, _const gchar *object_path_, _GCancellable *cancellable_, _GAsyncReadyCallback callback_, _gpointer user_data_); ``` -------------------------------- ### udisks_physical_volume_proxy_new_finish Source: https://storaged.org/doc/udisks2-api/latest/UDisksPhysicalVolume.html Finishes an operation started with udisks_physical_volume_proxy_new(). ```APIDOC ## udisks_physical_volume_proxy_new_finish ### Description Finishes an operation started with udisks_physical_volume_proxy_new(). ### Parameters - **res** (GAsyncResult) - Required - The GAsyncResult obtained from the GAsyncReadyCallback. - **error** (GError**) - Required - Return location for error or NULL. ### Returns - **UDisksPhysicalVolume*** - The constructed proxy object or NULL if error is set. ``` -------------------------------- ### org.freedesktop.UDisks2.LogicalVolume.Activate() Source: https://storaged.org/doc/udisks2-api/latest/api-index.html Activates the logical volume. ```APIDOC ## Activate() ### Description Activates the logical volume. ### Method Method call on org.freedesktop.UDisks2.LogicalVolume ``` -------------------------------- ### udisks_logical_volume_call_cache_attach_finish Source: https://storaged.org/doc/udisks2-api/latest/UDisksLogicalVolume.html Finishes an operation started with udisks_logical_volume_call_cache_attach(). ```APIDOC ## udisks_logical_volume_call_cache_attach_finish ### Description Finishes an operation started with udisks_logical_volume_call_cache_attach(). ### Parameters - **proxy** (UDisksLogicalVolume*) - Required - A UDisksLogicalVolumeProxy. - **res** (GAsyncResult*) - Required - The GAsyncResult obtained from the GAsyncReadyCallback. - **error** (GError**) - Required - Return location for error or NULL. ### Returns - **gboolean** - TRUE if the call succeeded, FALSE if error is set. ``` -------------------------------- ### udisks_logical_volume_proxy_new_for_bus_finish Source: https://storaged.org/doc/udisks2-api/latest/UDisksLogicalVolume.html Finishes an operation started with udisks_logical_volume_proxy_new_for_bus. ```APIDOC ## udisks_logical_volume_proxy_new_for_bus_finish ### Description Finishes an operation started with udisks_logical_volume_proxy_new_for_bus. ### Parameters - **res** (GAsyncResult) - Required - The GAsyncResult obtained from the GAsyncReadyCallback. - **error** (GError) - Required - Return location for error or NULL. ### Returns - **UDisksLogicalVolume*** - The constructed proxy object or NULL if error is set. ``` -------------------------------- ### Create a new UDisksLinuxManagerNVMe instance Source: https://storaged.org/doc/udisks2-api/latest/udisks2-UDisksLinuxManagerNVMe.html Initializes a new manager instance. The returned object must be freed using g_object_unref(). ```C UDisksManagerNVMe * udisks_linux_manager_nvme_new (_UDisksDaemon *daemon_); ``` -------------------------------- ### udisks_logical_volume_proxy_new_finish Source: https://storaged.org/doc/udisks2-api/latest/UDisksLogicalVolume.html Finishes an operation started with udisks_logical_volume_proxy_new. ```APIDOC ## udisks_logical_volume_proxy_new_finish ### Description Finishes an operation started with udisks_logical_volume_proxy_new. ### Parameters - **res** (GAsyncResult) - Required - The GAsyncResult obtained from the GAsyncReadyCallback. - **error** (GError) - Required - Return location for error or NULL. ### Returns - **UDisksLogicalVolume*** - The constructed proxy object or NULL if error is set. ``` -------------------------------- ### udisks_drive_ata_proxy_new_finish Source: https://storaged.org/doc/udisks2-api/latest/UDisksDriveAta.html Finishes an operation started with udisks_drive_ata_proxy_new. ```APIDOC ## udisks_drive_ata_proxy_new_finish ### Description Finishes an operation started with udisks_drive_ata_proxy_new and returns the constructed proxy object. ### Parameters - **res** (GAsyncResult) - Required - The GAsyncResult obtained from the GAsyncReadyCallback. - **error** (GError) - Optional - Return location for error or NULL. ### Returns - **UDisksDriveAta** - The constructed proxy object or NULL if error is set. ``` -------------------------------- ### Get SetupByUID Property Source: https://storaged.org/doc/udisks2-api/latest/UDisksLoop.html Retrieves the current value of the SetupByUID D-Bus property. ```c guint udisks_loop_get_setup_by_uid (_UDisksLoop *object_); ``` -------------------------------- ### Create Asynchronous Proxy Source: https://storaged.org/doc/udisks2-api/latest/UDisksNVMeController.html Asynchronously initializes a proxy for the NVMe Controller interface. Use the provided callback to handle the result via udisks_nvme_controller_proxy_new_finish. ```c void udisks_nvme_controller_proxy_new (_GDBusConnection *connection_, _GDBusProxyFlags flags_, _const gchar *name_, _const gchar *object_path_, _GCancellable *cancellable_, _GAsyncReadyCallback callback_, _gpointer user_data_); ``` -------------------------------- ### Create UDisksBlockLVM2 Proxy Asynchronously Source: https://storaged.org/doc/udisks2-api/latest/UDisksBlockLVM2.html Asynchronously initializes a proxy for the LVM2 interface. Use the provided callback to handle completion and retrieve the result via the finish function. ```c void udisks_block_lvm2_proxy_new (_GDBusConnection *connection_, _GDBusProxyFlags flags_, _const gchar *name_, _const gchar *object_path_, _GCancellable *cancellable_, _GAsyncReadyCallback callback_, _gpointer user_data_); ``` -------------------------------- ### udisks_drive_ata_call_pm_wakeup_finish Source: https://storaged.org/doc/udisks2-api/latest/UDisksDriveAta.html Finishes an operation started with udisks_drive_ata_call_pm_wakeup(). ```APIDOC ## udisks_drive_ata_call_pm_wakeup_finish ### Description Finishes an operation started with `udisks_drive_ata_call_pm_wakeup()`. ### Parameters - **proxy** (_UDisksDriveAta*) - A UDisksDriveAtaProxy. - **res** (_GAsyncResult*) - The GAsyncResult obtained from the GAsyncReadyCallback. - **error** (_GError**) - Return location for error or NULL. ### Returns - **gboolean** - TRUE if the call succeeded, FALSE if error is set. ``` -------------------------------- ### OpenForBackup Source: https://storaged.org/doc/udisks2-api/latest/gdbus-org.freedesktop.UDisks2.Block.html Opens the block device for backup purposes. ```APIDOC ## OpenForBackup ### Description Opens the block device for backup purposes. ### Parameters - **options** (a{sv}) - Required - Options for the operation. ### Response - **fd** (h) - The file descriptor for the opened device. ``` -------------------------------- ### udisks_drive_proxy_new_finish Source: https://storaged.org/doc/udisks2-api/latest/UDisksDrive.html Finishes an operation started with udisks_drive_proxy_new. ```APIDOC ## udisks_drive_proxy_new_finish ### Description Finishes an operation started with udisks_drive_proxy_new and returns the constructed proxy object. ### Parameters - **res** (GAsyncResult) - Required - The GAsyncResult obtained from the GAsyncReadyCallback. - **error** (GError**) - Optional - Return location for error or NULL. ### Returns - **UDisksDrive*** - The constructed proxy object or NULL if error is set. ``` -------------------------------- ### handle-loop-setup Source: https://storaged.org/doc/udisks2-api/latest/UDisksManager.html Signal emitted when a remote caller is invoking the LoopSetup() D-Bus method. ```APIDOC ## handle-loop-setup ### Description Signal emitted when a remote caller is invoking the LoopSetup() D-Bus method. If a signal handler returns TRUE, it handles the invocation; otherwise, G_DBUS_ERROR_UNKNOWN_METHOD is returned. ### Parameters - **object** (UDisksManager) - The UDisksManager instance. - **invocation** (GDBusMethodInvocation) - The D-Bus method invocation. - **fd_list** (GUnixFDList) - Optional file descriptor list. - **arg_fd** (GVariant) - Argument passed by remote caller. - **arg_options** (GVariant) - Argument passed by remote caller. - **user_data** (gpointer) - User data set when the signal handler was connected. ### Returns - **gboolean** - TRUE if the invocation was handled, FALSE otherwise. ``` -------------------------------- ### udisks_loop_proxy_new_finish Source: https://storaged.org/doc/udisks2-api/latest/UDisksLoop.html Finishes an operation started with udisks_loop_proxy_new. ```APIDOC ## udisks_loop_proxy_new_finish ### Description Finishes an operation started with udisks_loop_proxy_new(). ### Parameters - **res** (_GAsyncResult *) - The GAsyncResult obtained from the GAsyncReadyCallback. - **error** (_GError **) - Return location for error or NULL. ### Returns - **UDisksLoop*** - The constructed proxy object or NULL if error is set. ``` -------------------------------- ### TurnIdentLEDOn Method Source: https://storaged.org/doc/udisks2-api/latest/gdbus-org.freedesktop.UDisks2.Drive.LsmLocal.html Turns on the identification LED of the disk. Requires SCSI enclosure support. ```dbus TurnIdentLEDOn (IN a{sv} options); ``` -------------------------------- ### Finish asynchronous connection-based creation Source: https://storaged.org/doc/udisks2-api/latest/UDisksClient.html Completes the initialization process started by udisks_client_new_for_connection. ```c UDisksClient * udisks_client_new_for_connection_finish (_GAsyncResult *res_, _GError **error_); ``` -------------------------------- ### udisks_manager_lvm2_proxy_new_finish Source: https://storaged.org/doc/udisks2-api/latest/UDisksManagerLVM2.html Finishes an operation started with udisks_manager_lvm2_proxy_new. ```APIDOC ## udisks_manager_lvm2_proxy_new_finish ### Description Finishes an asynchronous proxy creation operation. ### Parameters - **res** (GAsyncResult) - Required - The GAsyncResult obtained from the callback. - **error** (GError**) - Required - Return location for error or NULL. ### Returns - **UDisksManagerLVM2*** - The constructed proxy object or NULL if error is set. ``` -------------------------------- ### Mount Method Source: https://storaged.org/doc/udisks2-api/latest/gdbus-org.freedesktop.UDisks2.Filesystem.html Mounts the filesystem to a directory, returning the mount path. ```dbus Mount (IN a{sv} options, OUT s mount_path); ``` -------------------------------- ### udisks_filesystem_btrfs_call_remove_subvolume_finish Source: https://storaged.org/doc/udisks2-api/latest/UDisksFilesystemBTRFS.html Finishes an operation started with udisks_filesystem_btrfs_call_remove_subvolume(). ```APIDOC ## udisks_filesystem_btrfs_call_remove_subvolume_finish ### Description Finishes an operation started with `udisks_filesystem_btrfs_call_remove_subvolume()`. ### Parameters - **proxy** (_UDisksFilesystemBTRFS*) - Required - A UDisksFilesystemBTRFSProxy. - **res** (GAsyncResult*) - Required - The GAsyncResult obtained from the GAsyncReadyCallback. - **error** (GError**) - Required - Return location for error or NULL. ### Returns - **gboolean** - TRUE if the call succeeded, FALSE if error is set. ``` -------------------------------- ### udisks_filesystem_btrfs_call_create_subvolume_finish Source: https://storaged.org/doc/udisks2-api/latest/UDisksFilesystemBTRFS.html Finishes an operation started with udisks_filesystem_btrfs_call_create_subvolume. ```APIDOC ## udisks_filesystem_btrfs_call_create_subvolume_finish ### Description Finishes an operation started with udisks_filesystem_btrfs_call_create_subvolume(). ### Parameters - **proxy** (_UDisksFilesystemBTRFS*) - Required - A UDisksFilesystemBTRFSProxy. - **res** (GAsyncResult*) - Required - The GAsyncResult obtained from the GAsyncReadyCallback. - **error** (GError**) - Required - Return location for error or NULL. ### Returns - **gboolean** - TRUE if the call succeeded, FALSE if error is set. ``` -------------------------------- ### udisks_swapspace_proxy_new Source: https://storaged.org/doc/udisks2-api/latest/UDisksSwapspace.html Asynchronously creates a proxy for the D-Bus interface org.freedesktop.UDisks2.Swapspace. ```APIDOC ## udisks_swapspace_proxy_new ### Description Asynchronously creates a proxy for the D-Bus interface org.freedesktop.UDisks2.Swapspace. When finished, the callback is invoked. ### Parameters - **connection** (GDBusConnection*) - A GDBusConnection. - **flags** (GDBusProxyFlags) - Flags from the GDBusProxyFlags enumeration. - **name** (const gchar*) - A bus name or NULL. - **object_path** (const gchar*) - An object path. - **cancellable** (GCancellable*) - A GCancellable or NULL. - **callback** (GAsyncReadyCallback) - A GAsyncReadyCallback to call when the request is satisfied. - **user_data** (gpointer) - User data to pass to callback. ```