NPN_GetProperty

« Gecko Plugin API Reference « Scripting plugins

Summary

Gets the value of a property on the specified NPObject.

Syntax

#include <npruntime.h>
bool NPN_GetProperty(NPP npp, NPObject *npobj, NPIdentifier propertyName,
                     NPVariant *result);

Parameters

The function has the following parameters:

<tt>npp</tt>
The NPP indicating which plugin instance's is making the request.
<tt>npobj</tt>
The object from which a value is to be retrieved.
<tt>propertyName</tt>
A string identifier indicating the name of the property whose value is to be retrieved.
<tt>result</tt>
On return, contains the value of the specified property.

Returns

true if the value was retrieved successfully, otherwise false.

Note: The caller must call NPN_ReleaseVariantValue() to release the returned value when it's no longer needed.

Document Tags and Contributors

Tags: 
 Contributors to this page: teoli, Sheppy
 Last updated by: teoli,