Edit

IBasicVideo::GetVideoPaletteEntries method (control.h)

  • 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 GetVideoPaletteEntries method retrieves the palette colors for the video.

Syntax

HRESULT GetVideoPaletteEntries(
  [in]  long StartIndex,
  [in]  long Entries,
  [out] long *pRetrieved,
  [out] long *pPalette
);

Parameters

[in] StartIndex

Start index for the palette.

[in] Entries

Number of palette entries to retrieve.

[out] pRetrieved

Pointer to a variable that receives the number of entries returned in pPallette.

[out] pPalette

Pointer to an array of PALETTEENTRY structures of size Entries. Cast the pointer to a long pointer type. The method fills the array.

Return value

Returns an HRESULT value. Possible values include the following.

Return code Description
S_OK
 Success.
E_POINTER
 NULL pointer argument.
VFW_E_NO_PALETTE_AVAILABLE
 No palette is available.
VFW_E_NOT_CONNECTED
 The Video Renderer's input pin is not connected.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header control.h (include Dshow.h)
Library Strmiids.lib

See also

Error and Success Codes

IBasicVideo Interface