IMSVidCtl::get_ColorKey Method

This topic applies to Windows XP or later.
The get_ColorKey method retrieves the color key that the video renderer is using.

Syntax

HRESULT get_ColorKey(
  [out]   *pCurrentValue
);

Parameters

• pCurrentValue [out]
  Pointer to a variable that receives an OLE_COLOR value.

Return Value

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

The color key is used when the video renderer draws to an overlay surface.

Examples

OLE_COLOR ocKey;
COLORREF clrKey;
pVideoControl->get_ColorKey(&ocKey);
OleTranslateColor(ocKey, 0, &clrKey);

Requirements

See Also

IMSVidCtl Interface
IMSVidCtl::put_ColorKey
IVMRWindowlessControl::GetColorKey

Send comments about this topic to Microsoft

Build date: 12/4/2008