Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

Retrieves the realized palette in the background flag.

Syntax 

HRESULT get_BackgroundPalette(
  long* 
pBackgroundPalette
);

Parameters

pBackgroundPalette

Automation Boolean flag (0 is off, –1 is on).

Return Value

Returns an HRESULTvalue.

Remarks

This member function implements the IVideoWindow::get_BackgroundPalettemethod.

If a video will be played within another application or document, the application might want to use its own palette. It can ask that the video use the current foreground palette rather than its own by setting this flag to –1.

If this is set to 0, the window will install and realize its own preferred palette.

Asking the window to use a different palette will cause severe performance penalties.

Requirements

Windows Embedded CE Windows CE 3.0 and later
Windows Mobile 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