PageRenderTime 35ms CodeModel.GetById 14ms app.highlight 15ms RepoModel.GetById 1ms app.codeStats 0ms

/xbmc/visualizations/Vortex/angelscript/docs/manual/classas_i_script_array.html

http://github.com/xbmc/xbmc
HTML | 256 lines | 231 code | 24 blank | 1 comment | 0 complexity | e148f4fe82c8760d2860630b5948812f MD5 | raw file
  1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
  2<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
  3<title>AngelScript: asIScriptArray Class Reference</title>
  4<link href="tabs.css" rel="stylesheet" type="text/css">
  5<link href="doxygen.css" rel="stylesheet" type="text/css">
  6</head><body>
  7<!-- Generated by Doxygen 1.5.9 -->
  8<div class="contents">
  9<h1>asIScriptArray Class Reference</h1><!-- doxytag: class="asIScriptArray" -->The interface for a script array object.  
 10
 11<p>
 12
 13<p>
 14<a href="classas_i_script_array-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
 15<tr><td></td></tr>
 16<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
 17<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classas_i_script_engine.html">asIScriptEngine</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_array.html#9e1ca36e5a635868215e99327756a7b6">GetEngine</a> () const =0</td></tr>
 18
 19<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the script engine.  <a href="#9e1ca36e5a635868215e99327756a7b6"></a><br></td></tr>
 20<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_array.html#25aa66a7f58e8141af4f5c6191dc98ab">AddRef</a> ()=0</td></tr>
 21
 22<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Increase reference counter.  <a href="#25aa66a7f58e8141af4f5c6191dc98ab"></a><br></td></tr>
 23<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_array.html#b788125b97034c2625af836785362717">Release</a> ()=0</td></tr>
 24
 25<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Decrease reference counter.  <a href="#b788125b97034c2625af836785362717"></a><br></td></tr>
 26<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_array.html#fbc0e79addffac58cd7f6ea09828c19b">GetArrayTypeId</a> ()=0</td></tr>
 27
 28<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the type id of the array object.  <a href="#fbc0e79addffac58cd7f6ea09828c19b"></a><br></td></tr>
 29<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_array.html#a1946a26ea118079bbc846416c336453">GetElementTypeId</a> ()=0</td></tr>
 30
 31<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the type id of the contained elements.  <a href="#a1946a26ea118079bbc846416c336453"></a><br></td></tr>
 32<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="angelscript_8h.html#c8186f029686800b7ce36bde4a55c815">asUINT</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_array.html#d03c0f422ab208ac6e468ca95e3f8964">GetElementCount</a> ()=0</td></tr>
 33
 34<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the size of the array.  <a href="#d03c0f422ab208ac6e468ca95e3f8964"></a><br></td></tr>
 35<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_array.html#9304636528f24c86106182e57cab44a8">GetElementPointer</a> (<a class="el" href="angelscript_8h.html#c8186f029686800b7ce36bde4a55c815">asUINT</a> index)=0</td></tr>
 36
 37<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a pointer to the element referenced by index.  <a href="#9304636528f24c86106182e57cab44a8"></a><br></td></tr>
 38<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_array.html#3a031695a59959782bed3901162f74f3">Resize</a> (<a class="el" href="angelscript_8h.html#c8186f029686800b7ce36bde4a55c815">asUINT</a> size)=0</td></tr>
 39
 40<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Resizes the array.  <a href="#3a031695a59959782bed3901162f74f3"></a><br></td></tr>
 41<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_array.html#dabaf82e175ae2c52384fac9611dbe7f">CopyFrom</a> (<a class="el" href="classas_i_script_array.html">asIScriptArray</a> *other)=0</td></tr>
 42
 43<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Copies the elements from another array, overwriting the current content.  <a href="#dabaf82e175ae2c52384fac9611dbe7f"></a><br></td></tr>
 44</table>
 45<hr><h2>Member Function Documentation</h2>
 46<a class="anchor" name="25aa66a7f58e8141af4f5c6191dc98ab"></a><!-- doxytag: member="asIScriptArray::AddRef" ref="25aa66a7f58e8141af4f5c6191dc98ab" args="()=0" -->
 47<div class="memitem">
 48<div class="memproto">
 49      <table class="memname">
 50        <tr>
 51          <td class="memname">virtual int asIScriptArray::AddRef           </td>
 52          <td>(</td>
 53          <td class="paramname">          </td>
 54          <td>&nbsp;)&nbsp;</td>
 55          <td><code> [pure virtual]</code></td>
 56        </tr>
 57      </table>
 58</div>
 59<div class="memdoc">
 60
 61<p>
 62<dl class="return" compact><dt><b>Returns:</b></dt><dd>The number of references to this object.</dd></dl>
 63Call this method when storing an additional reference to the object. 
 64</div>
 65</div><p>
 66<a class="anchor" name="dabaf82e175ae2c52384fac9611dbe7f"></a><!-- doxytag: member="asIScriptArray::CopyFrom" ref="dabaf82e175ae2c52384fac9611dbe7f" args="(asIScriptArray *other)=0" -->
 67<div class="memitem">
 68<div class="memproto">
 69      <table class="memname">
 70        <tr>
 71          <td class="memname">virtual int asIScriptArray::CopyFrom           </td>
 72          <td>(</td>
 73          <td class="paramtype"><a class="el" href="classas_i_script_array.html">asIScriptArray</a> *&nbsp;</td>
 74          <td class="paramname"> <em>other</em>          </td>
 75          <td>&nbsp;)&nbsp;</td>
 76          <td><code> [pure virtual]</code></td>
 77        </tr>
 78      </table>
 79</div>
 80<div class="memdoc">
 81
 82<p>
 83<dl compact><dt><b>Parameters:</b></dt><dd>
 84  <table border="0" cellspacing="2" cellpadding="0">
 85    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>other</em>&nbsp;</td><td>A pointer to the source array. </td></tr>
 86  </table>
 87</dl>
 88<dl class="return" compact><dt><b>Returns:</b></dt><dd>A negative value on error. </dd></dl>
 89<dl compact><dt><b>Return values:</b></dt><dd>
 90  <table border="0" cellspacing="2" cellpadding="0">
 91    <tr><td valign="top"></td><td valign="top"><em>asINVALID_ARG</em>&nbsp;</td><td>The argument is null. </td></tr>
 92    <tr><td valign="top"></td><td valign="top"><em>asINVALID_TYPE</em>&nbsp;</td><td>The other array is of different type.</td></tr>
 93  </table>
 94</dl>
 95This method copies the contents of the other object to this one. 
 96</div>
 97</div><p>
 98<a class="anchor" name="fbc0e79addffac58cd7f6ea09828c19b"></a><!-- doxytag: member="asIScriptArray::GetArrayTypeId" ref="fbc0e79addffac58cd7f6ea09828c19b" args="()=0" -->
 99<div class="memitem">
100<div class="memproto">
101      <table class="memname">
102        <tr>
103          <td class="memname">virtual int asIScriptArray::GetArrayTypeId           </td>
104          <td>(</td>
105          <td class="paramname">          </td>
106          <td>&nbsp;)&nbsp;</td>
107          <td><code> [pure virtual]</code></td>
108        </tr>
109      </table>
110</div>
111<div class="memdoc">
112
113<p>
114<dl class="return" compact><dt><b>Returns:</b></dt><dd>The type id of the array object. </dd></dl>
115
116</div>
117</div><p>
118<a class="anchor" name="d03c0f422ab208ac6e468ca95e3f8964"></a><!-- doxytag: member="asIScriptArray::GetElementCount" ref="d03c0f422ab208ac6e468ca95e3f8964" args="()=0" -->
119<div class="memitem">
120<div class="memproto">
121      <table class="memname">
122        <tr>
123          <td class="memname">virtual <a class="el" href="angelscript_8h.html#c8186f029686800b7ce36bde4a55c815">asUINT</a> asIScriptArray::GetElementCount           </td>
124          <td>(</td>
125          <td class="paramname">          </td>
126          <td>&nbsp;)&nbsp;</td>
127          <td><code> [pure virtual]</code></td>
128        </tr>
129      </table>
130</div>
131<div class="memdoc">
132
133<p>
134<dl class="return" compact><dt><b>Returns:</b></dt><dd>The number of elements in the array. </dd></dl>
135
136</div>
137</div><p>
138<a class="anchor" name="9304636528f24c86106182e57cab44a8"></a><!-- doxytag: member="asIScriptArray::GetElementPointer" ref="9304636528f24c86106182e57cab44a8" args="(asUINT index)=0" -->
139<div class="memitem">
140<div class="memproto">
141      <table class="memname">
142        <tr>
143          <td class="memname">virtual void* asIScriptArray::GetElementPointer           </td>
144          <td>(</td>
145          <td class="paramtype"><a class="el" href="angelscript_8h.html#c8186f029686800b7ce36bde4a55c815">asUINT</a>&nbsp;</td>
146          <td class="paramname"> <em>index</em>          </td>
147          <td>&nbsp;)&nbsp;</td>
148          <td><code> [pure virtual]</code></td>
149        </tr>
150      </table>
151</div>
152<div class="memdoc">
153
154<p>
155<dl compact><dt><b>Parameters:</b></dt><dd>
156  <table border="0" cellspacing="2" cellpadding="0">
157    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>index</em>&nbsp;</td><td>The element index. </td></tr>
158  </table>
159</dl>
160<dl class="return" compact><dt><b>Returns:</b></dt><dd>A pointer to the element value.</dd></dl>
161The method returns a pointer to the memory location for the element. Use the type id for the element to determine the content of the pointer, and how to handle it. 
162</div>
163</div><p>
164<a class="anchor" name="a1946a26ea118079bbc846416c336453"></a><!-- doxytag: member="asIScriptArray::GetElementTypeId" ref="a1946a26ea118079bbc846416c336453" args="()=0" -->
165<div class="memitem">
166<div class="memproto">
167      <table class="memname">
168        <tr>
169          <td class="memname">virtual int asIScriptArray::GetElementTypeId           </td>
170          <td>(</td>
171          <td class="paramname">          </td>
172          <td>&nbsp;)&nbsp;</td>
173          <td><code> [pure virtual]</code></td>
174        </tr>
175      </table>
176</div>
177<div class="memdoc">
178
179<p>
180<dl class="return" compact><dt><b>Returns:</b></dt><dd>The type id of the array elements. </dd></dl>
181
182</div>
183</div><p>
184<a class="anchor" name="9e1ca36e5a635868215e99327756a7b6"></a><!-- doxytag: member="asIScriptArray::GetEngine" ref="9e1ca36e5a635868215e99327756a7b6" args="() const =0" -->
185<div class="memitem">
186<div class="memproto">
187      <table class="memname">
188        <tr>
189          <td class="memname">virtual <a class="el" href="classas_i_script_engine.html">asIScriptEngine</a>* asIScriptArray::GetEngine           </td>
190          <td>(</td>
191          <td class="paramname">          </td>
192          <td>&nbsp;)&nbsp;</td>
193          <td> const<code> [pure virtual]</code></td>
194        </tr>
195      </table>
196</div>
197<div class="memdoc">
198
199<p>
200<dl class="return" compact><dt><b>Returns:</b></dt><dd>The script engine. </dd></dl>
201
202</div>
203</div><p>
204<a class="anchor" name="b788125b97034c2625af836785362717"></a><!-- doxytag: member="asIScriptArray::Release" ref="b788125b97034c2625af836785362717" args="()=0" -->
205<div class="memitem">
206<div class="memproto">
207      <table class="memname">
208        <tr>
209          <td class="memname">virtual int asIScriptArray::Release           </td>
210          <td>(</td>
211          <td class="paramname">          </td>
212          <td>&nbsp;)&nbsp;</td>
213          <td><code> [pure virtual]</code></td>
214        </tr>
215      </table>
216</div>
217<div class="memdoc">
218
219<p>
220<dl class="return" compact><dt><b>Returns:</b></dt><dd>The number of references to this object.</dd></dl>
221Call this method when you will no longer use the references that you own. 
222</div>
223</div><p>
224<a class="anchor" name="3a031695a59959782bed3901162f74f3"></a><!-- doxytag: member="asIScriptArray::Resize" ref="3a031695a59959782bed3901162f74f3" args="(asUINT size)=0" -->
225<div class="memitem">
226<div class="memproto">
227      <table class="memname">
228        <tr>
229          <td class="memname">virtual void asIScriptArray::Resize           </td>
230          <td>(</td>
231          <td class="paramtype"><a class="el" href="angelscript_8h.html#c8186f029686800b7ce36bde4a55c815">asUINT</a>&nbsp;</td>
232          <td class="paramname"> <em>size</em>          </td>
233          <td>&nbsp;)&nbsp;</td>
234          <td><code> [pure virtual]</code></td>
235        </tr>
236      </table>
237</div>
238<div class="memdoc">
239
240<p>
241<dl compact><dt><b>Parameters:</b></dt><dd>
242  <table border="0" cellspacing="2" cellpadding="0">
243    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>size</em>&nbsp;</td><td>The new size of the array.</td></tr>
244  </table>
245</dl>
246This method allows the application to resize the array. 
247</div>
248</div><p>
249<hr>The documentation for this class was generated from the following file:<ul>
250<li><a class="el" href="angelscript_8h.html">angelscript.h</a></ul>
251</div>
252<hr size="1"><address style="text-align: right;"><small>Generated on Wed Dec 16 19:34:51 2009 for AngelScript by&nbsp;
253<a href="http://www.doxygen.org/index.html">
254<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
255</body>
256</html>