← Back to branch summary

~ubuntu-branches/ubuntu/trusty/gobject-introspection/trusty

« back to all changes in this revision

Viewing changes to docs/reference/html/gi-GIConstantInfo.html

  • Committer: Bazaar Package Importer
  • Author(s): Emilio Pozuelo Monfort
  • Date: 2011-03-22 00:32:36 UTC
  • mfrom: (1.4.1 upstream) (3.3.33 multiarch)
  • Revision ID: james.westby@ubuntu.com-20110322003236-4spdgfk1vai6xay1
Tags: 0.10.4-2
Upload to unstable.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/html/gi-GIConstantInfo.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 
5
<title>GIConstantInfo</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
 
7
<link rel="home" href="index.html" title="GObject Introspection Reference Manual">
 
8
<link rel="up" href="gi-repository-structs.html" title="GIRepository structs">
 
9
<link rel="prev" href="gi-GIInterfaceInfo.html" title="GIInterfaceInfo">
 
10
<link rel="next" href="gi-GIErrorDomainInfo.html" title="GIErrorDomainInfo">
 
11
<meta name="generator" content="GTK-Doc V1.16.1 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
</head>
 
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
16
<tr valign="middle">
 
17
<td><a accesskey="p" href="gi-GIInterfaceInfo.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="gi-repository-structs.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
20
<th width="100%" align="center">GObject Introspection Reference Manual</th>
 
21
<td><a accesskey="n" href="gi-GIErrorDomainInfo.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
22
</tr>
 
23
<tr><td colspan="5" class="shortcuts">
 
24
<a href="#gi-GIConstantInfo.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#gi-GIConstantInfo.description" class="shortcut">Description</a>
 
27
</td></tr>
 
28
</table>
 
29
<div class="refentry">
 
30
<a name="gi-GIConstantInfo"></a><div class="titlepage"></div>
 
31
<div class="refnamediv"><table width="100%"><tr>
 
32
<td valign="top">
 
33
<h2><span class="refentrytitle"><a name="gi-GIConstantInfo.top_of_page"></a>GIConstantInfo</span></h2>
 
34
<p>GIConstantInfo — Struct representing a constant</p>
 
35
</td>
 
36
<td valign="top" align="right"></td>
 
37
</tr></table></div>
 
38
<div class="refsynopsisdiv">
 
39
<a name="gi-GIConstantInfo.synopsis"></a><h2>Synopsis</h2>
 
40
<pre class="synopsis">#define             <a class="link" href="gi-GIConstantInfo.html#GI-IS-CONSTANT-INFO:CAPS" title="GI_IS_CONSTANT_INFO()">GI_IS_CONSTANT_INFO</a>                 (info)
 
41
typedef             <a class="link" href="gi-GIConstantInfo.html#GIConstantInfo" title="GIConstantInfo">GIConstantInfo</a>;
 
42
<a class="link" href="gi-GITypeInfo.html#GITypeInfo" title="GITypeInfo"><span class="returnvalue">GITypeInfo</span></a> *        <a class="link" href="gi-GIConstantInfo.html#g-constant-info-get-type" title="g_constant_info_get_type ()">g_constant_info_get_type</a>            (<em class="parameter"><code><a class="link" href="gi-GIConstantInfo.html#GIConstantInfo" title="GIConstantInfo"><span class="type">GIConstantInfo</span></a> *info</code></em>);
 
43
<span class="returnvalue">gint</span>                <a class="link" href="gi-GIConstantInfo.html#g-constant-info-get-value" title="g_constant_info_get_value ()">g_constant_info_get_value</a>           (<em class="parameter"><code><a class="link" href="gi-GIConstantInfo.html#GIConstantInfo" title="GIConstantInfo"><span class="type">GIConstantInfo</span></a> *info</code></em>,
 
44
                                                         <em class="parameter"><code><span class="type">GIArgument</span> *value</code></em>);
 
45
</pre>
 
46
</div>
 
47
<div class="refsect1">
 
48
<a name="gi-GIConstantInfo.description"></a><h2>Description</h2>
 
49
<p>
 
50
GIConstantInfo represents a constant. A constant has a type associated
 
51
which can be obtained by calling <a class="link" href="gi-GIConstantInfo.html#g-constant-info-get-type" title="g_constant_info_get_type ()"><code class="function">g_constant_info_get_type()</code></a> and a value,
 
52
which can be obtained by calling <a class="link" href="gi-GIConstantInfo.html#g-constant-info-get-value" title="g_constant_info_get_value ()"><code class="function">g_constant_info_get_value()</code></a>.
 
53
</p>
 
54
<p>
 
55
</p>
 
56
<div class="refsect1">
 
57
<a name="gi-giconstantinfo.struct-hierarchy"></a><h2>Struct hierarchy</h2>
 
58
<pre class="synopsis">
 
59
  <a class="link" href="gi-GIBaseInfo.html" title="GIBaseInfo">GIBaseInfo</a>
 
60
   +----GIConstantInfo
 
61
</pre>
 
62
</div>
 
63
<p>
 
64
</p>
 
65
</div>
 
66
<div class="refsect1">
 
67
<a name="gi-GIConstantInfo.details"></a><h2>Details</h2>
 
68
<div class="refsect2">
 
69
<a name="GI-IS-CONSTANT-INFO:CAPS"></a><h3>GI_IS_CONSTANT_INFO()</h3>
 
70
<pre class="programlisting">#define             GI_IS_CONSTANT_INFO(info)</pre>
 
71
<p>
 
72
</p>
 
73
</div>
 
74
<hr>
 
75
<div class="refsect2">
 
76
<a name="GIConstantInfo"></a><h3>GIConstantInfo</h3>
 
77
<pre class="programlisting">typedef GIBaseInfo GIConstantInfo;
 
78
</pre>
 
79
<p>
 
80
Represents a constant.
 
81
</p>
 
82
</div>
 
83
<hr>
 
84
<div class="refsect2">
 
85
<a name="g-constant-info-get-type"></a><h3>g_constant_info_get_type ()</h3>
 
86
<pre class="programlisting"><a class="link" href="gi-GITypeInfo.html#GITypeInfo" title="GITypeInfo"><span class="returnvalue">GITypeInfo</span></a> *        g_constant_info_get_type            (<em class="parameter"><code><a class="link" href="gi-GIConstantInfo.html#GIConstantInfo" title="GIConstantInfo"><span class="type">GIConstantInfo</span></a> *info</code></em>);</pre>
 
87
<p>
 
88
Obtain the type of the constant as a <a class="link" href="gi-GITypeInfo.html#GITypeInfo" title="GITypeInfo"><span class="type">GITypeInfo</span></a>.
 
89
</p>
 
90
<div class="variablelist"><table border="0">
 
91
<col align="left" valign="top">
 
92
<tbody>
 
93
<tr>
 
94
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
 
95
<td>a <a class="link" href="gi-GIConstantInfo.html#GIConstantInfo" title="GIConstantInfo"><span class="type">GIConstantInfo</span></a>
 
96
</td>
 
97
</tr>
 
98
<tr>
 
99
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
100
<td>the <a class="link" href="gi-GITypeInfo.html#GITypeInfo" title="GITypeInfo"><span class="type">GITypeInfo</span></a>. Free the struct by calling
 
101
<a class="link" href="gi-GIBaseInfo.html#g-base-info-unref" title="g_base_info_unref ()"><code class="function">g_base_info_unref()</code></a> when done. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 
102
</td>
 
103
</tr>
 
104
</tbody>
 
105
</table></div>
 
106
</div>
 
107
<hr>
 
108
<div class="refsect2">
 
109
<a name="g-constant-info-get-value"></a><h3>g_constant_info_get_value ()</h3>
 
110
<pre class="programlisting"><span class="returnvalue">gint</span>                g_constant_info_get_value           (<em class="parameter"><code><a class="link" href="gi-GIConstantInfo.html#GIConstantInfo" title="GIConstantInfo"><span class="type">GIConstantInfo</span></a> *info</code></em>,
 
111
                                                         <em class="parameter"><code><span class="type">GIArgument</span> *value</code></em>);</pre>
 
112
<p>
 
113
Obtain the value associated with the <a class="link" href="gi-GIConstantInfo.html#GIConstantInfo" title="GIConstantInfo"><span class="type">GIConstantInfo</span></a> and store it in the
 
114
<em class="parameter"><code>value</code></em> parameter. <em class="parameter"><code>argument</code></em> needs to be allocated before passing it in.
 
115
The size of the constant value stored in <em class="parameter"><code>argument</code></em> will be returned.
 
116
</p>
 
117
<div class="variablelist"><table border="0">
 
118
<col align="left" valign="top">
 
119
<tbody>
 
120
<tr>
 
121
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
 
122
<td>a <a class="link" href="gi-GIConstantInfo.html#GIConstantInfo" title="GIConstantInfo"><span class="type">GIConstantInfo</span></a>
 
123
</td>
 
124
</tr>
 
125
<tr>
 
126
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 
127
<td>an argument. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
 
128
</td>
 
129
</tr>
 
130
<tr>
 
131
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
132
<td>size of the constant</td>
 
133
</tr>
 
134
</tbody>
 
135
</table></div>
 
136
</div>
 
137
</div>
 
138
</div>
 
139
<div class="footer">
 
140
<hr>
 
141
          Generated by GTK-Doc V1.16.1</div>
 
142
</body>
 
143
</html>
 
 
b'\\ No newline at end of file'