Edit

Share via

CBaseWindow.DoRealisePalette method

  • Article

[The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, IMFMediaEngine, and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

The DoRealisePalette method realizes the window's current palette.

Syntax

virtual HRESULT DoRealisePalette(
   BOOL bForceBackground
);

Parameters

bForceBackground

Boolean value that specifies whether the palette is forced to be a background palette. For more information, see SelectPalette in the Platform SDK.

Return value

Returns one of the HRESULT values shown in the following table.

Return code Description
S_FALSE
 An internal call to GdiFlush returned an error.
S_OK
 Success.

Remarks

The CBaseWindow::OnPaletteChange method calls this method. To set a new palette, call the CBaseWindow::SetPalette method.

Requirements

Requirement Value
Header
Winutil.h (include Streams.h)
Library
Strmbase.lib (retail builds);
Strmbasd.lib (debug builds)

See also

CBaseWindow Class