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