src/native_client_sdk/doc_generated/pepper_beta/c/struct_p_p_b___var_array__1__0.html

   1 {{+bindTo:partials.standard_nacl_article}}
   2 <h1>PPB_VarArray Struct Reference</h1>
   3 <div>
   4 <!-- Generated by Doxygen 1.7.6.1 -->
   5
   6
   7 </div>
   8 <!--header-->
   9 <div class="contents">
  10 <!-- doxytag: class="PPB_VarArray" --><h2>
  11 Data Fields</h2><table class="memberdecls">
  12
  13 <tr><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="struct_p_p___var.html">PP_Var</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___var_array__1__0.html#af70ca94305325f09306058ec87f50ca5">Create</a> )(void)</td></tr>
  14 <tr><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="struct_p_p___var.html">PP_Var</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___var_array__1__0.html#a20431bfeea806a1af61d4cca2f1f1437">Get</a> )(struct <a class="el" href="struct_p_p___var.html">PP_Var</a> array, uint32_t index)</td></tr>
  15 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___enums.html#ga4f272d99be14aacafe08dfd4ef830918">PP_Bool</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___var_array__1__0.html#aea60f6d4917fa248237c6bfd1eda92fe">Set</a> )(struct <a class="el" href="struct_p_p___var.html">PP_Var</a> array, uint32_t index, struct <a class="el" href="struct_p_p___var.html">PP_Var</a> value)</td></tr>
  16 <tr><td class="memItemLeft" align="right" valign="top">uint32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___var_array__1__0.html#ab1163119c730c95fea571a4618b8cc8f">GetLength</a> )(struct <a class="el" href="struct_p_p___var.html">PP_Var</a> array)</td></tr>
  17 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___enums.html#ga4f272d99be14aacafe08dfd4ef830918">PP_Bool</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___var_array__1__0.html#a4868611700bcca797bfae701870ce83b">SetLength</a> )(struct <a class="el" href="struct_p_p___var.html">PP_Var</a> array, uint32_t length)</td></tr>
  18 </table>
  19 <hr /><h2>Field Documentation</h2>
  20 <a class="anchor" id="af70ca94305325f09306058ec87f50ca5"></a><!-- doxytag: member="PPB_VarArray::Create" ref="af70ca94305325f09306058ec87f50ca5" args=")(void)" -->
  21 <div class="memitem">
  22 <div class="memproto">
  23 <table class="memname">
  24 <tr>
  25 <td class="memname">struct <a class="el" href="struct_p_p___var.html">PP_Var</a>(* <a class="el" href="struct_p_p_b___var_array__1__0.html#af70ca94305325f09306058ec87f50ca5">PPB_VarArray::Create</a>)(void)<code> [read]</code></td>
  26 </tr>
  27 </table>
  28 </div>
  29 <div class="memdoc">
  30 <p>Creates an array var, i.e., a <code><a class="el" href="struct_p_p___var.html" title="The PP_VAR struct is a variant data type and can contain any value of one of the types named in the P...">PP_Var</a></code> with type set to <code>PP_VARTYPE_ARRAY</code>. </p>
  31 <p>The array length is set to 0.</p>
  32 <dl class="return"><dt><b>Returns:</b></dt><dd>An empty array var, whose reference count is set to 1 on behalf of the caller. </dd></dl>
  33 </div>
  34 </div>
  35 <a class="anchor" id="a20431bfeea806a1af61d4cca2f1f1437"></a><!-- doxytag: member="PPB_VarArray::Get" ref="a20431bfeea806a1af61d4cca2f1f1437" args=")(struct PP_Var array, uint32_t index)" -->
  36 <div class="memitem">
  37 <div class="memproto">
  38 <table class="memname">
  39 <tr>
  40 <td class="memname">struct <a class="el" href="struct_p_p___var.html">PP_Var</a>(* <a class="el" href="struct_p_p_b___var_array__1__0.html#a20431bfeea806a1af61d4cca2f1f1437">PPB_VarArray::Get</a>)(struct <a class="el" href="struct_p_p___var.html">PP_Var</a> array, uint32_t index)<code> [read]</code></td>
  41 </tr>
  42 </table>
  43 </div>
  44 <div class="memdoc">
  45 <p>Gets an element from the array. </p>
  46 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  47 <table class="params">
  48 <tr><td class="paramdir">[in]</td><td class="paramname">array</td><td>An array var. </td></tr>
  49 <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>An index indicating which element to return.</td></tr>
  50 </table>
  51 </dd>
  52 </dl>
  53 <dl class="return"><dt><b>Returns:</b></dt><dd>The element at the specified position. The reference count of the element returned is incremented on behalf of the caller. If <code>index</code> is larger than or equal to the array length, an undefined var is returned. </dd></dl>
  54 </div>
  55 </div>
  56 <a class="anchor" id="ab1163119c730c95fea571a4618b8cc8f"></a><!-- doxytag: member="PPB_VarArray::GetLength" ref="ab1163119c730c95fea571a4618b8cc8f" args=")(struct PP_Var array)" -->
  57 <div class="memitem">
  58 <div class="memproto">
  59 <table class="memname">
  60 <tr>
  61 <td class="memname">uint32_t(* <a class="el" href="struct_p_p_b___var_array__1__0.html#ab1163119c730c95fea571a4618b8cc8f">PPB_VarArray::GetLength</a>)(struct <a class="el" href="struct_p_p___var.html">PP_Var</a> array)</td>
  62 </tr>
  63 </table>
  64 </div>
  65 <div class="memdoc">
  66 <p>Gets the array length. </p>
  67 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  68 <table class="params">
  69 <tr><td class="paramdir">[in]</td><td class="paramname">array</td><td>An array var.</td></tr>
  70 </table>
  71 </dd>
  72 </dl>
  73 <dl class="return"><dt><b>Returns:</b></dt><dd>The array length. </dd></dl>
  74 </div>
  75 </div>
  76 <a class="anchor" id="aea60f6d4917fa248237c6bfd1eda92fe"></a><!-- doxytag: member="PPB_VarArray::Set" ref="aea60f6d4917fa248237c6bfd1eda92fe" args=")(struct PP_Var array, uint32_t index, struct PP_Var value)" -->
  77 <div class="memitem">
  78 <div class="memproto">
  79 <table class="memname">
  80 <tr>
  81 <td class="memname"><a class="el" href="group___enums.html#ga4f272d99be14aacafe08dfd4ef830918">PP_Bool</a>(* <a class="el" href="struct_p_p_b___var_array__1__0.html#aea60f6d4917fa248237c6bfd1eda92fe">PPB_VarArray::Set</a>)(struct <a class="el" href="struct_p_p___var.html">PP_Var</a> array, uint32_t index, struct <a class="el" href="struct_p_p___var.html">PP_Var</a> value)</td>
  82 </tr>
  83 </table>
  84 </div>
  85 <div class="memdoc">
  86 <p>Sets the value of an element in the array. </p>
  87 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  88 <table class="params">
  89 <tr><td class="paramdir">[in]</td><td class="paramname">array</td><td>An array var. </td></tr>
  90 <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>An index indicating which element to modify. If <code>index</code> is larger than or equal to the array length, the length is updated to be <code>index</code> + 1. Any position in the array that hasn't been set before is set to undefined, i.e., <code><a class="el" href="struct_p_p___var.html" title="The PP_VAR struct is a variant data type and can contain any value of one of the types named in the P...">PP_Var</a></code> of type <code>PP_VARTYPE_UNDEFINED</code>. </td></tr>
  91 <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The value to set. The array holds a reference to it on success.</td></tr>
  92 </table>
  93 </dd>
  94 </dl>
  95 <dl class="return"><dt><b>Returns:</b></dt><dd>A <code>PP_Bool</code> indicating whether the operation succeeds. </dd></dl>
  96 </div>
  97 </div>
  98 <a class="anchor" id="a4868611700bcca797bfae701870ce83b"></a><!-- doxytag: member="PPB_VarArray::SetLength" ref="a4868611700bcca797bfae701870ce83b" args=")(struct PP_Var array, uint32_t length)" -->
  99 <div class="memitem">
 100 <div class="memproto">
 101 <table class="memname">
 102 <tr>
 103 <td class="memname"><a class="el" href="group___enums.html#ga4f272d99be14aacafe08dfd4ef830918">PP_Bool</a>(* <a class="el" href="struct_p_p_b___var_array__1__0.html#a4868611700bcca797bfae701870ce83b">PPB_VarArray::SetLength</a>)(struct <a class="el" href="struct_p_p___var.html">PP_Var</a> array, uint32_t length)</td>
 104 </tr>
 105 </table>
 106 </div>
 107 <div class="memdoc">
 108 <p>Sets the array length. </p>
 109 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 110 <table class="params">
 111 <tr><td class="paramdir">[in]</td><td class="paramname">array</td><td>An array var. </td></tr>
 112 <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The new array length. If <code>length</code> is smaller than its current value, the array is truncated to the new length; any elements that no longer fit are removed and the references to them will be released. If <code>length</code> is larger than its current value, undefined vars are appended to increase the array to the specified length.</td></tr>
 113 </table>
 114 </dd>
 115 </dl>
 116 <dl class="return"><dt><b>Returns:</b></dt><dd>A <code>PP_Bool</code> indicating whether the operation succeeds. </dd></dl>
 117 </div>
 118 </div>
 119 <hr />The documentation for this struct was generated from the following file:<ul>
 120 <li><a class="el" href="ppb__var__array_8h.html">ppb_var_array.h</a></li>
 121 </ul>
 122 </div><!-- contents -->
 123 {{/partials.standard_nacl_article}}