AVISaveOptions function (vfw.h)

Article
10/05/2021

The AVISaveOptions function retrieves the save options for a file and returns them in a buffer.

Syntax

INT_PTR AVISaveOptions(
  HWND                 hwnd,
  UINT                 uiFlags,
  int                  nStreams,
  PAVISTREAM           *ppavi,
  LPAVICOMPRESSOPTIONS *plpOptions
);

Parameters

hwnd

Handle to the parent window for the Compression Options dialog box.

uiFlags

Flags for displaying the Compression Options dialog box. The following flags are defined.

Value	Meaning
ICMF_CHOOSE_KEYFRAME	Displays a Key Frame Every dialog box for the video options. This is the same flag used in the ICCompressorChoose function.
ICMF_CHOOSE_DATARATE	Displays a Data Rate dialog box for the video options. This is the same flag used in ICCompressorChoose.
ICMF_CHOOSE_PREVIEW	Displays a Preview button for the video options. This button previews the compression by using a frame from the stream. This is the same flag used in ICCompressorChoose.

nStreams

Number of streams that have their options set by the dialog box.

ppavi

Pointer to an array of stream interface pointers. The nStreams parameter indicates the number of pointers in the array.

plpOptions

Pointer to an array of pointers to AVICOMPRESSOPTIONS structures. These structures hold the compression options set by the dialog box. The nStreams parameter indicates the number of pointers in the array.

Return value

Returns TRUE if the user pressed OK, FALSE for CANCEL, or an error otherwise.

Remarks

This function presents a standard Compression Options dialog box using hwnd as the parent window handle. When the user is finished selecting the compression options for each stream, the options are returned in the AVICOMPRESSOPTIONS structure in the array referenced by plpOptions. The calling application must pass the interface pointers for the streams in the array referenced by ppavi.

An application must allocate memory for the AVICOMPRESSOPTIONS structures and the array of pointers to these structures.

The argument ppavi contains the address of a pointer to an IAVIStream interface.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	vfw.h
Library	Vfw32.lib
DLL	Avifil32.dll