![]() |
![]() |
![]() |
UDisks Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Implemented Interfaces | Prerequisites | Known Implementations | Signals |
UDisksEncryptedUDisksEncrypted — Generated C code for the org.freedesktop.UDisks2.Encrypted D-Bus interface |
UDisksEncrypted; struct UDisksEncryptedIface; GDBusInterfaceInfo * udisks_encrypted_interface_info (void
); guint udisks_encrypted_override_properties (GObjectClass *klass
,guint property_id_begin
); void udisks_encrypted_call_unlock (UDisksEncrypted *proxy
,const gchar *arg_passphrase
,GVariant *arg_options
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); gboolean udisks_encrypted_call_unlock_finish (UDisksEncrypted *proxy
,gchar **out_cleartext_device
,GAsyncResult *res
,GError **error
); gboolean udisks_encrypted_call_unlock_sync (UDisksEncrypted *proxy
,const gchar *arg_passphrase
,GVariant *arg_options
,gchar **out_cleartext_device
,GCancellable *cancellable
,GError **error
); void udisks_encrypted_complete_unlock (UDisksEncrypted *object
,GDBusMethodInvocation *invocation
,const gchar *cleartext_device
); void udisks_encrypted_call_lock (UDisksEncrypted *proxy
,GVariant *arg_options
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); gboolean udisks_encrypted_call_lock_finish (UDisksEncrypted *proxy
,GAsyncResult *res
,GError **error
); gboolean udisks_encrypted_call_lock_sync (UDisksEncrypted *proxy
,GVariant *arg_options
,GCancellable *cancellable
,GError **error
); void udisks_encrypted_complete_lock (UDisksEncrypted *object
,GDBusMethodInvocation *invocation
); void udisks_encrypted_call_change_passphrase (UDisksEncrypted *proxy
,const gchar *arg_passphrase
,const gchar *arg_new_passphrase
,GVariant *arg_options
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); gboolean udisks_encrypted_call_change_passphrase_finish (UDisksEncrypted *proxy
,GAsyncResult *res
,GError **error
); gboolean udisks_encrypted_call_change_passphrase_sync (UDisksEncrypted *proxy
,const gchar *arg_passphrase
,const gchar *arg_new_passphrase
,GVariant *arg_options
,GCancellable *cancellable
,GError **error
); void udisks_encrypted_complete_change_passphrase (UDisksEncrypted *object
,GDBusMethodInvocation *invocation
); struct UDisksEncryptedProxy; struct UDisksEncryptedProxyClass; void udisks_encrypted_proxy_new (GDBusConnection *connection
,GDBusProxyFlags flags
,const gchar *name
,const gchar *object_path
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); UDisksEncrypted * udisks_encrypted_proxy_new_finish (GAsyncResult *res
,GError **error
); UDisksEncrypted * udisks_encrypted_proxy_new_sync (GDBusConnection *connection
,GDBusProxyFlags flags
,const gchar *name
,const gchar *object_path
,GCancellable *cancellable
,GError **error
); void udisks_encrypted_proxy_new_for_bus (GBusType bus_type
,GDBusProxyFlags flags
,const gchar *name
,const gchar *object_path
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); UDisksEncrypted * udisks_encrypted_proxy_new_for_bus_finish (GAsyncResult *res
,GError **error
); UDisksEncrypted * udisks_encrypted_proxy_new_for_bus_sync (GBusType bus_type
,GDBusProxyFlags flags
,const gchar *name
,const gchar *object_path
,GCancellable *cancellable
,GError **error
); struct UDisksEncryptedSkeleton; struct UDisksEncryptedSkeletonClass; UDisksEncrypted * udisks_encrypted_skeleton_new (void
);
GInterface +----UDisksEncrypted
GObject +----GDBusProxy +----UDisksEncryptedProxy
GObject +----GDBusInterfaceSkeleton +----UDisksEncryptedSkeleton +----UDisksLinuxEncrypted
UDisksEncryptedProxy implements GDBusInterface, GInitable, GAsyncInitable and UDisksEncrypted.
UDisksEncryptedSkeleton implements GDBusInterface and UDisksEncrypted.
UDisksEncrypted is implemented by UDisksEncryptedProxy, UDisksEncryptedSkeleton and UDisksLinuxEncrypted.
This section contains code for working with the org.freedesktop.UDisks2.Encrypted D-Bus interface in C.
typedef struct _UDisksEncrypted UDisksEncrypted;
Abstract interface type for the D-Bus interface org.freedesktop.UDisks2.Encrypted.
struct UDisksEncryptedIface { GTypeInterface parent_iface; gboolean (*handle_change_passphrase) ( UDisksEncrypted *object, GDBusMethodInvocation *invocation, const gchar *arg_passphrase, const gchar *arg_new_passphrase, GVariant *arg_options); gboolean (*handle_lock) ( UDisksEncrypted *object, GDBusMethodInvocation *invocation, GVariant *arg_options); gboolean (*handle_unlock) ( UDisksEncrypted *object, GDBusMethodInvocation *invocation, const gchar *arg_passphrase, GVariant *arg_options); };
Virtual table for the D-Bus interface org.freedesktop.UDisks2.Encrypted.
The parent interface. | |
Handler for the "handle-change-passphrase" signal. | |
Handler for the "handle-lock" signal. | |
Handler for the "handle-unlock" signal. |
GDBusInterfaceInfo * udisks_encrypted_interface_info (void
);
Gets a machine-readable description of the org.freedesktop.UDisks2.Encrypted D-Bus interface.
Returns : |
A GDBusInterfaceInfo. Do not free. [transfer none] |
guint udisks_encrypted_override_properties (GObjectClass *klass
,guint property_id_begin
);
Overrides all GObject properties in the UDisksEncrypted 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_encrypted_call_unlock (UDisksEncrypted *proxy
,const gchar *arg_passphrase
,GVariant *arg_options
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronously invokes the Unlock()
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_encrypted_call_unlock_finish()
to get the result of the operation.
See udisks_encrypted_call_unlock_sync()
for the synchronous, blocking version of this method.
|
A UDisksEncryptedProxy. |
|
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_encrypted_call_unlock_finish (UDisksEncrypted *proxy
,gchar **out_cleartext_device
,GAsyncResult *res
,GError **error
);
Finishes an operation started with udisks_encrypted_call_unlock()
.
|
A UDisksEncryptedProxy. |
|
Return location for return parameter or NULL to ignore. [out]
|
|
The GAsyncResult obtained from the GAsyncReadyCallback passed to udisks_encrypted_call_unlock() . |
|
Return location for error or NULL . |
Returns : |
TRUE if the call succeded, FALSE if error is set. [skip]
|
gboolean udisks_encrypted_call_unlock_sync (UDisksEncrypted *proxy
,const gchar *arg_passphrase
,GVariant *arg_options
,gchar **out_cleartext_device
,GCancellable *cancellable
,GError **error
);
Synchronously invokes the Unlock()
D-Bus method on proxy
. The calling thread is blocked until a reply is received.
See udisks_encrypted_call_unlock()
for the asynchronous version of this method.
|
A UDisksEncryptedProxy. |
|
Argument to pass with the method invocation. |
|
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_encrypted_complete_unlock (UDisksEncrypted *object
,GDBusMethodInvocation *invocation
,const gchar *cleartext_device
);
Helper function used in service implementations to finish handling invocations of the Unlock()
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 UDisksEncrypted. |
|
A GDBusMethodInvocation. [transfer full] |
|
Parameter to return. |
void udisks_encrypted_call_lock (UDisksEncrypted *proxy
,GVariant *arg_options
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronously invokes the Lock()
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_encrypted_call_lock_finish()
to get the result of the operation.
See udisks_encrypted_call_lock_sync()
for the synchronous, blocking version of this method.
|
A UDisksEncryptedProxy. |
|
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_encrypted_call_lock_finish (UDisksEncrypted *proxy
,GAsyncResult *res
,GError **error
);
Finishes an operation started with udisks_encrypted_call_lock()
.
|
A UDisksEncryptedProxy. |
|
The GAsyncResult obtained from the GAsyncReadyCallback passed to udisks_encrypted_call_lock() . |
|
Return location for error or NULL . |
Returns : |
TRUE if the call succeded, FALSE if error is set. [skip]
|
gboolean udisks_encrypted_call_lock_sync (UDisksEncrypted *proxy
,GVariant *arg_options
,GCancellable *cancellable
,GError **error
);
Synchronously invokes the Lock()
D-Bus method on proxy
. The calling thread is blocked until a reply is received.
See udisks_encrypted_call_lock()
for the asynchronous version of this method.
|
A UDisksEncryptedProxy. |
|
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_encrypted_complete_lock (UDisksEncrypted *object
,GDBusMethodInvocation *invocation
);
Helper function used in service implementations to finish handling invocations of the Lock()
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 UDisksEncrypted. |
|
A GDBusMethodInvocation. [transfer full] |
void udisks_encrypted_call_change_passphrase (UDisksEncrypted *proxy
,const gchar *arg_passphrase
,const gchar *arg_new_passphrase
,GVariant *arg_options
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronously invokes the ChangePassphrase()
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_encrypted_call_change_passphrase_finish()
to get the result of the operation.
See udisks_encrypted_call_change_passphrase_sync()
for the synchronous, blocking version of this method.
|
A UDisksEncryptedProxy. |
|
Argument to pass with the method invocation. |
|
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_encrypted_call_change_passphrase_finish (UDisksEncrypted *proxy
,GAsyncResult *res
,GError **error
);
Finishes an operation started with udisks_encrypted_call_change_passphrase()
.
|
A UDisksEncryptedProxy. |
|
The GAsyncResult obtained from the GAsyncReadyCallback passed to udisks_encrypted_call_change_passphrase() . |
|
Return location for error or NULL . |
Returns : |
TRUE if the call succeded, FALSE if error is set. [skip]
|
gboolean udisks_encrypted_call_change_passphrase_sync (UDisksEncrypted *proxy
,const gchar *arg_passphrase
,const gchar *arg_new_passphrase
,GVariant *arg_options
,GCancellable *cancellable
,GError **error
);
Synchronously invokes the ChangePassphrase()
D-Bus method on proxy
. The calling thread is blocked until a reply is received.
See udisks_encrypted_call_change_passphrase()
for the asynchronous version of this method.
|
A UDisksEncryptedProxy. |
|
Argument to pass with the method invocation. |
|
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_encrypted_complete_change_passphrase (UDisksEncrypted *object
,GDBusMethodInvocation *invocation
);
Helper function used in service implementations to finish handling invocations of the ChangePassphrase()
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 UDisksEncrypted. |
|
A GDBusMethodInvocation. [transfer full] |
struct UDisksEncryptedProxy;
The UDisksEncryptedProxy structure contains only private data and should only be accessed using the provided API.
struct UDisksEncryptedProxyClass { GDBusProxyClass parent_class; };
Class structure for UDisksEncryptedProxy.
void udisks_encrypted_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.Encrypted. 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_encrypted_proxy_new_finish()
to get the result of the operation.
See udisks_encrypted_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 . |
UDisksEncrypted * udisks_encrypted_proxy_new_finish (GAsyncResult *res
,GError **error
);
Finishes an operation started with udisks_encrypted_proxy_new()
.
|
The GAsyncResult obtained from the GAsyncReadyCallback passed to udisks_encrypted_proxy_new() . |
|
Return location for error or NULL
|
Returns : |
The constructed proxy object or NULL if error is set. [transfer full][type UDisksEncryptedProxy]
|
UDisksEncrypted * udisks_encrypted_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.Encrypted. See g_dbus_proxy_new_sync()
for more details.
The calling thread is blocked until a reply is received.
See udisks_encrypted_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 UDisksEncryptedProxy]
|
void udisks_encrypted_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_encrypted_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_encrypted_proxy_new_for_bus_finish()
to get the result of the operation.
See udisks_encrypted_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 . |
UDisksEncrypted * udisks_encrypted_proxy_new_for_bus_finish (GAsyncResult *res
,GError **error
);
Finishes an operation started with udisks_encrypted_proxy_new_for_bus()
.
|
The GAsyncResult obtained from the GAsyncReadyCallback passed to udisks_encrypted_proxy_new_for_bus() . |
|
Return location for error or NULL
|
Returns : |
The constructed proxy object or NULL if error is set. [transfer full][type UDisksEncryptedProxy]
|
UDisksEncrypted * udisks_encrypted_proxy_new_for_bus_sync (GBusType bus_type
,GDBusProxyFlags flags
,const gchar *name
,const gchar *object_path
,GCancellable *cancellable
,GError **error
);
Like udisks_encrypted_proxy_new_sync()
but takes a GBusType instead of a GDBusConnection.
The calling thread is blocked until a reply is received.
See udisks_encrypted_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 UDisksEncryptedProxy]
|
struct UDisksEncryptedSkeleton;
The UDisksEncryptedSkeleton structure contains only private data and should only be accessed using the provided API.
struct UDisksEncryptedSkeletonClass { GDBusInterfaceSkeletonClass parent_class; };
Class structure for UDisksEncryptedSkeleton.
UDisksEncrypted * udisks_encrypted_skeleton_new (void
);
Creates a skeleton object for the D-Bus interface org.freedesktop.UDisks2.Encrypted.
Returns : |
The skeleton object. [transfer full][type UDisksEncryptedSkeleton] |
"handle-change-passphrase"
signalgboolean user_function (UDisksEncrypted *object,
GDBusMethodInvocation *invocation,
gchar *arg_passphrase,
gchar *arg_new_passphrase,
GVariant *arg_options,
gpointer user_data) : Run Last
Signal emitted when a remote caller is invoking the ChangePassphrase()
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_encrypted_complete_change_passphrase()
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 UDisksEncrypted. |
|
A GDBusMethodInvocation. |
|
Argument passed by remote caller. |
|
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-lock"
signalgboolean user_function (UDisksEncrypted *object,
GDBusMethodInvocation *invocation,
GVariant *arg_options,
gpointer user_data) : Run Last
Signal emitted when a remote caller is invoking the Lock()
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_encrypted_complete_lock()
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 UDisksEncrypted. |
|
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-unlock"
signalgboolean user_function (UDisksEncrypted *object,
GDBusMethodInvocation *invocation,
gchar *arg_passphrase,
GVariant *arg_options,
gpointer user_data) : Run Last
Signal emitted when a remote caller is invoking the Unlock()
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_encrypted_complete_unlock()
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 UDisksEncrypted. |
|
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. |