Skip to content

Latest commit

 

History

History
123 lines (81 loc) · 4.04 KB

nf-vfw-avisavea.md

File metadata and controls

123 lines (81 loc) · 4.04 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:vfw.AVISaveA
AVISaveA function (vfw.h)
The AVISave function builds a file by combining data streams from other files or from memory. (ANSI)
AVISaveA
vfw/AVISaveA
multimedia\avisave.htm
Multimedia
44200871-541c-4d67-ba12-61af06da8788
12/05/2018
AVISave, AVISave function [Windows Multimedia], AVISaveA, AVISaveW, _win32_AVISave, multimedia.avisave, vfw/AVISave, vfw/AVISaveA, vfw/AVISaveW
vfw.h
Windows
Windows 2000 Professional [desktop apps only]
Windows 2000 Server [desktop apps only]
AVISaveW (Unicode) and AVISaveA (ANSI)
Vfw32.lib
Avifil32.dll
Windows
19H1
AVISaveA
vfw/AVISaveA
c++
APIRef
kbSyntax
DllExport
Avifil32.dll
AVISave
AVISaveA
AVISaveW

AVISaveA function

-description

The AVISave function builds a file by combining data streams from other files or from memory.

-parameters

-param szFile

Null-terminated string containing the name of the file to save.

-param pclsidHandler

Pointer to the file handler used to write the file. The file is created by calling the AVIFileOpen function using this handler. If a handler is not specified, a default is selected from the registry based on the file extension.

-param lpfnCallback

Pointer to a callback function for the save operation.

-param nStreams

Number of streams saved in the file.

-param pfile

Pointer to an AVI stream. This parameter is paired with lpOptions. The parameter pair can be repeated as a variable number of arguments.

-param lpOptions

Pointer to an application-defined AVICOMPRESSOPTIONS structure containing the compression options for the stream referenced by pavi. This parameter is paired with pavi. The parameter pair can be repeated as a variable number of arguments.

-param ...

-returns

Returns AVIERR_OK if successful or an error otherwise.

-remarks

This function creates a file, copies stream data into the file, closes the file, and releases the resources used by the new file. The last two parameters of this function identify a stream to save in the file and define the compression options of that stream. When saving more than one stream in an AVI file, repeat these two stream-specific parameters for each stream in the file.

A callback function (referenced by using lpfnCallback) can display status information and let the user cancel the save operation. The callback function uses the following format:

LONG PASCAL SaveCallback(int nPercent)  

The nPercent parameter specifies the percentage of the file saved.

The callback function should return AVIERR_OK if the operation should continue and AVIERR_USERABORT if the user wishes to abort the save operation.

The argument pavi is a pointer to an IAVIStream interface.

Note

The vfw.h header defines AVISave as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

-see-also

AVIFile Functions

AVIFile Functions and Macros