CAPERRORCALLBACKA callback function (vfw.h)

Article
07/27/2022

The capErrorCallback function is the error callback function used with video capture. The name capErrorCallback is a placeholder for the application-supplied function name.

To set the callback, send the WM_CAP_SET_CALLBACK_ERROR message to the capture window or call the capSetCallbackOnError macro.

Syntax

CAPERRORCALLBACKA Caperrorcallbacka;

LRESULT Caperrorcallbacka(
  HWND hWnd,
  int nID,
  LPCSTR lpsz
)
{...}

Parameters

hWnd

Handle to the capture window associated with the callback function.

nID

Error identification number.

lpsz

Pointer to a textual description of the returned error.

Return value

None

Remarks

A message identifier of zero indicates a new operation is starting and the callback function should clear the current error.

Note

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