ConfigDisplayFunc

BOOLEAN
ConfigDisplayFunc(
    PDEVICE_INFO pDevInfo,
    PCONFIG_INFO pConfig
    );

The ConfigDisplayFunc function sets characteristics of the overlay display. The function is provided by kernel-mode video capture drivers, and the ConfigDisplayFunc name is a placeholder for a driver-specified function name.

Parameters

pDevInfo

Pointer to the DEVICE_INFO structure returned by VC_Init.

pConfig

Pointer to a CONFIG_INFO structure.

Return Value

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

Comments

The VCKernel.lib library calls a kernel-mode driver’s ConfigDisplayFunc function when the driver receives an IOCTL_VIDC_CONFIG_DISPLAY control code. User-mode drivers using VCUser.lib send this control code by calling VC_ConfigDisplay.

A kernel-mode driver typically uses its ConfigDisplayFunc function to set display hardware parameters, based on information that the user-mode driver has provided in the CONFIG_INFO structure.

Support for a ConfigDisplayFunc function is required, if the device provides overlay capabilities. The driver must place the address of its ConfigDisplayFunc function in the VC_CALLBACK structure supplied by VCKernel.lib. If a driver that does not provide a ConfigDisplayFunc function receives an IOCTL_VIDC_CONFIG_DISPLAY control code, VCKernel.lib sets the Win32 error code value to STATUS_INVALID_DEVICE_REQUEST.