Microsoft DirectX 8.1 (C++)

IBasicVideo::GetVideoPaletteEntries

The GetVideoPaletteEntries method retrieves the palette colors for the video.

Syntax

HRESULT GetVideoPaletteEntries(
  long StartIndex,
  long Entries,
  long *pRetrieved,
  long *pPalette
);

Parameters

StartIndex

[in] Start index for the palette.

Entries

[in] Number of palette entries to retrieve.

pRetrieved

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

pPalette

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

Return Values

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.

See Also