~ubuntu-branches/ubuntu/quantal/libbonobo/quantal-201207170711

« back to all changes in this revision

Viewing changes to doc/activation-api/html/bonobo-activation-Registration.html

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Holbach
  • Date: 2007-03-12 15:39:17 UTC
  • mfrom: (1.1.13 upstream)
  • Revision ID: james.westby@ubuntu.com-20070312153917-u4efw149urh2enej
Tags: 2.18.0-0ubuntu1
* New upstream release:
  - Code cleanups
  - Build fix
  - Updated translations.

Show diffs side-by-side

added added

removed removed

Lines of Context:
8
8
<link rel="up" href="api-reference.html" title="API Reference">
9
9
<link rel="prev" href="bonobo-activation-Utilities.html" title="Utilities">
10
10
<link rel="next" href="bonobo-activation-Debugging.html" title="Debugging">
11
 
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="chapter" href="tutorial.html" title="Bonobo Activation tutorial">
14
14
<link rel="chapter" href="configuring.html" title="Configuring Bonobo Activation">
28
28
<th width="100%" align="center">Bonobo Activation API Reference Manual</th>
29
29
<td><a accesskey="n" href="bonobo-activation-Debugging.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
30
30
</tr>
31
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2759229" class="shortcut">Top</a>
 
31
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id3117646" class="shortcut">Top</a>
32
32
                  &#160;|&#160;
33
 
                  <a href="#id2759508" class="shortcut">Description</a></nobr></td></tr>
 
33
                  <a href="#id3117927" class="shortcut">Description</a></nobr></td></tr>
34
34
</table>
35
35
<div class="refentry" lang="en">
36
36
<a name="bonobo-activation-Registration"></a><div class="titlepage"></div>
37
37
<div class="refnamediv"><table width="100%"><tr>
38
38
<td valign="top">
39
39
<h2>
40
 
<a name="id2759229"></a><span class="refentrytitle">Registration</span>
 
40
<a name="id3117646"></a><span class="refentrytitle">Registration</span>
41
41
</h2>
42
42
<p>Registration &#8212; Registering CORBA objects to Bonobo Activation.</p>
43
43
</td>
50
50
#include &lt;bonobo-activation/bonobo-activation.h&gt;
51
51
 
52
52
 
53
 
enum        <a href="bonobo-activation-Registration.html#Bonobo-RegistrationResult">Bonobo_RegistrationResult</a>;
54
 
void        <a href="bonobo-activation-Registration.html#bonobo-activation-unregister-active-server">bonobo_activation_unregister_active_server</a>
55
 
                                            (const char *iid,
56
 
                                             CORBA_Object obj);
57
 
void        <a href="bonobo-activation-Registration.html#bonobo-activation-registration-env-free">bonobo_activation_registration_env_free</a>
58
 
                                            (<a
 
53
enum                <a href="bonobo-activation-Registration.html#Bonobo-RegistrationResult">Bonobo_RegistrationResult</a>;
 
54
void                <a href="bonobo-activation-Registration.html#bonobo-activation-unregister-active-server">bonobo_activation_unregister_active_server</a>
 
55
                                                        (const char *iid,
 
56
                                                         CORBA_Object obj);
 
57
void                <a href="bonobo-activation-Registration.html#bonobo-activation-registration-env-free">bonobo_activation_registration_env_free</a>
 
58
                                                        (<a
59
59
href="../glib/glib-Singly-Linked-Lists.html#GSList"
60
60
>GSList</a> *reg_env);
61
61
<a
62
62
href="../glib/glib-Singly-Linked-Lists.html#GSList"
63
 
>GSList</a>*     <a href="bonobo-activation-Registration.html#bonobo-activation-registration-env-set">bonobo_activation_registration_env_set</a>
64
 
                                            (<a
65
 
href="../glib/glib-Singly-Linked-Lists.html#GSList"
66
 
>GSList</a> *reg_env,
67
 
                                             const char *name,
68
 
                                             const char *value);
69
 
void        <a href="bonobo-activation-Registration.html#bonobo-activation-registration-env-set-global">bonobo_activation_registration_env_set_global</a>
70
 
                                            (<a
71
 
href="../glib/glib-Singly-Linked-Lists.html#GSList"
72
 
>GSList</a> *reg_env,
73
 
                                             <a
 
63
>GSList</a>*             <a href="bonobo-activation-Registration.html#bonobo-activation-registration-env-set">bonobo_activation_registration_env_set</a>
 
64
                                                        (<a
 
65
href="../glib/glib-Singly-Linked-Lists.html#GSList"
 
66
>GSList</a> *reg_env,
 
67
                                                         const char *name,
 
68
                                                         const char *value);
 
69
void                <a href="bonobo-activation-Registration.html#bonobo-activation-registration-env-set-global">bonobo_activation_registration_env_set_global</a>
 
70
                                                        (<a
 
71
href="../glib/glib-Singly-Linked-Lists.html#GSList"
 
72
>GSList</a> *reg_env,
 
73
                                                         <a
74
74
href="../glib/glib-Basic-Types.html#gboolean"
75
75
>gboolean</a> append_if_existing);
76
76
<a href="bonobo-activation-Registration.html#Bonobo-RegistrationResult">Bonobo_RegistrationResult</a> <a href="bonobo-activation-Registration.html#bonobo-activation-register-active-server">bonobo_activation_register_active_server</a>
77
 
                                            (const char *iid,
78
 
                                             CORBA_Object obj,
79
 
                                             <a
 
77
                                                        (const char *iid,
 
78
                                                         CORBA_Object obj,
 
79
                                                         <a
80
80
href="../glib/glib-Singly-Linked-Lists.html#GSList"
81
81
>GSList</a> *reg_env);
82
 
const char* <a href="bonobo-activation-Registration.html#bonobo-activation-iid-get">bonobo_activation_iid_get</a>       (void);
83
 
            <a href="bonobo-activation-Registration.html#BonoboActivationPlugin">BonoboActivationPlugin</a>;
84
 
            <a href="bonobo-activation-Registration.html#BonoboActivationPluginObject">BonoboActivationPluginObject</a>;
85
 
void        <a href="bonobo-activation-Registration.html#bonobo-activation-plugin-use">bonobo_activation_plugin_use</a>    (PortableServer_Servant servant,
86
 
                                             <a
 
82
const char*         <a href="bonobo-activation-Registration.html#bonobo-activation-iid-get">bonobo_activation_iid_get</a>           (void);
 
83
                    <a href="bonobo-activation-Registration.html#BonoboActivationPlugin">BonoboActivationPlugin</a>;
 
84
                    <a href="bonobo-activation-Registration.html#BonoboActivationPluginObject">BonoboActivationPluginObject</a>;
 
85
void                <a href="bonobo-activation-Registration.html#bonobo-activation-plugin-use">bonobo_activation_plugin_use</a>        (PortableServer_Servant servant,
 
86
                                                         <a
87
87
href="../glib/glib-Basic-Types.html#gpointer"
88
88
>gpointer</a> impl_ptr);
89
 
void        <a href="bonobo-activation-Registration.html#bonobo-activation-plugin-unuse">bonobo_activation_plugin_unuse</a>  (<a
 
89
void                <a href="bonobo-activation-Registration.html#bonobo-activation-plugin-unuse">bonobo_activation_plugin_unuse</a>      (<a
90
90
href="../glib/glib-Basic-Types.html#gpointer"
91
91
>gpointer</a> impl_ptr);
92
92
 
93
93
</pre>
94
94
</div>
95
95
<div class="refsect1" lang="en">
96
 
<a name="id2759508"></a><h2>Description</h2>
 
96
<a name="id3117927"></a><h2>Description</h2>
97
97
<p>
98
98
When writing a component which can be activated through
99
99
Bonobo Activation by clients, you need to be register your component
101
101
</p>
102
102
</div>
103
103
<div class="refsect1" lang="en">
104
 
<a name="id2759525"></a><h2>Details</h2>
 
104
<a name="id3117945"></a><h2>Details</h2>
105
105
<div class="refsect2" lang="en">
106
 
<a name="id2759536"></a><h3>
 
106
<a name="id3117955"></a><h3>
107
107
<a name="Bonobo-RegistrationResult"></a>enum Bonobo_RegistrationResult</h3>
108
 
<a class="indexterm" name="id2759549"></a><pre class="programlisting">typedef enum {
 
108
<a class="indexterm" name="id3117968"></a><pre class="programlisting">typedef enum {
109
109
  Bonobo_ACTIVATION_REG_SUCCESS,
110
110
  Bonobo_ACTIVATION_REG_NOT_LISTED,
111
111
  Bonobo_ACTIVATION_REG_ALREADY_ACTIVE,
118
118
</div>
119
119
<hr>
120
120
<div class="refsect2" lang="en">
121
 
<a name="id2759567"></a><h3>
 
121
<a name="id3117986"></a><h3>
122
122
<a name="bonobo-activation-unregister-active-server"></a>bonobo_activation_unregister_active_server ()</h3>
123
 
<a class="indexterm" name="id2759581"></a><pre class="programlisting">void        bonobo_activation_unregister_active_server
124
 
                                            (const char *iid,
125
 
                                             CORBA_Object obj);</pre>
 
123
<a class="indexterm" name="id3118000"></a><pre class="programlisting">void                bonobo_activation_unregister_active_server
 
124
                                                        (const char *iid,
 
125
                                                         CORBA_Object obj);</pre>
126
126
<p>
127
127
Unregisters <em class="parameter"><code>obj</code></em> with <em class="parameter"><code>iid</code></em> with the local bonobo-activation-server
128
128
daemon.</p>
147
147
</div>
148
148
<hr>
149
149
<div class="refsect2" lang="en">
150
 
<a name="id2759666"></a><h3>
 
150
<a name="id3118086"></a><h3>
151
151
<a name="bonobo-activation-registration-env-free"></a>bonobo_activation_registration_env_free ()</h3>
152
 
<a class="indexterm" name="id2759680"></a><pre class="programlisting">void        bonobo_activation_registration_env_free
153
 
                                            (<a
 
152
<a class="indexterm" name="id3118100"></a><pre class="programlisting">void                bonobo_activation_registration_env_free
 
153
                                                        (<a
154
154
href="../glib/glib-Singly-Linked-Lists.html#GSList"
155
155
>GSList</a> *reg_env);</pre>
156
156
<p>
169
169
</div>
170
170
<hr>
171
171
<div class="refsect2" lang="en">
172
 
<a name="id2759737"></a><h3>
 
172
<a name="id3118157"></a><h3>
173
173
<a name="bonobo-activation-registration-env-set"></a>bonobo_activation_registration_env_set ()</h3>
174
 
<a class="indexterm" name="id2759751"></a><pre class="programlisting"><a
 
174
<a class="indexterm" name="id3118171"></a><pre class="programlisting"><a
175
175
href="../glib/glib-Singly-Linked-Lists.html#GSList"
176
 
>GSList</a>*     bonobo_activation_registration_env_set
177
 
                                            (<a
 
176
>GSList</a>*             bonobo_activation_registration_env_set
 
177
                                                        (<a
178
178
href="../glib/glib-Singly-Linked-Lists.html#GSList"
179
179
>GSList</a> *reg_env,
180
 
                                             const char *name,
181
 
                                             const char *value);</pre>
 
180
                                                         const char *name,
 
181
                                                         const char *value);</pre>
182
182
<p>
183
183
Sets the environment variable <em class="parameter"><code>name</code></em> to <em class="parameter"><code>value</code></em> in the
184
184
registration environment list <em class="parameter"><code>reg_env</code></em>.</p>
217
217
</div>
218
218
<hr>
219
219
<div class="refsect2" lang="en">
220
 
<a name="id2759901"></a><h3>
 
220
<a name="id3118322"></a><h3>
221
221
<a name="bonobo-activation-registration-env-set-global"></a>bonobo_activation_registration_env_set_global ()</h3>
222
 
<a class="indexterm" name="id2759915"></a><pre class="programlisting">void        bonobo_activation_registration_env_set_global
223
 
                                            (<a
 
222
<a class="indexterm" name="id3118336"></a><pre class="programlisting">void                bonobo_activation_registration_env_set_global
 
223
                                                        (<a
224
224
href="../glib/glib-Singly-Linked-Lists.html#GSList"
225
225
>GSList</a> *reg_env,
226
 
                                             <a
 
226
                                                         <a
227
227
href="../glib/glib-Basic-Types.html#gboolean"
228
228
>gboolean</a> append_if_existing);</pre>
229
229
<p>
253
253
</div>
254
254
<hr>
255
255
<div class="refsect2" lang="en">
256
 
<a name="id2760014"></a><h3>
 
256
<a name="id3118435"></a><h3>
257
257
<a name="bonobo-activation-register-active-server"></a>bonobo_activation_register_active_server ()</h3>
258
 
<a class="indexterm" name="id2760027"></a><pre class="programlisting"><a href="bonobo-activation-Registration.html#Bonobo-RegistrationResult">Bonobo_RegistrationResult</a> bonobo_activation_register_active_server
259
 
                                            (const char *iid,
260
 
                                             CORBA_Object obj,
261
 
                                             <a
 
258
<a class="indexterm" name="id3118449"></a><pre class="programlisting"><a href="bonobo-activation-Registration.html#Bonobo-RegistrationResult">Bonobo_RegistrationResult</a> bonobo_activation_register_active_server
 
259
                                                        (const char *iid,
 
260
                                                         CORBA_Object obj,
 
261
                                                         <a
262
262
href="../glib/glib-Singly-Linked-Lists.html#GSList"
263
263
>GSList</a> *reg_env);</pre>
264
264
<p>
283
283
<p>
284
284
</p>
285
285
<div class="informalexample"><pre class="programlisting">
286
 
  display_name = gdk_display_get_name (<a
287
 
href="../gdk/GdkDisplay.html#gdk-display-get-default"
288
 
><code class="function">gdk_display_get_default()</code></a>);
 
286
  display_name = gdk_display_get_name (gdk_display_get_default());
289
287
  reg_env = bonobo_activation_registration_env_set (
290
288
                             reg_env, "DISPLAY", display_name);
291
289
  bonobo_activation_register_active_server (iid, active_server, reg_env);
330
328
</div>
331
329
<hr>
332
330
<div class="refsect2" lang="en">
333
 
<a name="id2760263"></a><h3>
 
331
<a name="id3118673"></a><h3>
334
332
<a name="bonobo-activation-iid-get"></a>bonobo_activation_iid_get ()</h3>
335
 
<a class="indexterm" name="id2760276"></a><pre class="programlisting">const char* bonobo_activation_iid_get       (void);</pre>
 
333
<a class="indexterm" name="id3118687"></a><pre class="programlisting">const char*         bonobo_activation_iid_get           (void);</pre>
336
334
<p>
337
335
 
338
336
</p>
349
347
</div>
350
348
<hr>
351
349
<div class="refsect2" lang="en">
352
 
<a name="id2760313"></a><h3>
 
350
<a name="id3118724"></a><h3>
353
351
<a name="BonoboActivationPlugin"></a>BonoboActivationPlugin</h3>
354
 
<a class="indexterm" name="id2760326"></a><pre class="programlisting">typedef struct {
 
352
<a class="indexterm" name="id3118736"></a><pre class="programlisting">typedef struct {
355
353
        const BonoboActivationPluginObject *plugin_object_list;
356
354
        const char *description;
357
355
        gpointer dummy[8];
404
402
</div>
405
403
<hr>
406
404
<div class="refsect2" lang="en">
407
 
<a name="id2760370"></a><h3>
 
405
<a name="id3118780"></a><h3>
408
406
<a name="BonoboActivationPluginObject"></a>BonoboActivationPluginObject</h3>
409
 
<a class="indexterm" name="id2760383"></a><pre class="programlisting">typedef struct {
 
407
<a class="indexterm" name="id3118794"></a><pre class="programlisting">typedef struct {
410
408
        const char *iid;
411
409
 
412
410
        /* This routine should call bonobo_activation_plugin_use(servant, impl_ptr), 
432
430
</div>
433
431
<hr>
434
432
<div class="refsect2" lang="en">
435
 
<a name="id2760414"></a><h3>
 
433
<a name="id3118824"></a><h3>
436
434
<a name="bonobo-activation-plugin-use"></a>bonobo_activation_plugin_use ()</h3>
437
 
<a class="indexterm" name="id2760427"></a><pre class="programlisting">void        bonobo_activation_plugin_use    (PortableServer_Servant servant,
438
 
                                             <a
 
435
<a class="indexterm" name="id3118838"></a><pre class="programlisting">void                bonobo_activation_plugin_use        (PortableServer_Servant servant,
 
436
                                                         <a
439
437
href="../glib/glib-Basic-Types.html#gpointer"
440
438
>gpointer</a> impl_ptr);</pre>
441
439
<p>
463
461
</div>
464
462
<hr>
465
463
<div class="refsect2" lang="en">
466
 
<a name="id2760515"></a><h3>
 
464
<a name="id3118926"></a><h3>
467
465
<a name="bonobo-activation-plugin-unuse"></a>bonobo_activation_plugin_unuse ()</h3>
468
 
<a class="indexterm" name="id2760528"></a><pre class="programlisting">void        bonobo_activation_plugin_unuse  (<a
 
466
<a class="indexterm" name="id3118939"></a><pre class="programlisting">void                bonobo_activation_plugin_unuse      (<a
469
467
href="../glib/glib-Basic-Types.html#gpointer"
470
468
>gpointer</a> impl_ptr);</pre>
471
469
<p>