~ubuntu-branches/debian/stretch/colord/stretch

« back to all changes in this revision

Viewing changes to doc/api/html/colord-cd-profile-sync.html

  • Committer: Package Import Robot
  • Author(s): Christopher James Halse Rogers
  • Date: 2015-08-13 08:56:11 UTC
  • mfrom: (1.1.10)
  • Revision ID: package-import@ubuntu.com-20150813085611-946sqkendiafealo
Tags: 1.2.11-1
* Add missing GFDL licence for documentation
* Merge new upstream 1.2.11 release. (Closes: 782477)
* Cherry pick commit to check for, and prefer, libsystemd over
  libsystemd-login. (Closes: 779777)
* debian/libcolorhug2.symbols: Add new ch_device_close symbol.
* Remove no-longer-used colord.conf (Closes: 751212)
* Add new symbols to libcolord-private symbols file
* Add new functions to libcolorhug2 symbols file
* Add newly-introduced symbols to symbols file
* Update DEP8 control for libtool-bin split
* Output better logs on DEP8 failures
* Add colord-sensor-argyll package
* Disable strangely-failing DEP8 test

Show diffs side-by-side

added added

removed removed

Lines of Context:
2
2
<html>
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
 
<title>colord Reference Manual: cd-profile-sync</title>
 
5
<title>cd-profile-sync: colord Reference Manual</title>
6
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7
7
<link rel="home" href="index.html" title="colord Reference Manual">
8
8
<link rel="up" href="libcolord.html" title="libcolord">
9
9
<link rel="prev" href="colord-cd-device.html" title="cd-device">
10
10
<link rel="next" href="colord-cd-profile.html" title="cd-profile">
11
 
<meta name="generator" content="GTK-Doc V1.20 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.23 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
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="10"><tr valign="middle">
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
16
16
<td width="100%" align="left" class="shortcuts">
17
 
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 
18
 
                  <a href="#colord-cd-profile-sync.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 
19
 
                  <a href="#colord-cd-profile-sync.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
 
17
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
 
18
                  <a href="#colord-cd-profile-sync.description" class="shortcut">Description</a></span>
20
19
</td>
21
20
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
22
21
<td><a accesskey="u" href="libcolord.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
42
41
<tbody>
43
42
<tr>
44
43
<td class="function_type">
45
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 
44
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
46
45
</td>
47
46
<td class="function_name">
48
47
<a class="link" href="colord-cd-profile-sync.html#cd-profile-connect-sync" title="cd_profile_connect_sync ()">cd_profile_connect_sync</a> <span class="c_punctuation">()</span>
50
49
</tr>
51
50
<tr>
52
51
<td class="function_type">
53
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 
52
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
54
53
</td>
55
54
<td class="function_name">
56
55
<a class="link" href="colord-cd-profile-sync.html#cd-profile-set-property-sync" title="cd_profile_set_property_sync ()">cd_profile_set_property_sync</a> <span class="c_punctuation">()</span>
58
57
</tr>
59
58
<tr>
60
59
<td class="function_type">
61
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 
60
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
62
61
</td>
63
62
<td class="function_name">
64
63
<a class="link" href="colord-cd-profile-sync.html#cd-profile-install-system-wide-sync" title="cd_profile_install_system_wide_sync ()">cd_profile_install_system_wide_sync</a> <span class="c_punctuation">()</span>
68
67
</table></div>
69
68
</div>
70
69
<div class="refsect1">
71
 
<a name="colord-cd-profile-sync.object-hierarchy"></a><h2>Object Hierarchy</h2>
72
 
<pre class="screen">
73
 
</pre>
74
 
</div>
75
 
<div class="refsect1">
76
70
<a name="colord-cd-profile-sync.description"></a><h2>Description</h2>
77
71
<p>These helper functions provide a simple way to use the async functions
78
72
in command line tools.</p>
82
76
<a name="colord-cd-profile-sync.functions_details"></a><h2>Functions</h2>
83
77
<div class="refsect2">
84
78
<a name="cd-profile-connect-sync"></a><h3>cd_profile_connect_sync ()</h3>
85
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 
79
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
86
80
cd_profile_connect_sync (<em class="parameter"><code><span class="type">CdProfile</span> *profile</code></em>,
87
 
                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
88
 
                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
81
                         <em class="parameter"><code><a href="https://developer.gnome.org/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
 
82
                         <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
89
83
<p>Connects to the object and fills up initial properties.</p>
90
84
<p>WARNING: This function is synchronous, and may block.
91
85
Do not use it in GUI applications.</p>
92
86
<div class="refsect3">
93
 
<a name="id-1.4.7.6.2.6"></a><h4>Parameters</h4>
 
87
<a name="id-1.4.7.5.2.6"></a><h4>Parameters</h4>
94
88
<div class="informaltable"><table width="100%" border="0">
95
89
<colgroup>
96
90
<col width="150px" class="parameters_name">
105
99
</tr>
106
100
<tr>
107
101
<td class="parameter_name"><p>cancellable</p></td>
108
 
<td class="parameter_description"><p>a <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
 
102
<td class="parameter_description"><p>a <a href="https://developer.gnome.org/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
109
103
<td class="parameter_annotations"> </td>
110
104
</tr>
111
105
<tr>
112
106
<td class="parameter_name"><p>error</p></td>
113
 
<td class="parameter_description"><p>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
 
107
<td class="parameter_description"><p>a <a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
114
108
<td class="parameter_annotations"> </td>
115
109
</tr>
116
110
</tbody>
117
111
</table></div>
118
112
</div>
119
113
<div class="refsect3">
120
 
<a name="id-1.4.7.6.2.7"></a><h4>Returns</h4>
121
 
<p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> for success, else <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p>
 
114
<a name="id-1.4.7.5.2.7"></a><h4>Returns</h4>
 
115
<p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> for success, else <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p>
122
116
<p></p>
123
117
</div>
124
118
<p class="since">Since 0.1.8</p>
126
120
<hr>
127
121
<div class="refsect2">
128
122
<a name="cd-profile-set-property-sync"></a><h3>cd_profile_set_property_sync ()</h3>
129
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 
123
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
130
124
cd_profile_set_property_sync (<em class="parameter"><code><span class="type">CdProfile</span> *profile</code></em>,
131
 
                              <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
132
 
                              <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *value</code></em>,
133
 
                              <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
134
 
                              <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
125
                              <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
 
126
                              <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *value</code></em>,
 
127
                              <em class="parameter"><code><a href="https://developer.gnome.org/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
 
128
                              <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
135
129
<p>Sets properties on an object</p>
136
130
<p>WARNING: This function is synchronous, and may block.
137
131
Do not use it in GUI applications.</p>
138
132
<div class="refsect3">
139
 
<a name="id-1.4.7.6.3.6"></a><h4>Parameters</h4>
 
133
<a name="id-1.4.7.5.3.6"></a><h4>Parameters</h4>
140
134
<div class="informaltable"><table width="100%" border="0">
141
135
<colgroup>
142
136
<col width="150px" class="parameters_name">
161
155
</tr>
162
156
<tr>
163
157
<td class="parameter_name"><p>cancellable</p></td>
164
 
<td class="parameter_description"><p>a <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
 
158
<td class="parameter_description"><p>a <a href="https://developer.gnome.org/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
165
159
<td class="parameter_annotations"> </td>
166
160
</tr>
167
161
<tr>
168
162
<td class="parameter_name"><p>error</p></td>
169
 
<td class="parameter_description"><p>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
 
163
<td class="parameter_description"><p>a <a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
170
164
<td class="parameter_annotations"> </td>
171
165
</tr>
172
166
</tbody>
173
167
</table></div>
174
168
</div>
175
169
<div class="refsect3">
176
 
<a name="id-1.4.7.6.3.7"></a><h4>Returns</h4>
177
 
<p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> for success, else <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p>
 
170
<a name="id-1.4.7.5.3.7"></a><h4>Returns</h4>
 
171
<p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> for success, else <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p>
178
172
<p></p>
179
173
</div>
180
174
<p class="since">Since 0.1.8</p>
182
176
<hr>
183
177
<div class="refsect2">
184
178
<a name="cd-profile-install-system-wide-sync"></a><h3>cd_profile_install_system_wide_sync ()</h3>
185
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 
179
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
186
180
cd_profile_install_system_wide_sync (<em class="parameter"><code><span class="type">CdProfile</span> *profile</code></em>,
187
 
                                     <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
188
 
                                     <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
181
                                     <em class="parameter"><code><a href="https://developer.gnome.org/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
 
182
                                     <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
189
183
<p>Sets the profile system wide.</p>
190
184
<p>WARNING: This function is synchronous, and may block.
191
185
Do not use it in GUI applications.</p>
192
186
<div class="refsect3">
193
 
<a name="id-1.4.7.6.4.6"></a><h4>Parameters</h4>
 
187
<a name="id-1.4.7.5.4.6"></a><h4>Parameters</h4>
194
188
<div class="informaltable"><table width="100%" border="0">
195
189
<colgroup>
196
190
<col width="150px" class="parameters_name">
205
199
</tr>
206
200
<tr>
207
201
<td class="parameter_name"><p>cancellable</p></td>
208
 
<td class="parameter_description"><p>a <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
 
202
<td class="parameter_description"><p>a <a href="https://developer.gnome.org/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
209
203
<td class="parameter_annotations"> </td>
210
204
</tr>
211
205
<tr>
212
206
<td class="parameter_name"><p>error</p></td>
213
 
<td class="parameter_description"><p>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
 
207
<td class="parameter_description"><p>a <a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
214
208
<td class="parameter_annotations"> </td>
215
209
</tr>
216
210
</tbody>
217
211
</table></div>
218
212
</div>
219
213
<div class="refsect3">
220
 
<a name="id-1.4.7.6.4.7"></a><h4>Returns</h4>
221
 
<p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> for success, else <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p>
 
214
<a name="id-1.4.7.5.4.7"></a><h4>Returns</h4>
 
215
<p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> for success, else <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p>
222
216
<p></p>
223
217
</div>
224
218
<p class="since">Since 0.1.8</p>
229
223
</div>
230
224
</div>
231
225
<div class="footer">
232
 
<hr>
233
 
          Generated by GTK-Doc V1.20</div>
 
226
<hr>Generated by GTK-Doc V1.23</div>
234
227
</body>
235
228
</html>
 
 
b'\\ No newline at end of file'