EditStreamSetNameW function (vfw.h)

Article
02/22/2024

The EditStreamSetName function assigns a descriptive string to a stream.

Syntax

HRESULT EditStreamSetNameW(
  PAVISTREAM pavi,
  LPCWSTR    lpszName
);

Parameters

pavi

Handle to an open stream.

lpszName

Null-terminated string containing the description of the stream.

Return value

Returns zero if successful or an error otherwise.

Remarks

This function updates the szName member of the AVISTREAMINFO structure.

Note

The vfw.h header defines EditStreamSetName 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.

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