chiark / gitweb /
logind: add HandleLidSwitchDocked= option to logind.conf + documentation
[elogind.git] / man / sd_bus_message_get_cookie.xml
index db344bf1beb7686a6cc96dbe80296501e323d9b9..641ecec659c516b95b6276f7caf1e64f672f5341 100644 (file)
@@ -21,7 +21,7 @@
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<refentry id="sd_bus_message_get_cookie">
+<refentry id="sd_bus_message_get_cookie" conditional="ENABLE_KDBUS">
 
         <refentryinfo>
                 <title>sd_bus_message_get_cookie</title>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_bus_message_get_cookie</function></funcdef>
-                                <paramdef>sd_bus_message<parameter>message</parameter></paramdef>
-                                <paramdef>uint64_t<parameter>cookie</parameter></paramdef>
+                                <paramdef>sd_bus_message *<parameter>message</parameter></paramdef>
+                                <paramdef>uint64_t *<parameter>cookie</parameter></paramdef>
                         </funcprototype>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_bus_message_get_reply_cookie</function></funcdef>
-                                <paramdef>sd_bus_message<parameter>message</parameter></paramdef>
-                                <paramdef>uint64_t<parameter>cookie</parameter></paramdef>
+                                <paramdef>sd_bus_message *<parameter>message</parameter></paramdef>
+                                <paramdef>uint64_t *<parameter>cookie</parameter></paramdef>
                         </funcprototype>
                 </funcsynopsis>
         </refsynopsisdiv>
                 <para><function>sd_bus_message_get_reply_cookie()</function>
                 returns the transaction cookie of the message the
                 specified message is a response to. When a reply
-                message is generated for a method call message its
+                message is generated for a method call message, its
                 cookie is copied over into this field. Note that while
                 every message that is transferred is identified by a
                 cookie, only response messages carry a reply cookie
                 field.</para>
 
                 <para>Both functions take a message object as first
-                parameter and a place to store the 64bit cookie
+                parameter and a place to store the 64-bit cookie
                 in.</para>
         </refsect1>
 
@@ -96,8 +96,8 @@
                 integer. On failure, these calls return a negative
                 errno-style error code.</para>
 
-                <para>On success the cookie/reply cookie is returned
-                in the specified 64bit unsigned integer variable.</para>
+                <para>On success, the cookie/reply cookie is returned
+                in the specified 64-bit unsigned integer variable.</para>
         </refsect1>
 
         <refsect1>
                                 been sent yet and hence has no cookie
                                 assigned, or that the message is not a
                                 method response message and hence
-                                carries to reply cookie
+                                carries a reply cookie
                                 field.</para></listitem>
                         </varlistentry>
                 </variablelist>
                 and <function>sd_bus_message_get_reply_cookie()</function>
                 interfaces are available as a shared library, which can
                 be compiled and linked to with the
-                <constant>libsystemd-bus</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+                <constant>libsystemd</constant> <citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
                 file.</para>
         </refsect1>