Share via

IOverlay::SetPalette (Compact 2013)

  • Article

3/26/2014

This method sets the palette.

Syntax

HRESULT SetPalette(
  DWORD dwColors,
  PALETTEENTRY* pPalette
);

Parameters

  • dwColors
    [in] Number of colors present.
  • pPalette
    [in] A PALETTEENTRY value that represents the colors to use for the palette.

Return Value

Returns an HRESULT value that depends on the implementation.

HRESULT can be one of the following standard constants, or other values not listed.

Value

Description

E_FAIL

Failure.

E_POINTER

Null pointer argument.

E_INVALIDARG

Invalid argument.

E_NOTIMPL

Method is not supported.

S_OK or NOERROR

Success.

Remarks

This method sets a logical palette for the window.

The window is not guaranteed to have the colors requested in the actual system device palette. The Windows operating system only guarantees those colors when the window is the foreground active window.

The current device palette can be obtained by calling IOverlay::GetPalette.

If the device does not have a palette, it returns VFW_E_NO_DISPLAY_PALETTE.

Requirements

Header

dshow.h

Library

Strmiids.lib

See Also

Reference

IOverlay Interface