diff options
| author | Will Thompson <will.thompson@collabora.co.uk> | 2010-06-17 15:05:46 +0100 |
|---|---|---|
| committer | Will Thompson <will.thompson@collabora.co.uk> | 2010-06-17 15:27:08 +0100 |
| commit | 1861c9fdd0cbe2be0351e9bdc5b199ff300a0844 (patch) | |
| tree | 2bc9b3675aafafceb8cf1b77652ea49134091a7b /doc | |
| parent | c8aa4ba183efa29889edfff5a7653c055512d426 (diff) | |
Clarify GetConnectionUnixUser documentation.
(This makes it match the freshly-documented GetConnectionUnixProcessID.)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/dbus-specification.xml | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/doc/dbus-specification.xml b/doc/dbus-specification.xml index 8f6b40e9..0e3a1783 100644 --- a/doc/dbus-specification.xml +++ b/doc/dbus-specification.xml @@ -4172,7 +4172,7 @@ <para> As a method: <programlisting> - UINT32 GetConnectionUnixUser (in STRING connection_name) + UINT32 GetConnectionUnixUser (in STRING bus_name) </programlisting> Message arguments: <informaltable> @@ -4188,7 +4188,9 @@ <row> <entry>0</entry> <entry>STRING</entry> - <entry>Name of the connection to query</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> @@ -4207,14 +4209,14 @@ <row> <entry>0</entry> <entry>UINT32</entry> - <entry>unix user id</entry> + <entry>Unix user ID</entry> </row> </tbody> </tgroup> </informaltable> - Returns the unix uid of the process connected to the server. If unable to - determine it, a <literal>org.freedesktop.DBus.Error.Failed</literal> - error is returned. + Returns the Unix user 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> |