122488 - NPN_SetValue declaration inconsistent with documentation

Status: RESOLVED FIXED

(Core Graveyard :: Plug-ins, defect)

Description

[Patrick C. Beard]

The documentation for NPN_SetValue says that the type of the variable parameter
should be NPNVariable, yet it is declared as an NPPVariable in <npapi.h>. Either
the code or the documentation should be fixed. I encountered this, because I
want to add a new variable to the enumeration to manage the JSContext stack to
fix bug #118003.

Comment 1

[av (gone)]

Ideally, we should have had four sets of variables by two (set and get) for
NPN_* and NPP_* counterpart. But we historically have only two. NPPVariable is
used for both setting and getting. This is the cause of the confusion. We may
leave the code as is but the documentation needs to be updated like this:

#include <npapi.h>
NPError NPN_SetValue(NPP         instance,
-                    NPNVariable variable, 
+                    NPPVariable variable, 
                     void        *value);

Comment 2

[Ian Oeschger (gone)]

Roger on the doc update needed. ACCEPTING.

Comment 3

[Ian Oeschger (gone)]

updated the NPN_SetValue method per av's suggestion:
http://elwood:20007/dev/devedge/library/manuals/2002/plugin/1.0/npn_api17.html

This location is the staging server for the new devedge material going up
shortly. Sorry for all the jumping around, but the final location--and don't
quote me on this quite yet--will be something like
devedge/library/manuals/2002/plugin/1.0/.

I guess I will try and update the old guide too (?). Not sure where the "source"
is for the original plug-in guide.

Comment 4

[Ian Oeschger (gone)]

moving stuff over to an outside-the-firewall email for the time being, looking
for people to pick these Help and doc bugs up for me.