NPP DestroyStream
出典: MDC
« Gecko Plugin API Reference « Plug-in Side Plug-in API
目次 |
[編集] 概要
ストリームが閉じられ、あるいは破棄されようとしているとプラグインに告知します。
[編集] 文法
#include <npapi.h>
NPError NPP_DestroyStream(NPP instance,
NPStream* stream,
NPReason reason);
[編集] パラメータ
この関数は以下のパラメータを取ります:
- instance
- 現在のインスタンスへのポインタ。
- stream
- 現在のストリームへのポインタ。
- reason
- ストリームが破棄された理由。 値:
- NPRES_DONE （最も一般的）: 正常終了; すべてのデータはインスタンスに送られました。
- NPRES_USER_BREAK: 中止ボタンを押して直接的に、あるいはインスタンスを削除したり高優先度のネットワーク操作を初期化するなどして間接的に、ユーザがストリームを取り消しました。
- NPRES_NETWORK_ERR: ネットワークやディスク I/O の問題、メモリ不足、その他の問題でストリームが失敗しました。
[編集] 戻り値
- 成功すれば、この関数は NPERR_NO_ERROR を返します。
- 失敗すれば、プラグインは読み込まれず、この関数はエラーコードを返します。取りうる値については、エラーコードを参照してください。
[編集] 説明
プラグインが正常終了するか不正終了するかしてプラグインが終了したときに、ブラウザは NPP_DestroyStream 関数を呼びます。この後に、ブラウザは NPStream オブジェクトを削除します。
このときに stream->pdata に割り当てたプライベートなデータをすべて削除すべきで、このストリームオブジェクトへのそれ以上の参照を作成するべきではありません。