← Back to branch summary

~ubuntu-branches/ubuntu/utopic/lasso/utopic-proposed

« back to all changes in this revision

Viewing changes to docs/reference/lasso/html/lasso-Initialization-functions.html

  • Committer: Package Import Robot
  • Author(s): Frederic Peters
  • Date: 2014-01-07 13:22:21 UTC
  • mfrom: (1.1.11) (7.1.14 sid)
  • Revision ID: package-import@ubuntu.com-20140107132221-htp0go0s9z5lqvj8
Tags: 2.4.0-1
* New upstream version.
* debian/control, debian/rules: use autoreconf
* debian/source/version: switch to 3.0 (quilt)

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/lasso/html/lasso-Initialization-functions.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>Initialization functions</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
 
<link rel="home" href="index.html" title="Lasso Reference Manual">
8
 
<link rel="up" href="architecture.html" title="Lasso Architecture">
9
 
<link rel="prev" href="lasso-Error-Codes.html" title="Error Codes">
10
 
<link rel="next" href="lasso-node.html" title="LassoNode">
11
 
<meta name="generator" content="GTK-Doc V1.17 (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="lasso-Error-Codes.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
 
<td><a accesskey="u" href="architecture.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">Lasso Reference Manual</th>
21
 
<td><a accesskey="n" href="lasso-node.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="#lasso-Initialization-functions.synopsis" class="shortcut">Top</a>
25
 
                   | 
26
 
                  <a href="#lasso-Initialization-functions.description" class="shortcut">Description</a>
27
 
</td></tr>
28
 
</table>
29
 
<div class="refentry">
30
 
<a name="lasso-Initialization-functions"></a><div class="titlepage"></div>
31
 
<div class="refnamediv"><table width="100%"><tr>
32
 
<td valign="top">
33
 
<h2><span class="refentrytitle"><a name="lasso-Initialization-functions.top_of_page"></a>Initialization functions</span></h2>
34
 
<p>Initialization functions</p>
35
 
</td>
36
 
<td valign="top" align="right"></td>
37
 
</tr></table></div>
38
 
<div class="refsynopsisdiv">
39
 
<a name="lasso-Initialization-functions.synopsis"></a><h2>Synopsis</h2>
40
 
<pre class="synopsis">#define             <a class="link" href="lasso-Initialization-functions.html#LASSO-EXPORT:CAPS" title="LASSO_EXPORT">LASSO_EXPORT</a>
41
 
#define             <a class="link" href="lasso-Initialization-functions.html#LASSO-EXPORT-VAR:CAPS" title="LASSO_EXPORT_VAR">LASSO_EXPORT_VAR</a>
42
 
<span class="returnvalue">lasso_error_t</span>       <a class="link" href="lasso-Initialization-functions.html#lasso-init" title="lasso_init ()">lasso_init</a>                          (<em class="parameter"><code><span class="type">void</span></code></em>);
43
 
<span class="returnvalue">lasso_error_t</span>       <a class="link" href="lasso-Initialization-functions.html#lasso-shutdown" title="lasso_shutdown ()">lasso_shutdown</a>                      (<em class="parameter"><code><span class="type">void</span></code></em>);
44
 
enum                <a class="link" href="lasso-Initialization-functions.html#LassoCheckVersionMode" title="enum LassoCheckVersionMode">LassoCheckVersionMode</a>;
45
 
<span class="returnvalue">int</span>                 <a class="link" href="lasso-Initialization-functions.html#lasso-check-version" title="lasso_check_version ()">lasso_check_version</a>                 (<em class="parameter"><code><span class="type">int</span> major</code></em>,
46
 
                                                         <em class="parameter"><code><span class="type">int</span> minor</code></em>,
47
 
                                                         <em class="parameter"><code><span class="type">int</span> subminor</code></em>,
48
 
                                                         <em class="parameter"><code><a class="link" href="lasso-Initialization-functions.html#LassoCheckVersionMode" title="enum LassoCheckVersionMode"><span class="type">LassoCheckVersionMode</span></a> mode</code></em>);
49
 
<span class="returnvalue">void</span>                <a class="link" href="lasso-Initialization-functions.html#lasso-set-flag" title="lasso_set_flag ()">lasso_set_flag</a>                      (<em class="parameter"><code><span class="type">char</span> *flag</code></em>);
50
 
</pre>
51
 
</div>
52
 
<div class="refsect1">
53
 
<a name="lasso-Initialization-functions.description"></a><h2>Description</h2>
54
 
</div>
55
 
<div class="refsect1">
56
 
<a name="lasso-Initialization-functions.details"></a><h2>Details</h2>
57
 
<div class="refsect2">
58
 
<a name="LASSO-EXPORT:CAPS"></a><h3>LASSO_EXPORT</h3>
59
 
<pre class="programlisting">#        define LASSO_EXPORT __declspec(dllexport)
60
 
</pre>
61
 
</div>
62
 
<hr>
63
 
<div class="refsect2">
64
 
<a name="LASSO-EXPORT-VAR:CAPS"></a><h3>LASSO_EXPORT_VAR</h3>
65
 
<pre class="programlisting">#        define LASSO_EXPORT_VAR __declspec(dllexport) extern
66
 
</pre>
67
 
</div>
68
 
<hr>
69
 
<div class="refsect2">
70
 
<a name="lasso-init"></a><h3>lasso_init ()</h3>
71
 
<pre class="programlisting"><span class="returnvalue">lasso_error_t</span>       lasso_init                          (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
72
 
<p>
73
 
Initializes Lasso library.
74
 
</p>
75
 
<div class="variablelist"><table border="0">
76
 
<col align="left" valign="top">
77
 
<tbody><tr>
78
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
79
 
<td>0 on success; or a negative value otherwise.</td>
80
 
</tr></tbody>
81
 
</table></div>
82
 
</div>
83
 
<hr>
84
 
<div class="refsect2">
85
 
<a name="lasso-shutdown"></a><h3>lasso_shutdown ()</h3>
86
 
<pre class="programlisting"><span class="returnvalue">lasso_error_t</span>       lasso_shutdown                      (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
87
 
<p>
88
 
Clean ups Lasso library.
89
 
</p>
90
 
<div class="variablelist"><table border="0">
91
 
<col align="left" valign="top">
92
 
<tbody><tr>
93
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
94
 
<td>0 on success; or a negative value otherwise.</td>
95
 
</tr></tbody>
96
 
</table></div>
97
 
</div>
98
 
<hr>
99
 
<div class="refsect2">
100
 
<a name="LassoCheckVersionMode"></a><h3>enum LassoCheckVersionMode</h3>
101
 
<pre class="programlisting">typedef enum {
102
 
        LASSO_CHECK_VERSION_EXACT = 0,
103
 
        LASSO_CHECK_VERSIONABI_COMPATIBLE,
104
 
        LASSO_CHECK_VERSION_NUMERIC
105
 
} LassoCheckVersionMode;
106
 
</pre>
107
 
<p>
108
 
Lasso library version check mode.
109
 
</p>
110
 
<div class="variablelist"><table border="0">
111
 
<col align="left" valign="top">
112
 
<tbody>
113
 
<tr>
114
 
<td><p><a name="LASSO-CHECK-VERSION-EXACT:CAPS"></a><span class="term"><code class="literal">LASSO_CHECK_VERSION_EXACT</code></span></p></td>
115
 
<td>version should match exactly
116
 
</td>
117
 
</tr>
118
 
<tr>
119
 
<td><p><a name="LASSO-CHECK-VERSIONABI-COMPATIBLE:CAPS"></a><span class="term"><code class="literal">LASSO_CHECK_VERSIONABI_COMPATIBLE</code></span></p></td>
120
 
<td>version should be ABI compatible
121
 
</td>
122
 
</tr>
123
 
<tr>
124
 
<td><p><a name="LASSO-CHECK-VERSION-NUMERIC:CAPS"></a><span class="term"><code class="literal">LASSO_CHECK_VERSION_NUMERIC</code></span></p></td>
125
 
<td>version should be at least that number
126
 
</td>
127
 
</tr>
128
 
</tbody>
129
 
</table></div>
130
 
</div>
131
 
<hr>
132
 
<div class="refsect2">
133
 
<a name="lasso-check-version"></a><h3>lasso_check_version ()</h3>
134
 
<pre class="programlisting"><span class="returnvalue">int</span>                 lasso_check_version                 (<em class="parameter"><code><span class="type">int</span> major</code></em>,
135
 
                                                         <em class="parameter"><code><span class="type">int</span> minor</code></em>,
136
 
                                                         <em class="parameter"><code><span class="type">int</span> subminor</code></em>,
137
 
                                                         <em class="parameter"><code><a class="link" href="lasso-Initialization-functions.html#LassoCheckVersionMode" title="enum LassoCheckVersionMode"><span class="type">LassoCheckVersionMode</span></a> mode</code></em>);</pre>
138
 
<p>
139
 
Checks if the loaded version of Lasso library could be used.
140
 
</p>
141
 
<div class="variablelist"><table border="0">
142
 
<col align="left" valign="top">
143
 
<tbody>
144
 
<tr>
145
 
<td><p><span class="term"><em class="parameter"><code>major</code></em> :</span></p></td>
146
 
<td>major version numbe</td>
147
 
</tr>
148
 
<tr>
149
 
<td><p><span class="term"><em class="parameter"><code>minor</code></em> :</span></p></td>
150
 
<td>minor version number</td>
151
 
</tr>
152
 
<tr>
153
 
<td><p><span class="term"><em class="parameter"><code>subminor</code></em> :</span></p></td>
154
 
<td>subminor version number</td>
155
 
</tr>
156
 
<tr>
157
 
<td><p><span class="term"><em class="parameter"><code>mode</code></em> :</span></p></td>
158
 
<td>version check mode</td>
159
 
</tr>
160
 
<tr>
161
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
162
 
<td>1 if the loaded lasso library version is OK to use
163
 
0 if it is not; or a negative value if an error occurs.</td>
164
 
</tr>
165
 
</tbody>
166
 
</table></div>
167
 
</div>
168
 
<hr>
169
 
<div class="refsect2">
170
 
<a name="lasso-set-flag"></a><h3>lasso_set_flag ()</h3>
171
 
<pre class="programlisting"><span class="returnvalue">void</span>                lasso_set_flag                      (<em class="parameter"><code><span class="type">char</span> *flag</code></em>);</pre>
172
 
<p>
173
 
Set a debugging flag. You can also use the environment variable LASSO_FLAG
174
 
to get the same effect. LASSO_FLAG must contain flag name separated by spaces, commas,
175
 
tabulations or colons.
176
 
</p>
177
 
<div class="variablelist"><table border="0">
178
 
<col align="left" valign="top">
179
 
<tbody><tr>
180
 
<td><p><span class="term"><em class="parameter"><code>flag</code></em> :</span></p></td>
181
 
<td>a string representing a flag name, prefix with 'no-' to disable it.</td>
182
 
</tr></tbody>
183
 
</table></div>
184
 
</div>
185
 
</div>
186
 
</div>
187
 
<div class="footer">
188
 
<hr>
189
 
          Generated by GTK-Doc V1.17</div>
190
 
</body>
191
 
</html>
 
 
b'\\ No newline at end of file'