IOverlay::SetPalette
A version of this page is also available for
4/8/2010
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 Microsoft 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
| Windows Embedded CE | Windows CE 2.12 and later |
| Windows Mobile | Pocket PC for Windows Mobile Version 5.0 and later, Smartphone for Windows Mobile Version 5.0 and later |
| Note | Microsoft DirectShow applications and DirectShow filters have different include file and Library requirements For more information, see Setting Up the Build Environment, Version 2.12 requires DXPAK 1.0 or later |