AVIBuildFilter

  • Article

The AVIBuildFilter function builds a filter specification that is subsequently used by the GetOpenFileName or GetSaveFileName function.

STDAPI AVIBuildFilter(
  LPTSTR lpszFilter,  
  LONG cbFilter,      
  BOOL fSaving        
);

Parameters

lpszFilter

Pointer to the buffer containing the filter string.

cbFilter

Size, in characters, of buffer pointed to by lpszFilter.

fSaving

Flag that indicates whether the filter should include read or write formats. Specify TRUE to include write formats or FALSE to include read formats.

Return Values

Returns AVIERR_OK if successful or an error otherwise. Possible error values include the following.

Value Description
AVIERR_BUFFERTOOSMALL The buffer size cbFilter was smaller than the generated filter specification.
AVIERR_MEMORY There was not enough memory to complete the read operation.

Remarks

This function accesses the registry for all filter types that the AVIFile library can use to open, read, or write multimedia files. It does not search the hard disk for filter DLLs and formats.

Requirements

**  Windows NT/2000/XP:** Included in Windows NT 3.1 and later.
**  Windows 95/98/Me:** Included in Windows 95 and later.
**  Header:** Declared in Vfw.h.
**  Library:** Use Vfw32.lib.
**  Unicode:** Implemented as Unicode and ANSI versions on Windows NT/2000/XP.

See Also

AVIFile Functions and Macros, AVIFile Functions, GetOpenFileName, GetSaveFileName