IOverlay::GetPalette method (strmif.h)

[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 GetPalette method retrieves the current system palette.

Syntax

HRESULT GetPalette(
  [out] DWORD        *pdwColors,
  [out] PALETTEENTRY **ppPalette
);

Parameters

[out] pdwColors

Pointer to a variable that receives the number of colors present.

[out] ppPalette

Receives a pointer to a PALETTEENTRY structure describing the palette.

Return value

Returns S_OK if successful. If the method fails, it returns an HRESULT error code.

Requirements

See also

Error and Success Codes

IOverlay Interface