NPN_RemoveProperty

  • Revision slug: NPN_RemoveProperty
  • Revision title: NPN_RemoveProperty
  • Revision id: 325769
  • Created:
  • Creator: ethertank
  • Is current revision? Yes
  • Comment

Revision Content

{{Np-plugin-scripting}}

Summary

Removes a property from the specified NPObject.

Syntax

#include <npruntime.h>

bool NPN_RemoveProperty(NPP npp, NPObject *npobj, NPIdentifier propertyName);

Parameters

The function has the following parameters:

npp
The NPP indicating which plugin instance is making the request.
npobj
The object on which a property is to be deleted.
propertyName
A string identifier indicating the name of the property to remove.

Returns

true if the property was removed successfully, otherwise false.

Revision Source

<div>{{Np-plugin-scripting}}</div>

<h2 id="Summary" name="Summary">Summary</h2>

<p>Removes a property from the specified <code><a href="/en-US/docs/NPObject">NPObject</a></code>.</p>

<h2 id="Syntax" name="Syntax">Syntax</h2>
<pre class="syntaxbox">
#include &lt;npruntime.h&gt;

bool NPN_RemoveProperty(NPP npp, NPObject *npobj, NPIdentifier propertyName);
</pre>

<h3 id="Parameters" name="Parameters">Parameters</h3>

<p>The function has the following parameters:</p>

<dl>
  <dt><code>npp</code></dt>
  <dd>The <a href="/en-US/docs/NPP">NPP</a> indicating which plugin instance is making the request.</dd>
  <dt><code>npobj</code></dt>
  <dd>The object on which a property is to be deleted.</dd>
  <dt><code>propertyName</code></dt>
  <dd>A string identifier indicating the name of the property to remove.</dd>
</dl>

<h3 id="Returns" name="Returns">Returns</h3>

<p><code>true</code> if the property was removed successfully, otherwise <code>false</code>.</p>
Revert to this revision