mozilla

Revision 83002 of NPP_GetValue

  • Revision slug: NPP_GetValue
  • Revision title: NPP_GetValue
  • Revision id: 83002
  • Created:
  • Creator: Karlt
  • Is current revision? No
  • Comment removed WindowBool TransparentBool; added NeedsXEmbed ScriptableNPObject; 24 words added, 41 words removed

Revision Content

 

{{ Np-plugin-api() }}

Summary

Allows the browser to query the plug-in for information.

Syntax

#include <npapi.h>
 
NPError NPP_GetValue(void *instance, 
                     NPPVariable variable, 
                     void *value);

Parameters

The function has the following parameters:

instance
Pointer to the plugin instance from which the value should come.
variable
Plug-in information the call gets. Values:
  • NPPVpluginScriptableNPObject: value is a pointer to NPObject.
  • NPPVpluginNeedsXEmbed: (X11 only) Tells whether the plug-in uses the XEmbed protocol; value is a pointer to PRBool.
value
Plug-in name, returned by the function.

Returns

  • If successful, the function returns NPERR_NO_ERROR.
  • If unsuccessful, the function returns an error code. For possible values, see Error Codes.

Description

NPP_GetValue retrieves instance variables.

You can use this method as an optional entry point that the browser can call to determine the plug-in name and description. It returns the requested values, specified by the variable and value parameters, to the plug-in.

See Also

NPP_SetValue, NPN_GetValue, NPN_SetValue 

{{ languages( { "ja": "ja/NPP_GetValue" } ) }}

Revision Source

<p> </p>
<p>{{ Np-plugin-api() }}</p>
<h3 name="Summary">Summary</h3>
<p>Allows the browser to query the plug-in for information.</p>
<h3 name="Syntax">Syntax</h3>
<pre>#include &lt;npapi.h&gt;
 
NPError NPP_GetValue(void *instance, 
                     NPPVariable variable, 
                     void *value);
</pre>
<h3 name="Parameters">Parameters</h3>
<p>The function has the following parameters:</p>
<dl> <dt>instance</dt> <dd>Pointer to the plugin instance from which the value should come.</dd>
</dl>
<dl> <dt>variable</dt> <dd>Plug-in information the call gets. Values: <ul> <li>NPPVpluginScriptableNPObject: value is a pointer to NPObject.</li> <li>NPPVpluginNeedsXEmbed: (X11 only) Tells whether the plug-in uses the XEmbed protocol; value is a pointer to PRBool.</li> </ul> </dd>
</dl>
<dl> <dt>value</dt> <dd>Plug-in name, returned by the function.</dd>
</dl>
<h3 name="Returns">Returns</h3>
<ul> <li>If successful, the function returns NPERR_NO_ERROR.</li> <li>If unsuccessful, the function returns an error code. For possible values, see <a href="/en/NPAPI/Constants#Error_Codes" title="en/NPAPI/Constants#Error_Codes">Error Codes</a>.</li>
</ul>
<h3 name="Description">Description</h3>
<p><code>NPP_GetValue</code> retrieves instance variables.</p>
<p>You can use this method as an optional entry point that the browser can call to determine the plug-in name and description. It returns the requested values, specified by the variable and value parameters, to the plug-in.</p>
<h3 name="See_Also">See Also</h3>
<p><a href="/en/NPP_SetValue" title="en/NPP_SetValue">NPP_SetValue</a>, <a class="internal" href="/en/NPN_GetValue" title="En/NPN GetValue">NPN_GetValue</a>, <a class="internal" href="/en/NPN_SetValue" title="En/NPN SetValue">NPN_SetValue</a> </p>
<p>{{ languages( { "ja": "ja/NPP_GetValue" } ) }}</p>
Revert to this revision