← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/dbus-glib/oneiric-updates

« back to all changes in this revision

Viewing changes to doc/reference/xml/dbus-gmessage.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastian Dröge
  • Date: 2006-11-01 10:51:01 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20061101105101-2dbr969h8k05n1b2
Tags: 0.72-0ubuntu1
* Sync with pkg-utopia SVN. This is infact 0.72-1 which sits in NEW
* New upstream release
* debian/control:
  + Require libdbus-1-dev (>= 0.94) and libglib2.0-dev (>= 2.6)
  + Add build dependency on gtk-doc-tools (>= 1.4)
* debian/control,
  debian/libdbus-glib-1-doc.install:
  + Add libdbus-glib-1-doc package

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/xml/dbus-gmessage.xml
 
1
<?xml version="1.0"?>
 
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
 
3
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
 
4
<!ENTITY dbus-binding-tool SYSTEM "dbus-binding-tool.xml">
 
5
<!ENTITY version SYSTEM "version.xml">
 
6
]>
 
7
<refentry id="dbus-glib-DBusGMessage">
 
8
<refmeta>
 
9
<refentrytitle id="top_of_page">DBusGMessage</refentrytitle>
 
10
<manvolnum>3</manvolnum>
 
11
<refmiscinfo>DBUS-GLIB Library</refmiscinfo>
 
12
</refmeta>
 
13
 
 
14
<refnamediv>
 
15
<refname>DBusGMessage</refname>
 
16
<refpurpose>DBus Message</refpurpose>
 
17
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
 
18
</refnamediv>
 
19
<refsect1>
 
20
<title>Stability Level</title>
 
21
Stable, unless otherwise indicated
 
22
</refsect1>
 
23
 
 
24
<refsynopsisdiv id="synopsis">
 
25
<title id="synopsis.title">Synopsis</title>
 
26
 
 
27
<synopsis>
 
28
 
 
29
 
 
30
 
 
31
            <link linkend="DBusGMessage">DBusGMessage</link>;
 
32
<link linkend="DBusGMessage">DBusGMessage</link>* <link linkend="dbus-g-message-ref">dbus_g_message_ref</link>            (<link linkend="DBusGMessage">DBusGMessage</link> *message);
 
33
<link linkend="void">void</link>        <link linkend="dbus-g-message-unref">dbus_g_message_unref</link>            (<link linkend="DBusGMessage">DBusGMessage</link> *message);
 
34
<link linkend="DBusMessage">DBusMessage</link>* <link linkend="dbus-g-message-get-message">dbus_g_message_get_message</link>     (<link linkend="DBusGMessage">DBusGMessage</link> *gmessage);
 
35
 
 
36
</synopsis>
 
37
</refsynopsisdiv>
 
38
 
 
39
 
 
40
 
 
41
 
 
42
 
 
43
 
 
44
 
 
45
 
 
46
 
 
47
<refsect1 id="desc">
 
48
<title id="desc.title">Description</title>
 
49
<para>
 
50
A <link linkend="DBusGConnection"><type>DBusGConnection</type></link> is a boxed type abstracting a DBusMessage.</para>
 
51
<para>
 
52
 
 
53
</para>
 
54
</refsect1>
 
55
 
 
56
<refsect1 id="details">
 
57
<title id="details.title">Details</title>
 
58
<refsect2>
 
59
<title><anchor id="DBusGMessage" role="struct"/>DBusGMessage</title>
 
60
<indexterm><primary>DBusGMessage</primary></indexterm><programlisting>typedef struct _DBusGMessage DBusGMessage;</programlisting>
 
61
<para>
 
62
 
 
63
</para></refsect2>
 
64
<refsect2>
 
65
<title><anchor id="dbus-g-message-ref" role="function"/>dbus_g_message_ref ()</title>
 
66
<indexterm><primary>dbus_g_message_ref</primary></indexterm><programlisting><link linkend="DBusGMessage">DBusGMessage</link>* dbus_g_message_ref            (<link linkend="DBusGMessage">DBusGMessage</link> *message);</programlisting>
 
67
<para>
 
68
Increment refcount on a <link linkend="DBusGMessage"><type>DBusGMessage</type></link></para>
 
69
<para>
 
70
 
 
71
</para><variablelist role="params">
 
72
<varlistentry><term><parameter>message</parameter>&nbsp;:</term>
 
73
<listitem><simpara>
 
74
</simpara></listitem></varlistentry>
 
75
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the message that was ref'd
 
76
</simpara></listitem></varlistentry>
 
77
</variablelist></refsect2>
 
78
<refsect2>
 
79
<title><anchor id="dbus-g-message-unref" role="function"/>dbus_g_message_unref ()</title>
 
80
<indexterm><primary>dbus_g_message_unref</primary></indexterm><programlisting><link linkend="void">void</link>        dbus_g_message_unref            (<link linkend="DBusGMessage">DBusGMessage</link> *message);</programlisting>
 
81
<para>
 
82
Decrement refcount on a <link linkend="DBusGMessage"><type>DBusGMessage</type></link></para>
 
83
<para>
 
84
 
 
85
</para><variablelist role="params">
 
86
<varlistentry><term><parameter>message</parameter>&nbsp;:</term>
 
87
<listitem><simpara>
 
88
 
 
89
 
 
90
</simpara></listitem></varlistentry>
 
91
</variablelist></refsect2>
 
92
<refsect2>
 
93
<title><anchor id="dbus-g-message-get-message" role="function"/>dbus_g_message_get_message ()</title>
 
94
<indexterm><primary>dbus_g_message_get_message</primary></indexterm><programlisting><link linkend="DBusMessage">DBusMessage</link>* dbus_g_message_get_message     (<link linkend="DBusGMessage">DBusGMessage</link> *gmessage);</programlisting>
 
95
<para>
 
96
Get the <link linkend="DBusMessage"><type>DBusMessage</type></link> corresponding to this <link linkend="DBusGMessage"><type>DBusGMessage</type></link>.
 
97
The return value does not have its refcount incremented.</para>
 
98
<para>
 
99
 
 
100
</para><variablelist role="params">
 
101
<varlistentry><term><parameter>gmessage</parameter>&nbsp;:</term>
 
102
<listitem><simpara> a <link linkend="DBusGMessage"><type>DBusGMessage</type></link>
 
103
</simpara></listitem></varlistentry>
 
104
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="DBusMessage"><type>DBusMessage</type></link> 
 
105
</simpara></listitem></varlistentry>
 
106
</variablelist></refsect2>
 
107
 
 
108
</refsect1>
 
109
 
 
110
 
 
111
 
 
112
<refsect1>
 
113
<title>See Also</title>
 
114
<link linkend="DBusMessage"><type>DBusMessage</type></link>
 
115
</refsect1>
 
116
 
 
117
</refentry>