« Gecko Plugin API Reference « Plug-in Side Plug-in API
Summary
Provides a local file name for the data from a stream.
Syntax
#include <npapi.h>
void NPP_StreamAsFile(NPP instance,
NPStream* stream,
const char* fname);
Parameters
The function has the following parameters:
- instance
- Pointer to current plug-in instance.
- stream
- Pointer to current stream.
- fname
- Pointer to full path to a local file. If an error occurs while retrieving the data or writing the file, fname may be null.
Description
When the stream is complete, the browser calls NPP_StreamAsFile to provide the instance with a full path name for a local file for the stream. NPP_StreamAsFile is called for streams whose mode is set to NP_ASFILEONLY or NP_ASFILE only in a previous call to NPP_NewStream.
If an error occurs while retrieving the data or writing the file, the file name (fname) is null.