Imported Upstream version 2.3.1
[platform/upstream/harfbuzz.git] / docs / html / harfbuzz-hb-map.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>hb-map: HarfBuzz Manual</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
7 <link rel="home" href="index.html" title="HarfBuzz Manual">
8 <link rel="up" href="ch09.html" title="Core API">
9 <link rel="prev" href="harfbuzz-hb-font.html" title="hb-font">
10 <link rel="next" href="harfbuzz-hb-set.html" title="hb-set">
11 <meta name="generator" content="GTK-Doc V1.25 (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="5"><tr valign="middle">
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="#harfbuzz-hb-map.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
19                   <a href="#harfbuzz-hb-map.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
20 </td>
21 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
22 <td><a accesskey="u" href="ch09.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
23 <td><a accesskey="p" href="harfbuzz-hb-font.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
24 <td><a accesskey="n" href="harfbuzz-hb-set.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
25 </tr></table>
26 <div class="refentry">
27 <a name="harfbuzz-hb-map"></a><div class="titlepage"></div>
28 <div class="refnamediv"><table width="100%"><tr>
29 <td valign="top">
30 <h2><span class="refentrytitle"><a name="harfbuzz-hb-map.top_of_page"></a>hb-map</span></h2>
31 <p>hb-map — Object representing integer to integer mapping</p>
32 </td>
33 <td class="gallery_image" valign="top" align="right"></td>
34 </tr></table></div>
35 <div class="refsect1">
36 <a name="harfbuzz-hb-map.functions"></a><h2>Functions</h2>
37 <div class="informaltable"><table class="informaltable" width="100%" border="0">
38 <colgroup>
39 <col width="150px" class="functions_return">
40 <col class="functions_name">
41 </colgroup>
42 <tbody>
43 <tr>
44 <td class="function_type">
45 <a class="link" href="harfbuzz-hb-common.html#hb-bool-t" title="hb_bool_t"><span class="returnvalue">hb_bool_t</span></a>
46 </td>
47 <td class="function_name">
48 <a class="link" href="harfbuzz-hb-map.html#hb-map-allocation-successful" title="hb_map_allocation_successful ()">hb_map_allocation_successful</a> <span class="c_punctuation">()</span>
49 </td>
50 </tr>
51 <tr>
52 <td class="function_type">
53 <span class="returnvalue">void</span>
54 </td>
55 <td class="function_name">
56 <a class="link" href="harfbuzz-hb-map.html#hb-map-clear" title="hb_map_clear ()">hb_map_clear</a> <span class="c_punctuation">()</span>
57 </td>
58 </tr>
59 <tr>
60 <td class="function_type">
61 <a class="link" href="harfbuzz-hb-map.html#hb-map-t"><span class="returnvalue">hb_map_t</span></a> *
62 </td>
63 <td class="function_name">
64 <a class="link" href="harfbuzz-hb-map.html#hb-map-create" title="hb_map_create ()">hb_map_create</a> <span class="c_punctuation">()</span>
65 </td>
66 </tr>
67 <tr>
68 <td class="function_type">
69 <span class="returnvalue">void</span>
70 </td>
71 <td class="function_name">
72 <a class="link" href="harfbuzz-hb-map.html#hb-map-del" title="hb_map_del ()">hb_map_del</a> <span class="c_punctuation">()</span>
73 </td>
74 </tr>
75 <tr>
76 <td class="function_type">
77 <span class="returnvalue">void</span>
78 </td>
79 <td class="function_name">
80 <a class="link" href="harfbuzz-hb-map.html#hb-map-destroy" title="hb_map_destroy ()">hb_map_destroy</a> <span class="c_punctuation">()</span>
81 </td>
82 </tr>
83 <tr>
84 <td class="function_type">
85 <a class="link" href="harfbuzz-hb-common.html#hb-codepoint-t" title="hb_codepoint_t"><span class="returnvalue">hb_codepoint_t</span></a>
86 </td>
87 <td class="function_name">
88 <a class="link" href="harfbuzz-hb-map.html#hb-map-get" title="hb_map_get ()">hb_map_get</a> <span class="c_punctuation">()</span>
89 </td>
90 </tr>
91 <tr>
92 <td class="function_type">
93 <a class="link" href="harfbuzz-hb-map.html#hb-map-t"><span class="returnvalue">hb_map_t</span></a> *
94 </td>
95 <td class="function_name">
96 <a class="link" href="harfbuzz-hb-map.html#hb-map-get-empty" title="hb_map_get_empty ()">hb_map_get_empty</a> <span class="c_punctuation">()</span>
97 </td>
98 </tr>
99 <tr>
100 <td class="function_type">unsigned <span class="returnvalue">int</span>
101 </td>
102 <td class="function_name">
103 <a class="link" href="harfbuzz-hb-map.html#hb-map-get-population" title="hb_map_get_population ()">hb_map_get_population</a> <span class="c_punctuation">()</span>
104 </td>
105 </tr>
106 <tr>
107 <td class="function_type">
108 <span class="returnvalue">void</span> *
109 </td>
110 <td class="function_name">
111 <a class="link" href="harfbuzz-hb-map.html#hb-map-get-user-data" title="hb_map_get_user_data ()">hb_map_get_user_data</a> <span class="c_punctuation">()</span>
112 </td>
113 </tr>
114 <tr>
115 <td class="function_type">
116 <a class="link" href="harfbuzz-hb-common.html#hb-bool-t" title="hb_bool_t"><span class="returnvalue">hb_bool_t</span></a>
117 </td>
118 <td class="function_name">
119 <a class="link" href="harfbuzz-hb-map.html#hb-map-has" title="hb_map_has ()">hb_map_has</a> <span class="c_punctuation">()</span>
120 </td>
121 </tr>
122 <tr>
123 <td class="function_type">
124 <a class="link" href="harfbuzz-hb-common.html#hb-bool-t" title="hb_bool_t"><span class="returnvalue">hb_bool_t</span></a>
125 </td>
126 <td class="function_name">
127 <a class="link" href="harfbuzz-hb-map.html#hb-map-is-empty" title="hb_map_is_empty ()">hb_map_is_empty</a> <span class="c_punctuation">()</span>
128 </td>
129 </tr>
130 <tr>
131 <td class="function_type">
132 <a class="link" href="harfbuzz-hb-map.html#hb-map-t"><span class="returnvalue">hb_map_t</span></a> *
133 </td>
134 <td class="function_name">
135 <a class="link" href="harfbuzz-hb-map.html#hb-map-reference" title="hb_map_reference ()">hb_map_reference</a> <span class="c_punctuation">()</span>
136 </td>
137 </tr>
138 <tr>
139 <td class="function_type">
140 <span class="returnvalue">void</span>
141 </td>
142 <td class="function_name">
143 <a class="link" href="harfbuzz-hb-map.html#hb-map-set" title="hb_map_set ()">hb_map_set</a> <span class="c_punctuation">()</span>
144 </td>
145 </tr>
146 <tr>
147 <td class="function_type">
148 <a class="link" href="harfbuzz-hb-common.html#hb-bool-t" title="hb_bool_t"><span class="returnvalue">hb_bool_t</span></a>
149 </td>
150 <td class="function_name">
151 <a class="link" href="harfbuzz-hb-map.html#hb-map-set-user-data" title="hb_map_set_user_data ()">hb_map_set_user_data</a> <span class="c_punctuation">()</span>
152 </td>
153 </tr>
154 </tbody>
155 </table></div>
156 </div>
157 <a name="hb-map-t"></a><div class="refsect1">
158 <a name="harfbuzz-hb-map.other"></a><h2>Types and Values</h2>
159 <div class="informaltable"><table class="informaltable" width="100%" border="0">
160 <colgroup>
161 <col width="150px" class="name">
162 <col class="description">
163 </colgroup>
164 <tbody>
165 <tr>
166 <td class="define_keyword">#define</td>
167 <td class="function_name"><a class="link" href="harfbuzz-hb-map.html#HB-MAP-VALUE-INVALID:CAPS" title="HB_MAP_VALUE_INVALID">HB_MAP_VALUE_INVALID</a></td>
168 </tr>
169 <tr>
170 <td class="typedef_keyword">typedef</td>
171 <td class="function_name"><a class="link" href="harfbuzz-hb-map.html#hb-map-t">hb_map_t</a></td>
172 </tr>
173 </tbody>
174 </table></div>
175 </div>
176 <div class="refsect1">
177 <a name="harfbuzz-hb-map.object-hierarchy"></a><h2>Object Hierarchy</h2>
178 <pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-Boxed-Types.html">GBoxed</a>
179     <span class="lineart">╰──</span> hb_map_t
180 </pre>
181 </div>
182 <div class="refsect1">
183 <a name="harfbuzz-hb-map.includes"></a><h2>Includes</h2>
184 <pre class="synopsis">#include &lt;hb.h&gt;
185 </pre>
186 </div>
187 <div class="refsect1">
188 <a name="harfbuzz-hb-map.description"></a><h2>Description</h2>
189 <p>Map objects are integer-to-integer hash-maps.  Currently they are
190 not used in the HarfBuzz public API, but are provided for client's
191 use if desired.</p>
192 </div>
193 <div class="refsect1">
194 <a name="harfbuzz-hb-map.functions_details"></a><h2>Functions</h2>
195 <div class="refsect2">
196 <a name="hb-map-allocation-successful"></a><h3>hb_map_allocation_successful ()</h3>
197 <pre class="programlisting"><a class="link" href="harfbuzz-hb-common.html#hb-bool-t" title="hb_bool_t"><span class="returnvalue">hb_bool_t</span></a>
198 hb_map_allocation_successful (<em class="parameter"><code>const <a class="link" href="harfbuzz-hb-map.html#hb-map-t"><span class="type">hb_map_t</span></a> *map</code></em>);</pre>
199 <div class="refsect3">
200 <a name="hb-map-allocation-successful.parameters"></a><h4>Parameters</h4>
201 <div class="informaltable"><table class="informaltable" width="100%" border="0">
202 <colgroup>
203 <col width="150px" class="parameters_name">
204 <col class="parameters_description">
205 <col width="200px" class="parameters_annotations">
206 </colgroup>
207 <tbody><tr>
208 <td class="parameter_name"><p>map</p></td>
209 <td class="parameter_description"><p>a map.</p></td>
210 <td class="parameter_annotations"> </td>
211 </tr></tbody>
212 </table></div>
213 </div>
214 <p class="since">Since: <a class="link" href="api-index-1-7-7.html#api-index-1.7.7">1.7.7</a></p>
215 </div>
216 <hr>
217 <div class="refsect2">
218 <a name="hb-map-clear"></a><h3>hb_map_clear ()</h3>
219 <pre class="programlisting"><span class="returnvalue">void</span>
220 hb_map_clear (<em class="parameter"><code><a class="link" href="harfbuzz-hb-map.html#hb-map-t"><span class="type">hb_map_t</span></a> *map</code></em>);</pre>
221 <div class="refsect3">
222 <a name="hb-map-clear.parameters"></a><h4>Parameters</h4>
223 <div class="informaltable"><table class="informaltable" width="100%" border="0">
224 <colgroup>
225 <col width="150px" class="parameters_name">
226 <col class="parameters_description">
227 <col width="200px" class="parameters_annotations">
228 </colgroup>
229 <tbody><tr>
230 <td class="parameter_name"><p>map</p></td>
231 <td class="parameter_description"><p>a map.</p></td>
232 <td class="parameter_annotations"> </td>
233 </tr></tbody>
234 </table></div>
235 </div>
236 <p class="since">Since: <a class="link" href="api-index-1-7-7.html#api-index-1.7.7">1.7.7</a></p>
237 </div>
238 <hr>
239 <div class="refsect2">
240 <a name="hb-map-create"></a><h3>hb_map_create ()</h3>
241 <pre class="programlisting"><a class="link" href="harfbuzz-hb-map.html#hb-map-t"><span class="returnvalue">hb_map_t</span></a> *
242 hb_map_create (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
243 <p><span class="annotation">[Xconstructor]</span></p>
244 <div class="refsect3">
245 <a name="hb-map-create.returns"></a><h4>Returns</h4>
246 <p>. </p>
247 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
248 </div>
249 <p class="since">Since: <a class="link" href="api-index-1-7-7.html#api-index-1.7.7">1.7.7</a></p>
250 </div>
251 <hr>
252 <div class="refsect2">
253 <a name="hb-map-del"></a><h3>hb_map_del ()</h3>
254 <pre class="programlisting"><span class="returnvalue">void</span>
255 hb_map_del (<em class="parameter"><code><a class="link" href="harfbuzz-hb-map.html#hb-map-t"><span class="type">hb_map_t</span></a> *map</code></em>,
256             <em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-codepoint-t" title="hb_codepoint_t"><span class="type">hb_codepoint_t</span></a> key</code></em>);</pre>
257 <div class="refsect3">
258 <a name="hb-map-del.parameters"></a><h4>Parameters</h4>
259 <div class="informaltable"><table class="informaltable" width="100%" border="0">
260 <colgroup>
261 <col width="150px" class="parameters_name">
262 <col class="parameters_description">
263 <col width="200px" class="parameters_annotations">
264 </colgroup>
265 <tbody><tr>
266 <td class="parameter_name"><p>map</p></td>
267 <td class="parameter_description"><p>a map.</p></td>
268 <td class="parameter_annotations"> </td>
269 </tr></tbody>
270 </table></div>
271 </div>
272 <p class="since">Since: <a class="link" href="api-index-1-7-7.html#api-index-1.7.7">1.7.7</a></p>
273 </div>
274 <hr>
275 <div class="refsect2">
276 <a name="hb-map-destroy"></a><h3>hb_map_destroy ()</h3>
277 <pre class="programlisting"><span class="returnvalue">void</span>
278 hb_map_destroy (<em class="parameter"><code><a class="link" href="harfbuzz-hb-map.html#hb-map-t"><span class="type">hb_map_t</span></a> *map</code></em>);</pre>
279 <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
280 <div class="refsect3">
281 <a name="hb-map-destroy.parameters"></a><h4>Parameters</h4>
282 <div class="informaltable"><table class="informaltable" width="100%" border="0">
283 <colgroup>
284 <col width="150px" class="parameters_name">
285 <col class="parameters_description">
286 <col width="200px" class="parameters_annotations">
287 </colgroup>
288 <tbody><tr>
289 <td class="parameter_name"><p>map</p></td>
290 <td class="parameter_description"><p>a map.</p></td>
291 <td class="parameter_annotations"> </td>
292 </tr></tbody>
293 </table></div>
294 </div>
295 <p class="since">Since: <a class="link" href="api-index-1-7-7.html#api-index-1.7.7">1.7.7</a></p>
296 </div>
297 <hr>
298 <div class="refsect2">
299 <a name="hb-map-get"></a><h3>hb_map_get ()</h3>
300 <pre class="programlisting"><a class="link" href="harfbuzz-hb-common.html#hb-codepoint-t" title="hb_codepoint_t"><span class="returnvalue">hb_codepoint_t</span></a>
301 hb_map_get (<em class="parameter"><code>const <a class="link" href="harfbuzz-hb-map.html#hb-map-t"><span class="type">hb_map_t</span></a> *map</code></em>,
302             <em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-codepoint-t" title="hb_codepoint_t"><span class="type">hb_codepoint_t</span></a> key</code></em>);</pre>
303 <div class="refsect3">
304 <a name="hb-map-get.parameters"></a><h4>Parameters</h4>
305 <div class="informaltable"><table class="informaltable" width="100%" border="0">
306 <colgroup>
307 <col width="150px" class="parameters_name">
308 <col class="parameters_description">
309 <col width="200px" class="parameters_annotations">
310 </colgroup>
311 <tbody><tr>
312 <td class="parameter_name"><p>map</p></td>
313 <td class="parameter_description"><p>a map.</p></td>
314 <td class="parameter_annotations"> </td>
315 </tr></tbody>
316 </table></div>
317 </div>
318 <p class="since">Since: <a class="link" href="api-index-1-7-7.html#api-index-1.7.7">1.7.7</a></p>
319 </div>
320 <hr>
321 <div class="refsect2">
322 <a name="hb-map-get-empty"></a><h3>hb_map_get_empty ()</h3>
323 <pre class="programlisting"><a class="link" href="harfbuzz-hb-map.html#hb-map-t"><span class="returnvalue">hb_map_t</span></a> *
324 hb_map_get_empty (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
325 <div class="refsect3">
326 <a name="hb-map-get-empty.returns"></a><h4>Returns</h4>
327 <p>. </p>
328 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
329 </div>
330 <p class="since">Since: <a class="link" href="api-index-1-7-7.html#api-index-1.7.7">1.7.7</a></p>
331 </div>
332 <hr>
333 <div class="refsect2">
334 <a name="hb-map-get-population"></a><h3>hb_map_get_population ()</h3>
335 <pre class="programlisting">unsigned <span class="returnvalue">int</span>
336 hb_map_get_population (<em class="parameter"><code>const <a class="link" href="harfbuzz-hb-map.html#hb-map-t"><span class="type">hb_map_t</span></a> *map</code></em>);</pre>
337 <div class="refsect3">
338 <a name="hb-map-get-population.parameters"></a><h4>Parameters</h4>
339 <div class="informaltable"><table class="informaltable" width="100%" border="0">
340 <colgroup>
341 <col width="150px" class="parameters_name">
342 <col class="parameters_description">
343 <col width="200px" class="parameters_annotations">
344 </colgroup>
345 <tbody><tr>
346 <td class="parameter_name"><p>map</p></td>
347 <td class="parameter_description"><p>a map.</p></td>
348 <td class="parameter_annotations"> </td>
349 </tr></tbody>
350 </table></div>
351 </div>
352 <p class="since">Since: <a class="link" href="api-index-1-7-7.html#api-index-1.7.7">1.7.7</a></p>
353 </div>
354 <hr>
355 <div class="refsect2">
356 <a name="hb-map-get-user-data"></a><h3>hb_map_get_user_data ()</h3>
357 <pre class="programlisting"><span class="returnvalue">void</span> *
358 hb_map_get_user_data (<em class="parameter"><code><a class="link" href="harfbuzz-hb-map.html#hb-map-t"><span class="type">hb_map_t</span></a> *map</code></em>,
359                       <em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-user-data-key-t"><span class="type">hb_user_data_key_t</span></a> *key</code></em>);</pre>
360 <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
361 <div class="refsect3">
362 <a name="hb-map-get-user-data.parameters"></a><h4>Parameters</h4>
363 <div class="informaltable"><table class="informaltable" width="100%" border="0">
364 <colgroup>
365 <col width="150px" class="parameters_name">
366 <col class="parameters_description">
367 <col width="200px" class="parameters_annotations">
368 </colgroup>
369 <tbody><tr>
370 <td class="parameter_name"><p>map</p></td>
371 <td class="parameter_description"><p>a map.</p></td>
372 <td class="parameter_annotations"> </td>
373 </tr></tbody>
374 </table></div>
375 </div>
376 <div class="refsect3">
377 <a name="hb-map-get-user-data.returns"></a><h4>Returns</h4>
378 <p>. </p>
379 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
380 </div>
381 <p class="since">Since: <a class="link" href="api-index-1-7-7.html#api-index-1.7.7">1.7.7</a></p>
382 </div>
383 <hr>
384 <div class="refsect2">
385 <a name="hb-map-has"></a><h3>hb_map_has ()</h3>
386 <pre class="programlisting"><a class="link" href="harfbuzz-hb-common.html#hb-bool-t" title="hb_bool_t"><span class="returnvalue">hb_bool_t</span></a>
387 hb_map_has (<em class="parameter"><code>const <a class="link" href="harfbuzz-hb-map.html#hb-map-t"><span class="type">hb_map_t</span></a> *map</code></em>,
388             <em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-codepoint-t" title="hb_codepoint_t"><span class="type">hb_codepoint_t</span></a> key</code></em>);</pre>
389 <div class="refsect3">
390 <a name="hb-map-has.parameters"></a><h4>Parameters</h4>
391 <div class="informaltable"><table class="informaltable" width="100%" border="0">
392 <colgroup>
393 <col width="150px" class="parameters_name">
394 <col class="parameters_description">
395 <col width="200px" class="parameters_annotations">
396 </colgroup>
397 <tbody><tr>
398 <td class="parameter_name"><p>map</p></td>
399 <td class="parameter_description"><p>a map.</p></td>
400 <td class="parameter_annotations"> </td>
401 </tr></tbody>
402 </table></div>
403 </div>
404 <p class="since">Since: <a class="link" href="api-index-1-7-7.html#api-index-1.7.7">1.7.7</a></p>
405 </div>
406 <hr>
407 <div class="refsect2">
408 <a name="hb-map-is-empty"></a><h3>hb_map_is_empty ()</h3>
409 <pre class="programlisting"><a class="link" href="harfbuzz-hb-common.html#hb-bool-t" title="hb_bool_t"><span class="returnvalue">hb_bool_t</span></a>
410 hb_map_is_empty (<em class="parameter"><code>const <a class="link" href="harfbuzz-hb-map.html#hb-map-t"><span class="type">hb_map_t</span></a> *map</code></em>);</pre>
411 <div class="refsect3">
412 <a name="hb-map-is-empty.parameters"></a><h4>Parameters</h4>
413 <div class="informaltable"><table class="informaltable" width="100%" border="0">
414 <colgroup>
415 <col width="150px" class="parameters_name">
416 <col class="parameters_description">
417 <col width="200px" class="parameters_annotations">
418 </colgroup>
419 <tbody><tr>
420 <td class="parameter_name"><p>map</p></td>
421 <td class="parameter_description"><p>a map.</p></td>
422 <td class="parameter_annotations"> </td>
423 </tr></tbody>
424 </table></div>
425 </div>
426 <p class="since">Since: <a class="link" href="api-index-1-7-7.html#api-index-1.7.7">1.7.7</a></p>
427 </div>
428 <hr>
429 <div class="refsect2">
430 <a name="hb-map-reference"></a><h3>hb_map_reference ()</h3>
431 <pre class="programlisting"><a class="link" href="harfbuzz-hb-map.html#hb-map-t"><span class="returnvalue">hb_map_t</span></a> *
432 hb_map_reference (<em class="parameter"><code><a class="link" href="harfbuzz-hb-map.html#hb-map-t"><span class="type">hb_map_t</span></a> *map</code></em>);</pre>
433 <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
434 <div class="refsect3">
435 <a name="hb-map-reference.parameters"></a><h4>Parameters</h4>
436 <div class="informaltable"><table class="informaltable" width="100%" border="0">
437 <colgroup>
438 <col width="150px" class="parameters_name">
439 <col class="parameters_description">
440 <col width="200px" class="parameters_annotations">
441 </colgroup>
442 <tbody><tr>
443 <td class="parameter_name"><p>map</p></td>
444 <td class="parameter_description"><p>a map.</p></td>
445 <td class="parameter_annotations"> </td>
446 </tr></tbody>
447 </table></div>
448 </div>
449 <div class="refsect3">
450 <a name="hb-map-reference.returns"></a><h4>Returns</h4>
451 <p>. </p>
452 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
453 </div>
454 <p class="since">Since: <a class="link" href="api-index-1-7-7.html#api-index-1.7.7">1.7.7</a></p>
455 </div>
456 <hr>
457 <div class="refsect2">
458 <a name="hb-map-set"></a><h3>hb_map_set ()</h3>
459 <pre class="programlisting"><span class="returnvalue">void</span>
460 hb_map_set (<em class="parameter"><code><a class="link" href="harfbuzz-hb-map.html#hb-map-t"><span class="type">hb_map_t</span></a> *map</code></em>,
461             <em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-codepoint-t" title="hb_codepoint_t"><span class="type">hb_codepoint_t</span></a> key</code></em>,
462             <em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-codepoint-t" title="hb_codepoint_t"><span class="type">hb_codepoint_t</span></a> value</code></em>);</pre>
463 <div class="refsect3">
464 <a name="hb-map-set.parameters"></a><h4>Parameters</h4>
465 <div class="informaltable"><table class="informaltable" width="100%" border="0">
466 <colgroup>
467 <col width="150px" class="parameters_name">
468 <col class="parameters_description">
469 <col width="200px" class="parameters_annotations">
470 </colgroup>
471 <tbody><tr>
472 <td class="parameter_name"><p>map</p></td>
473 <td class="parameter_description"><p>a map.</p></td>
474 <td class="parameter_annotations"> </td>
475 </tr></tbody>
476 </table></div>
477 </div>
478 <p class="since">Since: <a class="link" href="api-index-1-7-7.html#api-index-1.7.7">1.7.7</a></p>
479 </div>
480 <hr>
481 <div class="refsect2">
482 <a name="hb-map-set-user-data"></a><h3>hb_map_set_user_data ()</h3>
483 <pre class="programlisting"><a class="link" href="harfbuzz-hb-common.html#hb-bool-t" title="hb_bool_t"><span class="returnvalue">hb_bool_t</span></a>
484 hb_map_set_user_data (<em class="parameter"><code><a class="link" href="harfbuzz-hb-map.html#hb-map-t"><span class="type">hb_map_t</span></a> *map</code></em>,
485                       <em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-user-data-key-t"><span class="type">hb_user_data_key_t</span></a> *key</code></em>,
486                       <em class="parameter"><code><span class="type">void</span> *data</code></em>,
487                       <em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-destroy-func-t" title="hb_destroy_func_t ()"><span class="type">hb_destroy_func_t</span></a> destroy</code></em>,
488                       <em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-bool-t" title="hb_bool_t"><span class="type">hb_bool_t</span></a> replace</code></em>);</pre>
489 <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
490 <div class="refsect3">
491 <a name="hb-map-set-user-data.parameters"></a><h4>Parameters</h4>
492 <div class="informaltable"><table class="informaltable" width="100%" border="0">
493 <colgroup>
494 <col width="150px" class="parameters_name">
495 <col class="parameters_description">
496 <col width="200px" class="parameters_annotations">
497 </colgroup>
498 <tbody><tr>
499 <td class="parameter_name"><p>map</p></td>
500 <td class="parameter_description"><p>a map.</p></td>
501 <td class="parameter_annotations"> </td>
502 </tr></tbody>
503 </table></div>
504 </div>
505 <p class="since">Since: <a class="link" href="api-index-1-7-7.html#api-index-1.7.7">1.7.7</a></p>
506 </div>
507 </div>
508 <div class="refsect1">
509 <a name="harfbuzz-hb-map.other_details"></a><h2>Types and Values</h2>
510 <div class="refsect2">
511 <a name="HB-MAP-VALUE-INVALID:CAPS"></a><h3>HB_MAP_VALUE_INVALID</h3>
512 <pre class="programlisting">#define HB_MAP_VALUE_INVALID ((hb_codepoint_t) -1)
513 </pre>
514 </div>
515 <hr>
516 <div class="refsect2">
517 <a name="hb-map-t"></a><h3>hb_map_t</h3>
518 <pre class="programlisting">typedef struct hb_map_t hb_map_t;
519 </pre>
520 </div>
521 </div>
522 </div>
523 <div class="footer">
524 <hr>Generated by GTK-Doc V1.25</div>
525 </body>
526 </html>