StreamStopFunc

BOOLEAN
StreamStopFunc(
    PDEVICE_INFO
pDevInfo
    );

The StreamStopFunc function stops capturing frames for a capture stream. The function is provided by the kernel-mode driver, and the StreamStopFunc name is a placeholder for a driver-specified function name.

Parameters
pDevInfo
Pointer to the DEVICE_INFO structure returned by VC_Init.
Return Value

Returns TRUE if the operation succeeds. Otherwise returns FALSE. If FALSE, VCKernel.lib sets the Win32 error code value to STATUS_DRIVER_INTERNAL_ERROR.

Comments

The VCKernel.lib library calls a kernel-mode driver’s StreamStopFunc function when the driver receives an IOCTL_VIDC_STREAM_STOP control code. User-mode drivers using VCUser.lib send this control code by calling VC_StreamStop. You can assume VCKernel.lib will not call the StreamStopFunc function unless the driver’s StreamInitFunc function has been previously called.

The driver’s StreamStopFunc function must stop the stream, typically by disabling device interrupts.

Support for a StreamStopFunc function is required, if the device and driver support capture streams. If a driver does support the function, it must place its address in the VC_CALLBACK structure supplied by VCKernel.lib. If a driver that does not provide a StreamStopFunc function receives an IOCTL_VIDC_STREAM_STOP control code, VCKernel.lib sets the Win32 error code value to STATUS_INVALID_DEVICE_REQUEST.