Visit Mozilla.org

NPN GetProperty

From MDC


« Gecko Plugin API Reference « Scripting plugins

Contents

[edit] Summary

Gets the value of a property on the specified NPObject.

[edit] Syntax

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

[edit] Parameters

The function has the following parameters:

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

[edit] 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.