BOOLEAN
SetKeyPalIdxFunc(
PDEVICE_INFO pDevInfo,
ULONG palidx
);
The SetKeyPalIdxFunc function sets the overlay destination image’s key color to the specified palette index number. The function is provided by the kernel-mode driver, and the SetKeyPalIdxFunc name is a placeholder for a driver-specified function name.
Returns TRUE if the operation succeeds. Otherwise returns FALSE. If FALSE, VCKernel.lib sets the Win32 error code value to STATUS_DEVICE_CONFIGURATION_ERROR.
The VCKernel.lib library calls a kernel-mode driver’s SetKeyPalIdxFunc function when the driver receives an IOCTL_VIDC_SET_KEY_PALIDX control code. User-mode drivers using VCUser.lib send this control code by calling VC_SetKeyColourPalIdx.
You can assume that the driver’s SetKeyPalIdxFunc function will be called only if a previous call to its GetOverlayModeFunc function has returned with the VCO_KEYCOLOUR flag set and the VCO_KEYCOLOUR_RGB flag cleared.
Support for a SetKeyPalIdxFunc function is required, if the device supports a modifiable key color. 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 SetKeyPalIdxFunc function receives an IOCTL_VIDC_SET_KEY_PALIDX control code, VCKernel.lib sets the Win32 error code value to STATUS_INVALID_DEVICE_REQUEST.
For more information about palette index numbers, see VC_SetKeyColourPalIdx.