scons-out/doc/html/group___n_p_a_p_i.html

   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>Native Client: NPAPI Extensions</title>
   4 <link href="./tabs.css" rel="stylesheet" type="text/css">
   5 <link href="./stylesheet-dox.css" rel="stylesheet" type="text/css">
   6 </head><body>
   7 <div id="toplinks">
   8 <a href="../../../README.html">Back to README</a>
   9 </div>
  10 <!-- Generated by Doxygen 1.5.7.1 -->
  11 <div class="navigation" id="top">
  12   <div class="tabs">
  13     <ul>
  14       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  15       <li><a href="modules.html"><span>Modules</span></a></li>
  16       <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
  17       <li><a href="files.html"><span>Files</span></a></li>
  18     </ul>
  19   </div>
  20 </div>
  21 <div class="contents">
  22 <h1>NPAPI Extensions<br>
  23 <small>
  24 [<a class="el" href="group___libraries.html">Libraries</a>]</small>
  25 </h1>NPAPI extensions for Native Client applications.
  26 <a href="#_details">More...</a>
  27 <p>
  28 <h2>Defines</h2>
  29 <ul>
  30 <li>#define <a class="el" href="group___n_p_a_p_i.html#g5dee191d2b26cf475548a1b457c5abb9">NPVARIANT_IS_HANDLE</a>(_v)&nbsp;&nbsp;&nbsp;((int) (_v).type == (int) NPVariantType_Handle)
  31 <li>#define <a class="el" href="group___n_p_a_p_i.html#g459664576fcda88255509f58063d58d3">NPVARIANT_TO_HANDLE</a>(_v)&nbsp;&nbsp;&nbsp;((_v).value.intValue)
  32 <li>#define <a class="el" href="group___n_p_a_p_i.html#g4e0431a369926d94b6d2111de30e930c">HANDLE_TO_NPVARIANT</a>(_val, _v)
  33 </ul>
  34 <h2>Enumerations</h2>
  35 <ul>
  36 <li>enum { <b>NPVariantType_Handle</b> =  127
  37  }
  38 </ul>
  39 <h2>Functions</h2>
  40 <ul>
  41 <li>int <a class="el" href="group___n_p_a_p_i.html#g2b50007e7c4ff16360fa0294d1c6e67e">NaClNP_Init</a> (int *argc, char *argv[])
  42 <li>int <a class="el" href="group___n_p_a_p_i.html#gce42ffe1c1097900d0e06a4ff65bd329">NaClNP_MainLoop</a> (unsigned flags)
  43 <li>NPObject * <a class="el" href="group___n_p_a_p_i.html#g3e9da12acf670310f474861e000e88f5">NaClNPN_CreateArray</a> (NPP npp)
  44 <li>NPError <a class="el" href="group___n_p_a_p_i.html#ge62ca6fdaea647612ddbaf635b621a8b">NaClNPN_OpenURL</a> (NPP npp, const char *url, void *notify_data, void(*notify)(const char *url, void *notify_data, int handle))
  45 <li>NPObject * <a class="el" href="group___n_p_a_p_i.html#gd6b92f15011abb6dde0ae16e86f46ed7">NPP_GetScriptableInstance</a> (NPP instance)
  46 </ul>
  47 <hr><a name="_details"></a><h2>Detailed Description</h2>
  48 NPAPI extensions for Native Client applications.
  49 <p>
  50 Native Client supports a <a href="../../../documentation/npapi.html">subset of NPAPI</a>, plus these extensions. To learn about NPAPI, see <a href="http://developer.mozilla.org/en/Plugins">http://developer.mozilla.org/en/Plugins</a> and <a href="http://developer.mozilla.org/en/Gecko_Plugin_API_Reference.">http://developer.mozilla.org/en/Gecko_Plugin_API_Reference.</a><p>
  51 To use this API, include <code>&lt;<a class="el" href="nacl__npapi_8h.html" title="Defines the NPAPI extensions for Native Client applications.">nacl/nacl_npapi.h</a>&gt;</code> and link with the <code>google_nacl_npruntime</code> library.<p>
  52 <b>Note:</b> NPAPI support is experimental. If you encounter security issues, bugs, or missing features, please <a href="http://code.google.com/p/nativeclient/issues">file an issue</a>. <hr><h2>Define Documentation</h2>
  53 <a class="anchor" name="g4e0431a369926d94b6d2111de30e930c"></a><!-- doxytag: member="nacl_npapi.h::HANDLE_TO_NPVARIANT" ref="g4e0431a369926d94b6d2111de30e930c" args="(_val, _v)" -->
  54 <div class="memitem">
  55 <div class="memproto">
  56       <table class="memname">
  57         <tr>
  58           <td class="memname">#define HANDLE_TO_NPVARIANT          </td>
  59           <td>(</td>
  60           <td class="paramtype">_val,         <tr>
  61           <td class="paramkey"></td>
  62           <td></td>
  63           <td class="paramtype">_v&nbsp;</td>
  64           <td class="paramname">          </td>
  65           <td>&nbsp;)&nbsp;</td>
  66           <td></td>
  67         </tr>
  68       </table>
  69 </div>
  70 <div class="memdoc">
  71
  72 <p>
  73 <b>Value:</b><div class="fragment"><pre class="fragment">NP_BEGIN_MACRO \
  74     (_v).type = (NPVariantType) NPVariantType_Handle; \
  75     (_v).value.intValue = _val; \
  76     NP_END_MACRO
  77 </pre></div>[Native Client] Sets a NaCl resource descriptor to an NPVariant.
  78 <p>
  79 <dl compact><dt><b>Parameters:</b></dt><dd>
  80   <table border="0" cellspacing="2" cellpadding="0">
  81     <tr><td valign="top"></td><td valign="top"><em>_val</em>&nbsp;</td><td>The NaCl resource descriptor to set. </td></tr>
  82     <tr><td valign="top"></td><td valign="top"><em>_v</em>&nbsp;</td><td>The NPVariant value. </td></tr>
  83   </table>
  84 </dl>
  85
  86 </div>
  87 </div><p>
  88 <a class="anchor" name="g5dee191d2b26cf475548a1b457c5abb9"></a><!-- doxytag: member="nacl_npapi.h::NPVARIANT_IS_HANDLE" ref="g5dee191d2b26cf475548a1b457c5abb9" args="(_v)" -->
  89 <div class="memitem">
  90 <div class="memproto">
  91       <table class="memname">
  92         <tr>
  93           <td class="memname">#define NPVARIANT_IS_HANDLE          </td>
  94           <td>(</td>
  95           <td class="paramtype">_v&nbsp;</td>
  96           <td class="paramname">          </td>
  97           <td>&nbsp;)&nbsp;</td>
  98           <td>&nbsp;&nbsp;&nbsp;((int) (_v).type == (int) NPVariantType_Handle)</td>
  99         </tr>
 100       </table>
 101 </div>
 102 <div class="memdoc">
 103
 104 <p>
 105 [Native Client] Checks whether the NPVariant holds a NaCl resource descriptor.
 106 <p>
 107 <dl compact><dt><b>Parameters:</b></dt><dd>
 108   <table border="0" cellspacing="2" cellpadding="0">
 109     <tr><td valign="top"></td><td valign="top"><em>_v</em>&nbsp;</td><td>The NPVariant value. </td></tr>
 110   </table>
 111 </dl>
 112 <dl class="return" compact><dt><b>Returns:</b></dt><dd>Non-zero value if the NPVariant holds a NaCl resource descriptor; otherwise, 0. </dd></dl>
 113
 114 </div>
 115 </div><p>
 116 <a class="anchor" name="g459664576fcda88255509f58063d58d3"></a><!-- doxytag: member="nacl_npapi.h::NPVARIANT_TO_HANDLE" ref="g459664576fcda88255509f58063d58d3" args="(_v)" -->
 117 <div class="memitem">
 118 <div class="memproto">
 119       <table class="memname">
 120         <tr>
 121           <td class="memname">#define NPVARIANT_TO_HANDLE          </td>
 122           <td>(</td>
 123           <td class="paramtype">_v&nbsp;</td>
 124           <td class="paramname">          </td>
 125           <td>&nbsp;)&nbsp;</td>
 126           <td>&nbsp;&nbsp;&nbsp;((_v).value.intValue)</td>
 127         </tr>
 128       </table>
 129 </div>
 130 <div class="memdoc">
 131
 132 <p>
 133 [Native Client] Gets a NaCl resource descriptor from an NPVariant.
 134 <p>
 135 <dl compact><dt><b>Parameters:</b></dt><dd>
 136   <table border="0" cellspacing="2" cellpadding="0">
 137     <tr><td valign="top"></td><td valign="top"><em>_v</em>&nbsp;</td><td>The NPVariant value. </td></tr>
 138   </table>
 139 </dl>
 140 <dl class="return" compact><dt><b>Returns:</b></dt><dd>The NaCl resource descriptor. </dd></dl>
 141
 142 </div>
 143 </div><p>
 144 <hr><h2>Function Documentation</h2>
 145 <a class="anchor" name="g2b50007e7c4ff16360fa0294d1c6e67e"></a><!-- doxytag: member="nacl_npapi.h::NaClNP_Init" ref="g2b50007e7c4ff16360fa0294d1c6e67e" args="(int *argc, char *argv[])" -->
 146 <div class="memitem">
 147 <div class="memproto">
 148       <table class="memname">
 149         <tr>
 150           <td class="memname">int NaClNP_Init           </td>
 151           <td>(</td>
 152           <td class="paramtype">int *&nbsp;</td>
 153           <td class="paramname"> <em>argc</em>, </td>
 154         </tr>
 155         <tr>
 156           <td class="paramkey"></td>
 157           <td></td>
 158           <td class="paramtype">char *&nbsp;</td>
 159           <td class="paramname"> <em>argv</em>[]</td><td>&nbsp;</td>
 160         </tr>
 161         <tr>
 162           <td></td>
 163           <td>)</td>
 164           <td></td><td></td><td></td>
 165         </tr>
 166       </table>
 167 </div>
 168 <div class="memdoc">
 169
 170 <p>
 171 [Native Client] Initializes the NPAPI bridge RPC runtime.
 172 <p>
 173 <dl compact><dt><b>Parameters:</b></dt><dd>
 174   <table border="0" cellspacing="2" cellpadding="0">
 175     <tr><td valign="top"></td><td valign="top"><em>argc</em>&nbsp;</td><td>Pointer to the program's unmodified argc variable from main(). </td></tr>
 176     <tr><td valign="top"></td><td valign="top"><em>argv</em>&nbsp;</td><td>The program's unmodified argv variable from main(). </td></tr>
 177   </table>
 178 </dl>
 179 <dl class="return" compact><dt><b>Returns:</b></dt><dd>0 upon success; otherwise, -1. </dd></dl>
 180
 181 </div>
 182 </div><p>
 183 <a class="anchor" name="gce42ffe1c1097900d0e06a4ff65bd329"></a><!-- doxytag: member="nacl_npapi.h::NaClNP_MainLoop" ref="gce42ffe1c1097900d0e06a4ff65bd329" args="(unsigned flags)" -->
 184 <div class="memitem">
 185 <div class="memproto">
 186       <table class="memname">
 187         <tr>
 188           <td class="memname">int NaClNP_MainLoop           </td>
 189           <td>(</td>
 190           <td class="paramtype">unsigned&nbsp;</td>
 191           <td class="paramname"> <em>flags</em>          </td>
 192           <td>&nbsp;)&nbsp;</td>
 193           <td></td>
 194         </tr>
 195       </table>
 196 </div>
 197 <div class="memdoc">
 198
 199 <p>
 200 [Native Client] Enters the NPAPI bridge RPC processing loop.
 201 <p>
 202 <a class="el" href="group___n_p_a_p_i.html#gce42ffe1c1097900d0e06a4ff65bd329" title="[Native Client] Enters the NPAPI bridge RPC processing loop.">NaClNP_MainLoop()</a> should be called once after <a class="el" href="group___n_p_a_p_i.html#g2b50007e7c4ff16360fa0294d1c6e67e" title="[Native Client] Initializes the NPAPI bridge RPC runtime.">NaClNP_Init()</a> is called successfully. <dl compact><dt><b>Parameters:</b></dt><dd>
 203   <table border="0" cellspacing="2" cellpadding="0">
 204     <tr><td valign="top"></td><td valign="top"><em>flags</em>&nbsp;</td><td>Reserved. Use 0. </td></tr>
 205   </table>
 206 </dl>
 207 <dl class="return" compact><dt><b>Returns:</b></dt><dd>0 upon success; otherwise, -1. </dd></dl>
 208
 209 </div>
 210 </div><p>
 211 <a class="anchor" name="g3e9da12acf670310f474861e000e88f5"></a><!-- doxytag: member="nacl_npapi.h::NaClNPN_CreateArray" ref="g3e9da12acf670310f474861e000e88f5" args="(NPP npp)" -->
 212 <div class="memitem">
 213 <div class="memproto">
 214       <table class="memname">
 215         <tr>
 216           <td class="memname">NPObject* NaClNPN_CreateArray           </td>
 217           <td>(</td>
 218           <td class="paramtype">NPP&nbsp;</td>
 219           <td class="paramname"> <em>npp</em>          </td>
 220           <td>&nbsp;)&nbsp;</td>
 221           <td></td>
 222         </tr>
 223       </table>
 224 </div>
 225 <div class="memdoc">
 226
 227 <p>
 228 [Native Client] Creates a JavaScript array object.
 229 <p>
 230 <dl compact><dt><b>Parameters:</b></dt><dd>
 231   <table border="0" cellspacing="2" cellpadding="0">
 232     <tr><td valign="top"></td><td valign="top"><em>npp</em>&nbsp;</td><td>Pointer to the plug-in instance. </td></tr>
 233   </table>
 234 </dl>
 235 <dl class="return" compact><dt><b>Returns:</b></dt><dd>Pointer to the new JavaScript array object, or NULL on failure. </dd></dl>
 236
 237 </div>
 238 </div><p>
 239 <a class="anchor" name="ge62ca6fdaea647612ddbaf635b621a8b"></a><!-- doxytag: member="nacl_npapi.h::NaClNPN_OpenURL" ref="ge62ca6fdaea647612ddbaf635b621a8b" args="(NPP npp, const char *url, void *notify_data, void(*notify)(const char *url, void *notify_data, int handle))" -->
 240 <div class="memitem">
 241 <div class="memproto">
 242       <table class="memname">
 243         <tr>
 244           <td class="memname">NPError NaClNPN_OpenURL           </td>
 245           <td>(</td>
 246           <td class="paramtype">NPP&nbsp;</td>
 247           <td class="paramname"> <em>npp</em>, </td>
 248         </tr>
 249         <tr>
 250           <td class="paramkey"></td>
 251           <td></td>
 252           <td class="paramtype">const char *&nbsp;</td>
 253           <td class="paramname"> <em>url</em>, </td>
 254         </tr>
 255         <tr>
 256           <td class="paramkey"></td>
 257           <td></td>
 258           <td class="paramtype">void *&nbsp;</td>
 259           <td class="paramname"> <em>notify_data</em>, </td>
 260         </tr>
 261         <tr>
 262           <td class="paramkey"></td>
 263           <td></td>
 264           <td class="paramtype">void(*)(const char *url, void *notify_data, int handle)&nbsp;</td>
 265           <td class="paramname"> <em>notify</em></td><td>&nbsp;</td>
 266         </tr>
 267         <tr>
 268           <td></td>
 269           <td>)</td>
 270           <td></td><td></td><td></td>
 271         </tr>
 272       </table>
 273 </div>
 274 <div class="memdoc">
 275
 276 <p>
 277 [Native Client] Gets a file descriptor for the specified URL.
 278 <p>
 279 On success, the notify function will be called back. If the file specified by the URL has been successfully opened, the handle argument for the notify function will be set to a valid file descriptor; otherwise, it will be set to -1. This function enforces cross-domain access restrictions.<p>
 280 Note: <a class="el" href="group___n_p_a_p_i.html#ge62ca6fdaea647612ddbaf635b621a8b" title="[Native Client] Gets a file descriptor for the specified URL.">NaClNPN_OpenURL()</a> returns an error when another <a class="el" href="group___n_p_a_p_i.html#ge62ca6fdaea647612ddbaf635b621a8b" title="[Native Client] Gets a file descriptor for the specified URL.">NaClNPN_OpenURL()</a> operation is in progress in background. <dl compact><dt><b>Parameters:</b></dt><dd>
 281   <table border="0" cellspacing="2" cellpadding="0">
 282     <tr><td valign="top"></td><td valign="top"><em>npp</em>&nbsp;</td><td>Pointer to the plug-in instance. </td></tr>
 283     <tr><td valign="top"></td><td valign="top"><em>url</em>&nbsp;</td><td>Pointer to the URL of the request. </td></tr>
 284     <tr><td valign="top"></td><td valign="top"><em>notify_data</em>&nbsp;</td><td>Plug-in private value for associating the request with the subsequent notify call. </td></tr>
 285     <tr><td valign="top"></td><td valign="top"><em>notify</em>&nbsp;</td><td>Pointer to a callback function to be called upon successful call to the function. </td></tr>
 286   </table>
 287 </dl>
 288 <dl class="return" compact><dt><b>Returns:</b></dt><dd>NPERR_NO_ERROR if successful; otherwise, an error code. </dd></dl>
 289
 290 </div>
 291 </div><p>
 292 <a class="anchor" name="gd6b92f15011abb6dde0ae16e86f46ed7"></a><!-- doxytag: member="nacl_npapi.h::NPP_GetScriptableInstance" ref="gd6b92f15011abb6dde0ae16e86f46ed7" args="(NPP instance)" -->
 293 <div class="memitem">
 294 <div class="memproto">
 295       <table class="memname">
 296         <tr>
 297           <td class="memname">NPObject* NPP_GetScriptableInstance           </td>
 298           <td>(</td>
 299           <td class="paramtype">NPP&nbsp;</td>
 300           <td class="paramname"> <em>instance</em>          </td>
 301           <td>&nbsp;)&nbsp;</td>
 302           <td></td>
 303         </tr>
 304       </table>
 305 </div>
 306 <div class="memdoc">
 307
 308 <p>
 309 [Native Client] Returns a scriptable object pointer that corresponds to NPPVpluginScriptableNPObject queried by NPP_GetValue().
 310 <p>
 311 <dl compact><dt><b>Parameters:</b></dt><dd>
 312   <table border="0" cellspacing="2" cellpadding="0">
 313     <tr><td valign="top"></td><td valign="top"><em>instance</em>&nbsp;</td><td>Pointer to the plug-in instance. </td></tr>
 314   </table>
 315 </dl>
 316 <dl class="return" compact><dt><b>Returns:</b></dt><dd>A scriptable object pointer if the module is scriptable, or NULL if not. </dd></dl>
 317
 318 </div>
 319 </div><p>
 320 </div>
 321 <p id="license">
 322 Except as otherwise
 323 <a href="http://code.google.com/policies.html#restrictions">noted</a>,
 324 the content of this page is licensed under a
 325 <a href="http://www.google.com/url?sa=D&amp;q=http%3A%2F%2Fcreativecommons.org/licenses/by/2.5/">Creative Commons
 326 Attribution 2.5 license</a>.
 327 </p>
 328
 329 <address>
 330 Generated 30 Mar 2009 by <a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.7.1
 331 </address>
 332
 333 </body>
 334 </html>