NPN_InvokeDefault

« Gecko Plugin API Reference « Scripting plugins

Summary

Invokes the default method, if one exists, on the given NPObject.

Syntax

#include <npruntime.h>
bool NPN_InvokeDefault(NPP npp, NPObject *npobj, const NPVariant *args,
                       uint32_t argCount, NPVariant *result);

Parameters

The function has the following parameters:

npp

The NPP indicating which plugin wants to call the default method on the object.

npobj

The object on which to invoke the default method.

args

An array of arguments to pass to the default method.

argCount

The number of arguments in the args array.

result

A pointer to an NPVariant to receive the result returned by the default method.

Returns

true if the default method was successfully invoked, otherwise false. If the default method was invoked successfully, any return value is stored in the NPVariant specified by result.

When the caller no longer needs the result, it must call NPN_ReleaseVariantValue() to release it.

Description

The method arguments are passed as an array of NPVariants, and the number of arguments is passed in. The result of the method invocation is returned through an NPVariant result parameter. If the method invocation succeeds, NPN_Invoke() returns true, else false.