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

   1 {{+bindTo:partials.standard_nacl_article}}
   2 <h1>PPB_NetworkList 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_NetworkList" --><h2>
  11 Data Fields</h2><table class="memberdecls">
  12
  13 <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___network_list__1__0.html#ac8ab7ecff9909962a839d10f6e571954">IsNetworkList</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource)</td></tr>
  14 <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___network_list__1__0.html#a9240190a389e0068088e604704b153de">GetCount</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource)</td></tr>
  15 <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___network_list__1__0.html#a59fdecb98a8a25e7bf257d7106d74bae">GetName</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource, uint32_t index)</td></tr>
  16 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___enums.html#ga1c967cb753eb468493b3bf72e6733983">PP_NetworkList_Type</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___network_list__1__0.html#ae272fca616d11a27ea09c06a0659e0cc">GetType</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource, uint32_t index)</td></tr>
  17 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___enums.html#ga9188881b5d3346626db0ea8e6aaecf1f">PP_NetworkList_State</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___network_list__1__0.html#a2d9043e33c1c09f9eeea4b49be1629b1">GetState</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource, uint32_t index)</td></tr>
  18 <tr><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___network_list__1__0.html#a0dcbe767aed13b3b3492343eb0aa9756">GetIpAddresses</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource, uint32_t index, struct <a class="el" href="struct_p_p___array_output.html">PP_ArrayOutput</a> output)</td></tr>
  19 <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___network_list__1__0.html#a54e77303af12f276181b32ff94820bd8">GetDisplayName</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource, uint32_t index)</td></tr>
  20 <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___network_list__1__0.html#a19ecaf7b4627fe7f5d2b0edf02232e8f">GetMTU</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource, uint32_t index)</td></tr>
  21 </table>
  22 <hr /><a name="details" id="details"></a><h2>Detailed Description</h2>
  23 <div class="textblock"><p>The <code>PPB_NetworkList</code> is used to represent a list of network interfaces and their configuration. </p>
  24 <p>The content of the list is immutable. The current networks configuration can be received using the <code>PPB_NetworkMonitor</code> interface. </p>
  25 </div><hr /><h2>Field Documentation</h2>
  26 <a class="anchor" id="a9240190a389e0068088e604704b153de"></a><!-- doxytag: member="PPB_NetworkList::GetCount" ref="a9240190a389e0068088e604704b153de" args=")(PP_Resource resource)" -->
  27 <div class="memitem">
  28 <div class="memproto">
  29 <table class="memname">
  30 <tr>
  31 <td class="memname">uint32_t(* <a class="el" href="struct_p_p_b___network_list__1__0.html#a9240190a389e0068088e604704b153de">PPB_NetworkList::GetCount</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource)</td>
  32 </tr>
  33 </table>
  34 </div>
  35 <div class="memdoc">
  36 <p>Gets number of interfaces in the list. </p>
  37 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  38 <table class="params">
  39 <tr><td class="paramdir">[in]</td><td class="paramname">resource</td><td>A <code>PP_Resource</code> corresponding to a network list.</td></tr>
  40 </table>
  41 </dd>
  42 </dl>
  43 <dl class="return"><dt><b>Returns:</b></dt><dd>Returns number of available network interfaces or 0 if the list has never been updated. </dd></dl>
  44 </div>
  45 </div>
  46 <a class="anchor" id="a54e77303af12f276181b32ff94820bd8"></a><!-- doxytag: member="PPB_NetworkList::GetDisplayName" ref="a54e77303af12f276181b32ff94820bd8" args=")(PP_Resource resource, uint32_t index)" -->
  47 <div class="memitem">
  48 <div class="memproto">
  49 <table class="memname">
  50 <tr>
  51 <td class="memname">struct <a class="el" href="struct_p_p___var.html">PP_Var</a>(* <a class="el" href="struct_p_p_b___network_list__1__0.html#a54e77303af12f276181b32ff94820bd8">PPB_NetworkList::GetDisplayName</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource, uint32_t index)<code> [read]</code></td>
  52 </tr>
  53 </table>
  54 </div>
  55 <div class="memdoc">
  56 <p>Gets display name of a network interface. </p>
  57 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  58 <table class="params">
  59 <tr><td class="paramdir">[in]</td><td class="paramname">resource</td><td>A <code>PP_Resource</code> corresponding to a network list. </td></tr>
  60 <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>Index of the network interface.</td></tr>
  61 </table>
  62 </dd>
  63 </dl>
  64 <dl class="return"><dt><b>Returns:</b></dt><dd>Returns display name for the network interface with the specified <code>index</code>. </dd></dl>
  65 </div>
  66 </div>
  67 <a class="anchor" id="a0dcbe767aed13b3b3492343eb0aa9756"></a><!-- doxytag: member="PPB_NetworkList::GetIpAddresses" ref="a0dcbe767aed13b3b3492343eb0aa9756" args=")(PP_Resource resource, uint32_t index, struct PP_ArrayOutput output)" -->
  68 <div class="memitem">
  69 <div class="memproto">
  70 <table class="memname">
  71 <tr>
  72 <td class="memname">int32_t(* <a class="el" href="struct_p_p_b___network_list__1__0.html#a0dcbe767aed13b3b3492343eb0aa9756">PPB_NetworkList::GetIpAddresses</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource, uint32_t index, struct <a class="el" href="struct_p_p___array_output.html">PP_ArrayOutput</a> output)</td>
  73 </tr>
  74 </table>
  75 </div>
  76 <div class="memdoc">
  77 <p>Gets list of IP addresses for a network interface. </p>
  78 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  79 <table class="params">
  80 <tr><td class="paramdir">[in]</td><td class="paramname">resource</td><td>A <code>PP_Resource</code> corresponding to a network list. </td></tr>
  81 <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>Index of the network interface. </td></tr>
  82 <tr><td class="paramdir">[in]</td><td class="paramname">output</td><td>An output array which will receive <code>PPB_NetAddress</code> resources on success. Please note that the ref count of those resources has already been increased by 1 for the caller.</td></tr>
  83 </table>
  84 </dd>
  85 </dl>
  86 <dl class="return"><dt><b>Returns:</b></dt><dd>An error code from <code><a class="el" href="pp__errors_8h.html" title="This file defines an enumeration of all PPAPI error codes.">pp_errors.h</a></code>. </dd></dl>
  87 </div>
  88 </div>
  89 <a class="anchor" id="a19ecaf7b4627fe7f5d2b0edf02232e8f"></a><!-- doxytag: member="PPB_NetworkList::GetMTU" ref="a19ecaf7b4627fe7f5d2b0edf02232e8f" args=")(PP_Resource resource, uint32_t index)" -->
  90 <div class="memitem">
  91 <div class="memproto">
  92 <table class="memname">
  93 <tr>
  94 <td class="memname">uint32_t(* <a class="el" href="struct_p_p_b___network_list__1__0.html#a19ecaf7b4627fe7f5d2b0edf02232e8f">PPB_NetworkList::GetMTU</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource, uint32_t index)</td>
  95 </tr>
  96 </table>
  97 </div>
  98 <div class="memdoc">
  99 <p>Gets MTU (Maximum Transmission Unit) of a network interface. </p>
 100 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 101 <table class="params">
 102 <tr><td class="paramdir">[in]</td><td class="paramname">resource</td><td>A <code>PP_Resource</code> corresponding to a network list. </td></tr>
 103 <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>Index of the network interface.</td></tr>
 104 </table>
 105 </dd>
 106 </dl>
 107 <dl class="return"><dt><b>Returns:</b></dt><dd>Returns MTU for the network interface with the specified <code>index</code> or 0 if MTU is unknown. </dd></dl>
 108 </div>
 109 </div>
 110 <a class="anchor" id="a59fdecb98a8a25e7bf257d7106d74bae"></a><!-- doxytag: member="PPB_NetworkList::GetName" ref="a59fdecb98a8a25e7bf257d7106d74bae" args=")(PP_Resource resource, uint32_t index)" -->
 111 <div class="memitem">
 112 <div class="memproto">
 113 <table class="memname">
 114 <tr>
 115 <td class="memname">struct <a class="el" href="struct_p_p___var.html">PP_Var</a>(* <a class="el" href="struct_p_p_b___network_list__1__0.html#a59fdecb98a8a25e7bf257d7106d74bae">PPB_NetworkList::GetName</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource, uint32_t index)<code> [read]</code></td>
 116 </tr>
 117 </table>
 118 </div>
 119 <div class="memdoc">
 120 <p>Gets name of a network interface. </p>
 121 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 122 <table class="params">
 123 <tr><td class="paramdir">[in]</td><td class="paramname">resource</td><td>A <code>PP_Resource</code> corresponding to a network list. </td></tr>
 124 <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>Index of the network interface.</td></tr>
 125 </table>
 126 </dd>
 127 </dl>
 128 <dl class="return"><dt><b>Returns:</b></dt><dd>Returns name for the network interface with the specified <code>index</code>. </dd></dl>
 129 </div>
 130 </div>
 131 <a class="anchor" id="a2d9043e33c1c09f9eeea4b49be1629b1"></a><!-- doxytag: member="PPB_NetworkList::GetState" ref="a2d9043e33c1c09f9eeea4b49be1629b1" args=")(PP_Resource resource, uint32_t index)" -->
 132 <div class="memitem">
 133 <div class="memproto">
 134 <table class="memname">
 135 <tr>
 136 <td class="memname"><a class="el" href="group___enums.html#ga9188881b5d3346626db0ea8e6aaecf1f">PP_NetworkList_State</a>(* <a class="el" href="struct_p_p_b___network_list__1__0.html#a2d9043e33c1c09f9eeea4b49be1629b1">PPB_NetworkList::GetState</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource, uint32_t index)</td>
 137 </tr>
 138 </table>
 139 </div>
 140 <div class="memdoc">
 141 <p>Gets state of a network interface. </p>
 142 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 143 <table class="params">
 144 <tr><td class="paramdir">[in]</td><td class="paramname">resource</td><td>A <code>PP_Resource</code> corresponding to a network list. </td></tr>
 145 <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>Index of the network interface.</td></tr>
 146 </table>
 147 </dd>
 148 </dl>
 149 <dl class="return"><dt><b>Returns:</b></dt><dd>Returns current state of the network interface with the specified <code>index</code>. </dd></dl>
 150 </div>
 151 </div>
 152 <a class="anchor" id="ae272fca616d11a27ea09c06a0659e0cc"></a><!-- doxytag: member="PPB_NetworkList::GetType" ref="ae272fca616d11a27ea09c06a0659e0cc" args=")(PP_Resource resource, uint32_t index)" -->
 153 <div class="memitem">
 154 <div class="memproto">
 155 <table class="memname">
 156 <tr>
 157 <td class="memname"><a class="el" href="group___enums.html#ga1c967cb753eb468493b3bf72e6733983">PP_NetworkList_Type</a>(* <a class="el" href="struct_p_p_b___network_list__1__0.html#ae272fca616d11a27ea09c06a0659e0cc">PPB_NetworkList::GetType</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource, uint32_t index)</td>
 158 </tr>
 159 </table>
 160 </div>
 161 <div class="memdoc">
 162 <p>Gets type of a network interface. </p>
 163 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 164 <table class="params">
 165 <tr><td class="paramdir">[in]</td><td class="paramname">resource</td><td>A <code>PP_Resource</code> corresponding to a network list. </td></tr>
 166 <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>Index of the network interface.</td></tr>
 167 </table>
 168 </dd>
 169 </dl>
 170 <dl class="return"><dt><b>Returns:</b></dt><dd>Returns type of the network interface with the specified <code>index</code>. </dd></dl>
 171 </div>
 172 </div>
 173 <a class="anchor" id="ac8ab7ecff9909962a839d10f6e571954"></a><!-- doxytag: member="PPB_NetworkList::IsNetworkList" ref="ac8ab7ecff9909962a839d10f6e571954" args=")(PP_Resource resource)" -->
 174 <div class="memitem">
 175 <div class="memproto">
 176 <table class="memname">
 177 <tr>
 178 <td class="memname"><a class="el" href="group___enums.html#ga4f272d99be14aacafe08dfd4ef830918">PP_Bool</a>(* <a class="el" href="struct_p_p_b___network_list__1__0.html#ac8ab7ecff9909962a839d10f6e571954">PPB_NetworkList::IsNetworkList</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource)</td>
 179 </tr>
 180 </table>
 181 </div>
 182 <div class="memdoc">
 183 <p>Determines if the specified <code>resource</code> is a <code>NetworkList</code> object. </p>
 184 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 185 <table class="params">
 186 <tr><td class="paramdir">[in]</td><td class="paramname">resource</td><td>A <code>PP_Resource</code> resource.</td></tr>
 187 </table>
 188 </dd>
 189 </dl>
 190 <dl class="return"><dt><b>Returns:</b></dt><dd>Returns <code>PP_TRUE</code> if <code>resource</code> is a <code>PPB_NetworkList</code>, <code>PP_FALSE</code> otherwise. </dd></dl>
 191 </div>
 192 </div>
 193 <hr />The documentation for this struct was generated from the following file:<ul>
 194 <li><a class="el" href="ppb__network__list_8h.html">ppb_network_list.h</a></li>
 195 </ul>
 196 </div><!-- contents -->
 197 {{/partials.standard_nacl_article}}