summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorWill Thompson <will.thompson@collabora.co.uk>2009-08-04 11:22:33 +0100
committerWill Thompson <will.thompson@collabora.co.uk>2010-06-17 15:27:07 +0100
commit318c55c9c0e07e0da6e5994c2abb4e23a42cfed9 (patch)
treee1e8251bfc305f43c79531898fd7b4d0d99b3dba /doc
parent1b6adc407e361c720528398e35183b8a8b603ae4 (diff)
Document GetConnectionUnixProcessID in the spec
Diffstat (limited to 'doc')
-rw-r--r--doc/dbus-specification.xml53
1 files changed, 53 insertions, 0 deletions
diff --git a/doc/dbus-specification.xml b/doc/dbus-specification.xml
index a9f3b344..297eaa22 100644
--- a/doc/dbus-specification.xml
+++ b/doc/dbus-specification.xml
@@ -4162,6 +4162,59 @@
</para>
</sect3>
+ <sect3 id="bus-messages-get-connection-unix-process-id">
+ <title><literal>org.freedesktop.DBus.GetConnectionUnixProcessID</literal></title>
+ <para>
+ As a method:
+ <programlisting>
+ UINT32 GetConnectionUnixProcessID (in STRING bus_name)
+ </programlisting>
+ Message arguments:
+ <informaltable>
+ <tgroup cols="3">
+ <thead>
+ <row>
+ <entry>Argument</entry>
+ <entry>Type</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>0</entry>
+ <entry>STRING</entry>
+ <entry>Unique or well-known bus name of the connection to
+ query, such as <literal>:12.34</literal> or
+ <literal>com.example.tea</literal></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ Reply arguments:
+ <informaltable>
+ <tgroup cols="3">
+ <thead>
+ <row>
+ <entry>Argument</entry>
+ <entry>Type</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>0</entry>
+ <entry>UINT32</entry>
+ <entry>Unix process id</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ Returns the Unix process ID of the process connected to the server. If
+ unable to determine it (for instance, because the process is not on the
+ same machine as the bus daemon), an error is returned.
+ </para>
+ </sect3>
+
<sect3 id="bus-messages-add-match">
<title><literal>org.freedesktop.DBus.AddMatch</literal></title>
<para>