17:39
[skypekit:skypekit.git] / skypekit_2.0.0.190_29281_CB30 / interfaces / skype / cpp_embedded / documentation / html / class_s_e_ptr_int_dict.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <title>SkypeKit C++ Wrapper: Main Page</title>
6 <link href="tabs.css" rel="stylesheet" type="text/css"/>
7 <link href="islander.css" rel="stylesheet" type="text/css"/>
8 </head>
9 <body>
10 <img src="..\skypekit.png" align="right">
11 <!-- Generated by Doxygen 1.6.2 -->
12 <script type="text/javascript">
13 <!--
14 function changeDisplayState (e){
15   var num=this.id.replace(/[^[0-9]/g,'');
16   var button=this.firstChild;
17   var sectionDiv=document.getElementById('dynsection'+num);
18   if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
19     sectionDiv.style.display='block';
20     button.src='open.gif';
21   }else{
22     sectionDiv.style.display='none';
23     button.src='closed.gif';
24   }
25 }
26 function initDynSections(){
27   var divs=document.getElementsByTagName('div');
28   var sectionCounter=1;
29   for(var i=0;i<divs.length-1;i++){
30     if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
31       var header=divs[i];
32       var section=divs[i+1];
33       var button=header.firstChild;
34       if (button!='IMG'){
35         divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
36         button=document.createElement('img');
37         divs[i].insertBefore(button,divs[i].firstChild);
38       }
39       header.style.cursor='pointer';
40       header.onclick=changeDisplayState;
41       header.id='dynheader'+sectionCounter;
42       button.src='closed.gif';
43       section.id='dynsection'+sectionCounter;
44       section.style.display='none';
45       section.style.marginLeft='14px';
46       sectionCounter++;
47     }
48   }
49 }
50 window.onload = initDynSections;
51 -->
52 </script>
53 <div class="navigation" id="top">
54   <div class="tabs">
55     <ul>
56       <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
57       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
58       <li><a href="files.html"><span>Files</span></a></li>
59       <li><a href="examples.html"><span>Examples</span></a></li>
60     </ul>
61   </div>
62   <div class="tabs">
63     <ul>
64       <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
65       <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
66       <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
67     </ul>
68   </div>
69 </div>
70 <div class="contents">
71 <h1>SEPtrIntDict Class Reference</h1><!-- doxytag: class="SEPtrIntDict" -->
72 <p><a class="el" href="class_s_e_ptr_int_dict.html" title="SEPtrIntDict is a dictionary class of pointers associated to integers.">SEPtrIntDict</a> is a dictionary class of pointers associated to integers.  
73 <a href="#_details">More...</a></p>
74
75 <p><code>#include &lt;<a class="el" href="skype-ptrint-dict_8h_source.html">skype-ptrint-dict.h</a>&gt;</code></p>
76
77 <p><a href="class_s_e_ptr_int_dict-members.html">List of all members.</a></p>
78 <table border="0" cellpadding="0" cellspacing="0">
79 <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
80 <tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_e_ptr_int_dict.html#a59f9a2e54002c0f624a435da6c0ff10a">SEPtrIntDict</a> ()</td></tr>
81 <tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_e_ptr_int_dict.html#a05e854a333976e9071261af0a2b7958c">SEPtrIntDict</a> (const <a class="el" href="class_s_e_ptr_int_dict.html">SEPtrIntDict</a> &amp;dict)</td></tr>
82 <tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_e_ptr_int_dict.html#a3d261b4d5412bc08d85713776a91eb0b">~SEPtrIntDict</a> ()</td></tr>
83 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_e_ptr_int_dict.html#a7e2487a31f556fddb716b2cea60596b0">insert</a> (const int key, const void *value)</td></tr>
84 <tr><td class="memItemLeft" align="right" valign="top">const void *&amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_e_ptr_int_dict.html#a0bb35ddff347d074e42289a5858984d3">find</a> (const int key, unsigned int offset=0) const </td></tr>
85 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_s_e_ptr_int_dict.html">SEPtrIntDict</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_e_ptr_int_dict.html#ace988b3ab4d231add33660dd3814074b">operator=</a> (const <a class="el" href="class_s_e_ptr_int_dict.html">SEPtrIntDict</a> &amp;dict)</td></tr>
86 <tr><td class="memItemLeft" align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_e_ptr_int_dict.html#aa83bcafb3bbaaf1d1ee225a1800e6ce8">size</a> () const </td></tr>
87 <tr><td class="memItemLeft" align="right" valign="top">const void *&amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_e_ptr_int_dict.html#a405841d4e879e08d685c0724eb2a4546">operator[]</a> (size_t i) const </td></tr>
88 <tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_e_ptr_int_dict.html#a41ed584be1e678d5aa4cc1a9e721e8a3">keyAt</a> (size_t i) const </td></tr>
89 <tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_e_ptr_int_dict.html#a0223d03d10cb98e07f39c952035bf188">remove</a> (const int key)</td></tr>
90 </table>
91 <hr/><a name="_details"></a><h2>Detailed Description</h2>
92 <p><a class="el" href="class_s_e_ptr_int_dict.html" title="SEPtrIntDict is a dictionary class of pointers associated to integers.">SEPtrIntDict</a> is a dictionary class of pointers associated to integers. </p>
93
94 <p>Definition at line <a class="el" href="skype-ptrint-dict_8h_source.html#l00012">12</a> of file <a class="el" href="skype-ptrint-dict_8h_source.html">skype-ptrint-dict.h</a>.</p>
95 <hr/><h2>Constructor &amp; Destructor Documentation</h2>
96 <a class="anchor" id="a59f9a2e54002c0f624a435da6c0ff10a"></a><!-- doxytag: member="SEPtrIntDict::SEPtrIntDict" ref="a59f9a2e54002c0f624a435da6c0ff10a" args="()" -->
97 <div class="memitem">
98 <div class="memproto">
99       <table class="memname">
100         <tr>
101           <td class="memname">SEPtrIntDict::SEPtrIntDict </td>
102           <td>(</td>
103           <td class="paramname"></td>
104           <td>&nbsp;)&nbsp;</td>
105           <td></td>
106         </tr>
107       </table>
108 </div>
109 <div class="memdoc">
110 <p>Creates an empty dictionary of pointers.</p>
111
112 <p>Definition at line <a class="el" href="skype-ptrint-dict_8cpp_source.html#l00049">49</a> of file <a class="el" href="skype-ptrint-dict_8cpp_source.html">skype-ptrint-dict.cpp</a>.</p>
113
114 </div>
115 </div>
116 <a class="anchor" id="a05e854a333976e9071261af0a2b7958c"></a><!-- doxytag: member="SEPtrIntDict::SEPtrIntDict" ref="a05e854a333976e9071261af0a2b7958c" args="(const SEPtrIntDict &amp;dict)" -->
117 <div class="memitem">
118 <div class="memproto">
119       <table class="memname">
120         <tr>
121           <td class="memname">SEPtrIntDict::SEPtrIntDict </td>
122           <td>(</td>
123           <td class="paramtype">const <a class="el" href="class_s_e_ptr_int_dict.html">SEPtrIntDict</a> &amp;&nbsp;</td>
124           <td class="paramname"> <em>dict</em></td>
125           <td>&nbsp;)&nbsp;</td>
126           <td></td>
127         </tr>
128       </table>
129 </div>
130 <div class="memdoc">
131 <p>Constructs an implicitly shared copy of dict. </p>
132
133 <p>Definition at line <a class="el" href="skype-ptrint-dict_8cpp_source.html#l00055">55</a> of file <a class="el" href="skype-ptrint-dict_8cpp_source.html">skype-ptrint-dict.cpp</a>.</p>
134
135 </div>
136 </div>
137 <a class="anchor" id="a3d261b4d5412bc08d85713776a91eb0b"></a><!-- doxytag: member="SEPtrIntDict::~SEPtrIntDict" ref="a3d261b4d5412bc08d85713776a91eb0b" args="()" -->
138 <div class="memitem">
139 <div class="memproto">
140       <table class="memname">
141         <tr>
142           <td class="memname">SEPtrIntDict::~SEPtrIntDict </td>
143           <td>(</td>
144           <td class="paramname"></td>
145           <td>&nbsp;)&nbsp;</td>
146           <td></td>
147         </tr>
148       </table>
149 </div>
150 <div class="memdoc">
151 <p>Destroys the dictionary and frees the data if this is the last reference to it. </p>
152
153 <p>Definition at line <a class="el" href="skype-ptrint-dict_8cpp_source.html#l00061">61</a> of file <a class="el" href="skype-ptrint-dict_8cpp_source.html">skype-ptrint-dict.cpp</a>.</p>
154
155 </div>
156 </div>
157 <hr/><h2>Member Function Documentation</h2>
158 <a class="anchor" id="a0bb35ddff347d074e42289a5858984d3"></a><!-- doxytag: member="SEPtrIntDict::find" ref="a0bb35ddff347d074e42289a5858984d3" args="(const int key, unsigned int offset=0) const " -->
159 <div class="memitem">
160 <div class="memproto">
161       <table class="memname">
162         <tr>
163           <td class="memname">const void *&amp; SEPtrIntDict::find </td>
164           <td>(</td>
165           <td class="paramtype">const int&nbsp;</td>
166           <td class="paramname"> <em>key</em>, </td>
167         </tr>
168         <tr>
169           <td class="paramkey"></td>
170           <td></td>
171           <td class="paramtype">unsigned int&nbsp;</td>
172           <td class="paramname"> <em>offset</em> = <code>0</code></td><td>&nbsp;</td>
173         </tr>
174         <tr>
175           <td></td>
176           <td>)</td>
177           <td></td><td></td><td> const</td>
178         </tr>
179       </table>
180 </div>
181 <div class="memdoc">
182 <p>Finds the specified key in the dictionary. </p>
183 <dl><dt><b>Parameters:</b></dt><dd>
184   <table border="0" cellspacing="2" cellpadding="0">
185     <tr><td valign="top"></td><td valign="top"><em>key</em>&nbsp;</td><td>Key to search. </td></tr>
186     <tr><td valign="top"></td><td valign="top"><em>offset</em>&nbsp;</td><td>When the dictionary contains several entries with the same key, use the offset param to indicate which key you want. </td></tr>
187   </table>
188   </dd>
189 </dl>
190 <dl class="return"><dt><b>Returns:</b></dt><dd>null if the key is not found. </dd></dl>
191
192 <p>Definition at line <a class="el" href="skype-ptrint-dict_8cpp_source.html#l00091">91</a> of file <a class="el" href="skype-ptrint-dict_8cpp_source.html">skype-ptrint-dict.cpp</a>.</p>
193
194 <p>References <a class="el" href="skype-int-dict_8cpp_source.html#l00005">SIZE</a>.</p>
195
196 </div>
197 </div>
198 <a class="anchor" id="a7e2487a31f556fddb716b2cea60596b0"></a><!-- doxytag: member="SEPtrIntDict::insert" ref="a7e2487a31f556fddb716b2cea60596b0" args="(const int key, const void *value)" -->
199 <div class="memitem">
200 <div class="memproto">
201       <table class="memname">
202         <tr>
203           <td class="memname">void SEPtrIntDict::insert </td>
204           <td>(</td>
205           <td class="paramtype">const int&nbsp;</td>
206           <td class="paramname"> <em>key</em>, </td>
207         </tr>
208         <tr>
209           <td class="paramkey"></td>
210           <td></td>
211           <td class="paramtype">const void *&nbsp;</td>
212           <td class="paramname"> <em>value</em></td><td>&nbsp;</td>
213         </tr>
214         <tr>
215           <td></td>
216           <td>)</td>
217           <td></td><td></td><td></td>
218         </tr>
219       </table>
220 </div>
221 <div class="memdoc">
222 <p>Inserts the key with the value into the dictionary. Multiple items can have the same key, they are not overwritten. You can access them with the offset parameter of the <a class="el" href="class_s_e_ptr_int_dict.html#a0bb35ddff347d074e42289a5858984d3">find()</a> function. If key is null, nothing is inserted. </p>
223
224 <p>Definition at line <a class="el" href="skype-ptrint-dict_8cpp_source.html#l00066">66</a> of file <a class="el" href="skype-ptrint-dict_8cpp_source.html">skype-ptrint-dict.cpp</a>.</p>
225
226 <p>References <a class="el" href="skype-int-dict_8cpp_source.html#l00005">SIZE</a>.</p>
227
228 </div>
229 </div>
230 <a class="anchor" id="a41ed584be1e678d5aa4cc1a9e721e8a3"></a><!-- doxytag: member="SEPtrIntDict::keyAt" ref="a41ed584be1e678d5aa4cc1a9e721e8a3" args="(size_t i) const " -->
231 <div class="memitem">
232 <div class="memproto">
233       <table class="memname">
234         <tr>
235           <td class="memname">int SEPtrIntDict::keyAt </td>
236           <td>(</td>
237           <td class="paramtype">size_t&nbsp;</td>
238           <td class="paramname"> <em>i</em></td>
239           <td>&nbsp;)&nbsp;</td>
240           <td> const</td>
241         </tr>
242       </table>
243 </div>
244 <div class="memdoc">
245 <p>Use this function to iterate through the dictionary. It doesn't make sense to use this functions outside of an iteration (i.e. a loop). See also <a class="el" href="class_s_e_ptr_int_dict.html#a405841d4e879e08d685c0724eb2a4546">operator[]()</a> </p>
246
247 <p>Definition at line <a class="el" href="skype-ptrint-dict_8cpp_source.html#l00253">253</a> of file <a class="el" href="skype-ptrint-dict_8cpp_source.html">skype-ptrint-dict.cpp</a>.</p>
248
249 <p>References <a class="el" href="skype-ptrint-dict_8cpp_source.html#l00198">size()</a>.</p>
250
251 </div>
252 </div>
253 <a class="anchor" id="ace988b3ab4d231add33660dd3814074b"></a><!-- doxytag: member="SEPtrIntDict::operator=" ref="ace988b3ab4d231add33660dd3814074b" args="(const SEPtrIntDict &amp;dict)" -->
254 <div class="memitem">
255 <div class="memproto">
256       <table class="memname">
257         <tr>
258           <td class="memname"><a class="el" href="class_s_e_ptr_int_dict.html">SEPtrIntDict</a> &amp; SEPtrIntDict::operator= </td>
259           <td>(</td>
260           <td class="paramtype">const <a class="el" href="class_s_e_ptr_int_dict.html">SEPtrIntDict</a> &amp;&nbsp;</td>
261           <td class="paramname"> <em>dict</em></td>
262           <td>&nbsp;)&nbsp;</td>
263           <td></td>
264         </tr>
265       </table>
266 </div>
267 <div class="memdoc">
268 <p>Assigns a shallow copy of dict to this dictionary and returns a reference to it. This is very fast because the dictionary isn't actually copied. </p>
269
270 <p>Definition at line <a class="el" href="skype-ptrint-dict_8cpp_source.html#l00116">116</a> of file <a class="el" href="skype-ptrint-dict_8cpp_source.html">skype-ptrint-dict.cpp</a>.</p>
271
272 </div>
273 </div>
274 <a class="anchor" id="a405841d4e879e08d685c0724eb2a4546"></a><!-- doxytag: member="SEPtrIntDict::operator[]" ref="a405841d4e879e08d685c0724eb2a4546" args="(size_t i) const " -->
275 <div class="memitem">
276 <div class="memproto">
277       <table class="memname">
278         <tr>
279           <td class="memname">const void *&amp; SEPtrIntDict::operator[] </td>
280           <td>(</td>
281           <td class="paramtype">size_t&nbsp;</td>
282           <td class="paramname"> <em>i</em></td>
283           <td>&nbsp;)&nbsp;</td>
284           <td> const</td>
285         </tr>
286       </table>
287 </div>
288 <div class="memdoc">
289 <p>Use this function to iterate through the dictionary. It doesn't make sense to use this functions outside of an iteration (i.e. a loop). See also <a class="el" href="class_s_e_ptr_int_dict.html#a41ed584be1e678d5aa4cc1a9e721e8a3">keyAt()</a> </p>
290
291 <p>Definition at line <a class="el" href="skype-ptrint-dict_8cpp_source.html#l00240">240</a> of file <a class="el" href="skype-ptrint-dict_8cpp_source.html">skype-ptrint-dict.cpp</a>.</p>
292
293 <p>References <a class="el" href="skype-ptrint-dict_8cpp_source.html#l00198">size()</a>.</p>
294
295 </div>
296 </div>
297 <a class="anchor" id="a0223d03d10cb98e07f39c952035bf188"></a><!-- doxytag: member="SEPtrIntDict::remove" ref="a0223d03d10cb98e07f39c952035bf188" args="(const int key)" -->
298 <div class="memitem">
299 <div class="memproto">
300       <table class="memname">
301         <tr>
302           <td class="memname">bool SEPtrIntDict::remove </td>
303           <td>(</td>
304           <td class="paramtype">const int&nbsp;</td>
305           <td class="paramname"> <em>key</em></td>
306           <td>&nbsp;)&nbsp;</td>
307           <td></td>
308         </tr>
309       </table>
310 </div>
311 <div class="memdoc">
312
313 <p>Definition at line <a class="el" href="skype-ptrint-dict_8cpp_source.html#l00264">264</a> of file <a class="el" href="skype-ptrint-dict_8cpp_source.html">skype-ptrint-dict.cpp</a>.</p>
314
315 </div>
316 </div>
317 <a class="anchor" id="aa83bcafb3bbaaf1d1ee225a1800e6ce8"></a><!-- doxytag: member="SEPtrIntDict::size" ref="aa83bcafb3bbaaf1d1ee225a1800e6ce8" args="() const " -->
318 <div class="memitem">
319 <div class="memproto">
320       <table class="memname">
321         <tr>
322           <td class="memname">size_t SEPtrIntDict::size </td>
323           <td>(</td>
324           <td class="paramname"></td>
325           <td>&nbsp;)&nbsp;</td>
326           <td> const</td>
327         </tr>
328       </table>
329 </div>
330 <div class="memdoc">
331 <p>Returns how many elements are in the dictionary.</p>
332
333 <p>Definition at line <a class="el" href="skype-ptrint-dict_8cpp_source.html#l00198">198</a> of file <a class="el" href="skype-ptrint-dict_8cpp_source.html">skype-ptrint-dict.cpp</a>.</p>
334
335 </div>
336 </div>
337 <hr/>The documentation for this class was generated from the following files:<ul>
338 <li><a class="el" href="skype-ptrint-dict_8h_source.html">skype-ptrint-dict.h</a></li>
339 <li><a class="el" href="skype-ptrint-dict_8cpp_source.html">skype-ptrint-dict.cpp</a></li>
340 </ul>
341 </div>
342
343 <hr/>   
344                 <p><b>(c) Skype Technologies S.A. Confidential/Proprietary</b></p>              
345                 <p>Last updated: 18 Jun 2010</p>                
346                 </BODY>
347 </HTML>