NPP_GetValue

« Gecko Plugin API Reference « Plug-in Side Plug-in API

概要

プラグインが情報を問い合わせできるようにします。

文法

#include <npapi.h>
 
NPError NPP_GetValue(void *instance, 
                     NPPVariable variable, 
                     void *value);

パラメータ

この関数は以下のパラメータを取ります:

instance

現在のプラグインインスタンスへのポインタ。

variable

呼び手が取得するプラグイン情報 値:

• NPPVpluginWindowBool: プラグインがウィンドウを持つかどうかを告知します; 真=ウィンドウを持たない、偽=ウィンドウを持つ
• NPPVpluginTransparentBool: プラグインが透過かどうか告知します; 真=透過、偽=透過でない

value

関数によって返される、プラグイン名。

戻り値

• 成功すれば、この関数は NPERR_NO_ERROR を返します。
• 失敗すれば、この関数はエラーコードを返します。返しうる値については、エラーコード を参照してください。

説明

NPP_GetValue は、プラグインがウィンドウを持つか持たないかどうかや JavaScript が有効かどうかといった NPP_SetValue によって設定されたプラグインの特徴を読み出します。

プラグイン名や説明を決めるためにブラウザが呼び出せるオプションのエントリーポイントとしてこのメソッドを使えます。この関数はプラグインに variable や value パラメータで指定され、要求された値を返します。

関連項目

NPP_SetValue