|
Packit |
ae235b |
|
|
Packit |
ae235b |
<html>
|
|
Packit |
ae235b |
<head>
|
|
Packit |
ae235b |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
Packit |
ae235b |
<title>GDBusMethodInvocation: GIO Reference Manual</title>
|
|
Packit |
ae235b |
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
|
|
Packit |
ae235b |
<link rel="home" href="index.html" title="GIO Reference Manual">
|
|
Packit |
ae235b |
<link rel="up" href="gdbus-lowlevel.html" title="Low-level D-Bus Support">
|
|
Packit |
ae235b |
<link rel="prev" href="GDBusConnection.html" title="GDBusConnection">
|
|
Packit |
ae235b |
<link rel="next" href="GDBusServer.html" title="GDBusServer">
|
|
Packit |
ae235b |
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
|
|
Packit |
ae235b |
<link rel="stylesheet" href="style.css" type="text/css">
|
|
Packit |
ae235b |
</head>
|
|
Packit |
ae235b |
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Top |
|
|
Packit |
ae235b |
Description |
|
|
Packit |
ae235b |
Object Hierarchy
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
GDBusMethodInvocation
|
|
Packit |
ae235b |
GDBusMethodInvocation — Object for handling remote calls
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Functions
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
const gchar *
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_dbus_method_invocation_get_sender ()
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
const gchar *
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_dbus_method_invocation_get_object_path ()
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
const gchar *
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_dbus_method_invocation_get_interface_name ()
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
const gchar *
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_dbus_method_invocation_get_method_name ()
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
const GDBusMethodInfo *
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_dbus_method_invocation_get_method_info ()
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
const GDBusPropertyInfo *
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_dbus_method_invocation_get_property_info ()
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
GDBusConnection *
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_dbus_method_invocation_get_connection ()
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
GDBusMessage *
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_dbus_method_invocation_get_message ()
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
GVariant *
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_dbus_method_invocation_get_parameters ()
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
gpointer
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_dbus_method_invocation_get_user_data ()
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
void
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_dbus_method_invocation_return_value ()
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
void
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_dbus_method_invocation_return_error ()
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
void
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_dbus_method_invocation_return_error_valist ()
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
void
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_dbus_method_invocation_return_error_literal ()
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
void
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_dbus_method_invocation_return_gerror ()
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
void
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_dbus_method_invocation_return_dbus_error ()
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
void
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_dbus_method_invocation_take_error ()
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
void
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_dbus_method_invocation_return_value_with_unix_fd_list ()
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Types and Values
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
GDBusMethodInvocation
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Object Hierarchy
|
|
Packit |
ae235b |
GObject
|
|
Packit |
ae235b |
╰── GDBusMethodInvocation
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Includes
|
|
Packit |
ae235b |
#include <gio/gio.h>
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Description
|
|
Packit |
ae235b |
Instances of the GDBusMethodInvocation class are used when
|
|
Packit |
ae235b |
handling D-Bus method calls. It provides a way to asynchronously
|
|
Packit |
ae235b |
return results and errors.
|
|
Packit |
ae235b |
The normal way to obtain a GDBusMethodInvocation object is to receive
|
|
Packit |
ae235b |
it as an argument to the handle_method_call() function in a
|
|
Packit |
ae235b |
GDBusInterfaceVTable that was passed to g_dbus_connection_register_object().
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Functions
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_dbus_method_invocation_get_sender ()
|
|
Packit |
ae235b |
const gchar *
|
|
Packit |
ae235b |
g_dbus_method_invocation_get_sender (GDBusMethodInvocation *invocation);
|
|
Packit |
ae235b |
Gets the bus name that invoked the method.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Parameters
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
invocation
|
|
Packit |
ae235b |
A GDBusMethodInvocation.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Returns
|
|
Packit |
ae235b |
A string. Do not free, it is owned by invocation
|
|
Packit |
ae235b |
.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Since: 2.26
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_dbus_method_invocation_get_object_path ()
|
|
Packit |
ae235b |
const gchar *
|
|
Packit |
ae235b |
g_dbus_method_invocation_get_object_path
|
|
Packit |
ae235b |
(GDBusMethodInvocation *invocation);
|
|
Packit |
ae235b |
Gets the object path the method was invoked on.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Parameters
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
invocation
|
|
Packit |
ae235b |
A GDBusMethodInvocation.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Returns
|
|
Packit |
ae235b |
A string. Do not free, it is owned by invocation
|
|
Packit |
ae235b |
.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Since: 2.26
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_dbus_method_invocation_get_interface_name ()
|
|
Packit |
ae235b |
const gchar *
|
|
Packit |
ae235b |
g_dbus_method_invocation_get_interface_name
|
|
Packit |
ae235b |
(GDBusMethodInvocation *invocation);
|
|
Packit |
ae235b |
Gets the name of the D-Bus interface the method was invoked on.
|
|
Packit |
ae235b |
If this method call is a property Get, Set or GetAll call that has
|
|
Packit |
ae235b |
been redirected to the method call handler then
|
|
Packit |
ae235b |
"org.freedesktop.DBus.Properties" will be returned. See
|
|
Packit |
ae235b |
GDBusInterfaceVTable for more information.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Parameters
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
invocation
|
|
Packit |
ae235b |
A GDBusMethodInvocation.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Returns
|
|
Packit |
ae235b |
A string. Do not free, it is owned by invocation
|
|
Packit |
ae235b |
.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Since: 2.26
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_dbus_method_invocation_get_method_name ()
|
|
Packit |
ae235b |
const gchar *
|
|
Packit |
ae235b |
g_dbus_method_invocation_get_method_name
|
|
Packit |
ae235b |
(GDBusMethodInvocation *invocation);
|
|
Packit |
ae235b |
Gets the name of the method that was invoked.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Parameters
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
invocation
|
|
Packit |
ae235b |
A GDBusMethodInvocation.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Returns
|
|
Packit |
ae235b |
A string. Do not free, it is owned by invocation
|
|
Packit |
ae235b |
.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Since: 2.26
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_dbus_method_invocation_get_method_info ()
|
|
Packit |
ae235b |
const GDBusMethodInfo *
|
|
Packit |
ae235b |
g_dbus_method_invocation_get_method_info
|
|
Packit |
ae235b |
(GDBusMethodInvocation *invocation);
|
|
Packit |
ae235b |
Gets information about the method call, if any.
|
|
Packit |
ae235b |
If this method invocation is a property Get, Set or GetAll call that
|
|
Packit |
ae235b |
has been redirected to the method call handler then NULL will be
|
|
Packit |
ae235b |
returned. See g_dbus_method_invocation_get_property_info() and
|
|
Packit |
ae235b |
GDBusInterfaceVTable for more information.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Parameters
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
invocation
|
|
Packit |
ae235b |
A GDBusMethodInvocation.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Returns
|
|
Packit |
ae235b |
A GDBusMethodInfo or NULL. Do not free, it is owned by invocation
|
|
Packit |
ae235b |
.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Since: 2.26
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_dbus_method_invocation_get_property_info ()
|
|
Packit |
ae235b |
const GDBusPropertyInfo *
|
|
Packit |
ae235b |
g_dbus_method_invocation_get_property_info
|
|
Packit |
ae235b |
(GDBusMethodInvocation *invocation);
|
|
Packit |
ae235b |
Gets information about the property that this method call is for, if
|
|
Packit |
ae235b |
any.
|
|
Packit |
ae235b |
This will only be set in the case of an invocation in response to a
|
|
Packit |
ae235b |
property Get or Set call that has been directed to the method call
|
|
Packit |
ae235b |
handler for an object on account of its property_get() or
|
|
Packit |
ae235b |
property_set() vtable pointers being unset.
|
|
Packit |
ae235b |
See GDBusInterfaceVTable for more information.
|
|
Packit |
ae235b |
If the call was GetAll, NULL will be returned.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Parameters
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
invocation
|
|
Packit |
ae235b |
A GDBusMethodInvocation
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Returns
|
|
Packit |
ae235b |
a GDBusPropertyInfo or NULL.
|
|
Packit |
ae235b |
[transfer none]
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Since: 2.38
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_dbus_method_invocation_get_connection ()
|
|
Packit |
ae235b |
GDBusConnection *
|
|
Packit |
ae235b |
g_dbus_method_invocation_get_connection
|
|
Packit |
ae235b |
(GDBusMethodInvocation *invocation);
|
|
Packit |
ae235b |
Gets the GDBusConnection the method was invoked on.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Parameters
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
invocation
|
|
Packit |
ae235b |
A GDBusMethodInvocation.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Returns
|
|
Packit |
ae235b |
A GDBusConnection. Do not free, it is owned by invocation
|
|
Packit |
ae235b |
.
|
|
Packit |
ae235b |
[transfer none]
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Since: 2.26
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_dbus_method_invocation_get_message ()
|
|
Packit |
ae235b |
GDBusMessage *
|
|
Packit |
ae235b |
g_dbus_method_invocation_get_message (GDBusMethodInvocation *invocation);
|
|
Packit |
ae235b |
Gets the GDBusMessage for the method invocation. This is useful if
|
|
Packit |
ae235b |
you need to use low-level protocol features, such as UNIX file
|
|
Packit |
ae235b |
descriptor passing, that cannot be properly expressed in the
|
|
Packit |
ae235b |
GVariant API.
|
|
Packit |
ae235b |
See this server and client
|
|
Packit |
ae235b |
for an example of how to use this low-level API to send and receive
|
|
Packit |
ae235b |
UNIX file descriptors.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Parameters
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
invocation
|
|
Packit |
ae235b |
A GDBusMethodInvocation.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Returns
|
|
Packit |
ae235b |
GDBusMessage. Do not free, it is owned by invocation
|
|
Packit |
ae235b |
.
|
|
Packit |
ae235b |
[transfer none]
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Since: 2.26
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_dbus_method_invocation_get_parameters ()
|
|
Packit |
ae235b |
GVariant *
|
|
Packit |
ae235b |
g_dbus_method_invocation_get_parameters
|
|
Packit |
ae235b |
(GDBusMethodInvocation *invocation);
|
|
Packit |
ae235b |
Gets the parameters of the method invocation. If there are no input
|
|
Packit |
ae235b |
parameters then this will return a GVariant with 0 children rather than NULL.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Parameters
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
invocation
|
|
Packit |
ae235b |
A GDBusMethodInvocation.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Returns
|
|
Packit |
ae235b |
A GVariant tuple. Do not unref this because it is owned by invocation
|
|
Packit |
ae235b |
.
|
|
Packit |
ae235b |
[transfer none]
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Since: 2.26
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_dbus_method_invocation_get_user_data ()
|
|
Packit |
ae235b |
gpointer
|
|
Packit |
ae235b |
g_dbus_method_invocation_get_user_data
|
|
Packit |
ae235b |
(GDBusMethodInvocation *invocation);
|
|
Packit |
ae235b |
Gets the user_data
|
|
Packit |
ae235b |
gpointer passed to g_dbus_connection_register_object().
|
|
Packit |
ae235b |
[skip]
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Parameters
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
invocation
|
|
Packit |
ae235b |
A GDBusMethodInvocation.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Returns
|
|
Packit |
ae235b |
A gpointer.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Since: 2.26
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_dbus_method_invocation_return_value ()
|
|
Packit |
ae235b |
void
|
|
Packit |
ae235b |
g_dbus_method_invocation_return_value (GDBusMethodInvocation *invocation,
|
|
Packit |
ae235b |
GVariant *parameters);
|
|
Packit |
ae235b |
Finishes handling a D-Bus method call by returning parameters
|
|
Packit |
ae235b |
.
|
|
Packit |
ae235b |
If the parameters
|
|
Packit |
ae235b |
GVariant is floating, it is consumed.
|
|
Packit |
ae235b |
It is an error if parameters
|
|
Packit |
ae235b |
is not of the right format: it must be a tuple
|
|
Packit |
ae235b |
containing the out-parameters of the D-Bus method. Even if the method has a
|
|
Packit |
ae235b |
single out-parameter, it must be contained in a tuple. If the method has no
|
|
Packit |
ae235b |
out-parameters, parameters
|
|
Packit |
ae235b |
may be NULL or an empty tuple.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
1
|
|
Packit |
ae235b |
2
|
|
Packit |
ae235b |
3
|
|
Packit |
ae235b |
4
|
|
Packit |
ae235b |
5
|
|
Packit |
ae235b |
6
|
|
Packit |
ae235b |
7
|
|
Packit |
ae235b |
8
|
|
Packit |
ae235b |
9
|
|
Packit |
ae235b |
10
|
|
Packit |
ae235b |
11
|
|
Packit |
ae235b |
12
|
|
Packit |
ae235b |
13
|
|
Packit |
ae235b |
GDBusMethodInvocation *invocation = some_invocation;
|
|
Packit |
ae235b |
g_autofree gchar *result_string = NULL;
|
|
Packit |
ae235b |
g_autoptr (GError) error = NULL;
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
result_string = calculate_result (&error);
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
if (error != NULL)
|
|
Packit |
ae235b |
g_dbus_method_invocation_return_gerror (invocation, error);
|
|
Packit |
ae235b |
else
|
|
Packit |
ae235b |
g_dbus_method_invocation_return_value (invocation,
|
|
Packit |
ae235b |
g_variant_new ("(s)", result_string));
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
This method will take ownership of invocation
|
|
Packit |
ae235b |
. See
|
|
Packit |
ae235b |
GDBusInterfaceVTable for more information about the ownership of
|
|
Packit |
ae235b |
invocation
|
|
Packit |
ae235b |
.
|
|
Packit |
ae235b |
Since 2.48, if the method call requested for a reply not to be sent
|
|
Packit |
ae235b |
then this call will sink parameters
|
|
Packit |
ae235b |
and free invocation
|
|
Packit |
ae235b |
, but
|
|
Packit |
ae235b |
otherwise do nothing (as per the recommendations of the D-Bus
|
|
Packit |
ae235b |
specification).
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Parameters
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
invocation
|
|
Packit |
ae235b |
A GDBusMethodInvocation.
|
|
Packit |
ae235b |
[transfer full]
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
parameters
|
|
Packit |
ae235b |
A GVariant tuple with out parameters for the method or NULL if not passing any parameters.
|
|
Packit |
ae235b |
[nullable]
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Since: 2.26
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_dbus_method_invocation_return_error ()
|
|
Packit |
ae235b |
void
|
|
Packit |
ae235b |
g_dbus_method_invocation_return_error (GDBusMethodInvocation *invocation,
|
|
Packit |
ae235b |
GQuark domain,
|
|
Packit |
ae235b |
gint code,
|
|
Packit |
ae235b |
const gchar *format,
|
|
Packit |
ae235b |
...);
|
|
Packit |
ae235b |
Finishes handling a D-Bus method call by returning an error.
|
|
Packit |
ae235b |
See g_dbus_error_encode_gerror() for details about what error name
|
|
Packit |
ae235b |
will be returned on the wire. In a nutshell, if the given error is
|
|
Packit |
ae235b |
registered using g_dbus_error_register_error() the name given
|
|
Packit |
ae235b |
during registration is used. Otherwise, a name of the form
|
|
Packit |
ae235b |
org.gtk.GDBus.UnmappedGError.Quark... is used. This provides
|
|
Packit |
ae235b |
transparent mapping of GError between applications using GDBus.
|
|
Packit |
ae235b |
If you are writing an application intended to be portable,
|
|
Packit |
ae235b |
always register errors with g_dbus_error_register_error()
|
|
Packit |
ae235b |
or use g_dbus_method_invocation_return_dbus_error().
|
|
Packit |
ae235b |
This method will take ownership of invocation
|
|
Packit |
ae235b |
. See
|
|
Packit |
ae235b |
GDBusInterfaceVTable for more information about the ownership of
|
|
Packit |
ae235b |
invocation
|
|
Packit |
ae235b |
.
|
|
Packit |
ae235b |
Since 2.48, if the method call requested for a reply not to be sent
|
|
Packit |
ae235b |
then this call will free invocation
|
|
Packit |
ae235b |
but otherwise do nothing (as per
|
|
Packit |
ae235b |
the recommendations of the D-Bus specification).
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Parameters
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
invocation
|
|
Packit |
ae235b |
A GDBusMethodInvocation.
|
|
Packit |
ae235b |
[transfer full]
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
domain
|
|
Packit |
ae235b |
A GQuark for the GError error domain.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
code
|
|
Packit |
ae235b |
The error code.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
format
|
|
Packit |
ae235b |
printf()-style format.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
...
|
|
Packit |
ae235b |
Parameters for format
|
|
Packit |
ae235b |
.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Since: 2.26
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_dbus_method_invocation_return_error_valist ()
|
|
Packit |
ae235b |
void
|
|
Packit |
ae235b |
g_dbus_method_invocation_return_error_valist
|
|
Packit |
ae235b |
(GDBusMethodInvocation *invocation,
|
|
Packit |
ae235b |
GQuark domain,
|
|
Packit |
ae235b |
gint code,
|
|
Packit |
ae235b |
const gchar *format,
|
|
Packit |
ae235b |
va_list var_args);
|
|
Packit |
ae235b |
Like g_dbus_method_invocation_return_error() but intended for
|
|
Packit |
ae235b |
language bindings.
|
|
Packit |
ae235b |
This method will take ownership of invocation
|
|
Packit |
ae235b |
. See
|
|
Packit |
ae235b |
GDBusInterfaceVTable for more information about the ownership of
|
|
Packit |
ae235b |
invocation
|
|
Packit |
ae235b |
.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Parameters
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
invocation
|
|
Packit |
ae235b |
A GDBusMethodInvocation.
|
|
Packit |
ae235b |
[transfer full]
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
domain
|
|
Packit |
ae235b |
A GQuark for the GError error domain.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
code
|
|
Packit |
ae235b |
The error code.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
format
|
|
Packit |
ae235b |
printf()-style format.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
var_args
|
|
Packit |
ae235b |
va_list of parameters for format
|
|
Packit |
ae235b |
.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Since: 2.26
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_dbus_method_invocation_return_error_literal ()
|
|
Packit |
ae235b |
void
|
|
Packit |
ae235b |
g_dbus_method_invocation_return_error_literal
|
|
Packit |
ae235b |
(GDBusMethodInvocation *invocation,
|
|
Packit |
ae235b |
GQuark domain,
|
|
Packit |
ae235b |
gint code,
|
|
Packit |
ae235b |
const gchar *message);
|
|
Packit |
ae235b |
Like g_dbus_method_invocation_return_error() but without printf()-style formatting.
|
|
Packit |
ae235b |
This method will take ownership of invocation
|
|
Packit |
ae235b |
. See
|
|
Packit |
ae235b |
GDBusInterfaceVTable for more information about the ownership of
|
|
Packit |
ae235b |
invocation
|
|
Packit |
ae235b |
.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Parameters
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
invocation
|
|
Packit |
ae235b |
A GDBusMethodInvocation.
|
|
Packit |
ae235b |
[transfer full]
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
domain
|
|
Packit |
ae235b |
A GQuark for the GError error domain.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
code
|
|
Packit |
ae235b |
The error code.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
message
|
|
Packit |
ae235b |
The error message.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Since: 2.26
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_dbus_method_invocation_return_gerror ()
|
|
Packit |
ae235b |
void
|
|
Packit |
ae235b |
g_dbus_method_invocation_return_gerror
|
|
Packit |
ae235b |
(GDBusMethodInvocation *invocation,
|
|
Packit |
ae235b |
const GError *error);
|
|
Packit |
ae235b |
Like g_dbus_method_invocation_return_error() but takes a GError
|
|
Packit |
ae235b |
instead of the error domain, error code and message.
|
|
Packit |
ae235b |
This method will take ownership of invocation
|
|
Packit |
ae235b |
. See
|
|
Packit |
ae235b |
GDBusInterfaceVTable for more information about the ownership of
|
|
Packit |
ae235b |
invocation
|
|
Packit |
ae235b |
.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Parameters
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
invocation
|
|
Packit |
ae235b |
A GDBusMethodInvocation.
|
|
Packit |
ae235b |
[transfer full]
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
error
|
|
Packit |
ae235b |
A GError.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Since: 2.26
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_dbus_method_invocation_return_dbus_error ()
|
|
Packit |
ae235b |
void
|
|
Packit |
ae235b |
g_dbus_method_invocation_return_dbus_error
|
|
Packit |
ae235b |
(GDBusMethodInvocation *invocation,
|
|
Packit |
ae235b |
const gchar *error_name,
|
|
Packit |
ae235b |
const gchar *error_message);
|
|
Packit |
ae235b |
Finishes handling a D-Bus method call by returning an error.
|
|
Packit |
ae235b |
This method will take ownership of invocation
|
|
Packit |
ae235b |
. See
|
|
Packit |
ae235b |
GDBusInterfaceVTable for more information about the ownership of
|
|
Packit |
ae235b |
invocation
|
|
Packit |
ae235b |
.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Parameters
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
invocation
|
|
Packit |
ae235b |
A GDBusMethodInvocation.
|
|
Packit |
ae235b |
[transfer full]
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
error_name
|
|
Packit |
ae235b |
A valid D-Bus error name.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
error_message
|
|
Packit |
ae235b |
A valid D-Bus error message.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Since: 2.26
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_dbus_method_invocation_take_error ()
|
|
Packit |
ae235b |
void
|
|
Packit |
ae235b |
g_dbus_method_invocation_take_error (GDBusMethodInvocation *invocation,
|
|
Packit |
ae235b |
GError *error);
|
|
Packit |
ae235b |
Like g_dbus_method_invocation_return_gerror() but takes ownership
|
|
Packit |
ae235b |
of error
|
|
Packit |
ae235b |
so the caller does not need to free it.
|
|
Packit |
ae235b |
This method will take ownership of invocation
|
|
Packit |
ae235b |
. See
|
|
Packit |
ae235b |
GDBusInterfaceVTable for more information about the ownership of
|
|
Packit |
ae235b |
invocation
|
|
Packit |
ae235b |
.
|
|
Packit |
ae235b |
[skip]
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Parameters
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
invocation
|
|
Packit |
ae235b |
A GDBusMethodInvocation.
|
|
Packit |
ae235b |
[transfer full]
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
error
|
|
Packit |
ae235b |
A GError.
|
|
Packit |
ae235b |
[transfer full]
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Since: 2.30
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_dbus_method_invocation_return_value_with_unix_fd_list ()
|
|
Packit |
ae235b |
void
|
|
Packit |
ae235b |
g_dbus_method_invocation_return_value_with_unix_fd_list
|
|
Packit |
ae235b |
(GDBusMethodInvocation *invocation,
|
|
Packit |
ae235b |
GVariant *parameters,
|
|
Packit |
ae235b |
GUnixFDList *fd_list);
|
|
Packit |
ae235b |
Like g_dbus_method_invocation_return_value() but also takes a GUnixFDList.
|
|
Packit |
ae235b |
This method is only available on UNIX.
|
|
Packit |
ae235b |
This method will take ownership of invocation
|
|
Packit |
ae235b |
. See
|
|
Packit |
ae235b |
GDBusInterfaceVTable for more information about the ownership of
|
|
Packit |
ae235b |
invocation
|
|
Packit |
ae235b |
.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Parameters
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
invocation
|
|
Packit |
ae235b |
A GDBusMethodInvocation.
|
|
Packit |
ae235b |
[transfer full]
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
parameters
|
|
Packit |
ae235b |
A GVariant tuple with out parameters for the method or NULL if not passing any parameters.
|
|
Packit |
ae235b |
[nullable]
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
fd_list
|
|
Packit |
ae235b |
A GUnixFDList or NULL.
|
|
Packit |
ae235b |
[nullable]
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Since: 2.30
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Types and Values
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
GDBusMethodInvocation
|
|
Packit |
ae235b |
typedef struct _GDBusMethodInvocation GDBusMethodInvocation;
|
|
Packit |
ae235b |
The GDBusMethodInvocation structure contains only private data and
|
|
Packit |
ae235b |
should only be accessed using the provided API.
|
|
Packit |
ae235b |
Since: 2.26
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Generated by GTK-Doc V1.27
|
|
Packit |
ae235b |
</body>
|
|
Packit |
ae235b |
</html>
|