GetPaletteEntries 関数 (wingdi.h)

GetPaletteEntries 関数は、指定された論理パレットから指定した範囲のパレット エントリを取得します。

構文

UINT GetPaletteEntries(
  [in]  HPALETTE       hpal,
  [in]  UINT           iStart,
  [in]  UINT           cEntries,
  [out] LPPALETTEENTRY pPalEntries
);

パラメーター

[in] hpal

論理パレットへのハンドル。

[in] iStart

取得する論理パレット内の最初のエントリ。

[in] cEntries

取得する論理パレット内のエントリの数。

[out] pPalEntries

パレット エントリを受け取る PALETTEENTRY 構造体の配列へのポインター。 配列には、 nEntries パラメーターで指定された数以上の構造体が含まれている必要があります。

戻り値

関数が成功し、論理パレットへのハンドルが有効なポインター (NULL ではない) である場合、戻り値は論理パレットから取得されたエントリの数です。 関数が成功し、論理パレットへの処理が NULL の場合、戻り値は指定されたパレット内のエントリの数になります。

関数が失敗した場合は、0 を返します。

解説

アプリケーションは、 GetDeviceCaps 関数を呼び出し、RASTERCAPS 定数を指定することで、デバイスがパレット操作をサポートしているかどうかを判断できます。

nEntries パラメーターがパレット内に存在する数より多くの項目を指定した場合、PALETTEENTRY 構造体の残りのメンバーは変更されません。

要件

サポートされている最小のクライアント	Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー	Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム	Windows
ヘッダー	wingdi.h (Windows.h を含む)
Library	Gdi32.lib
[DLL]	Gdi32.dll

関連項目

カラー関数

色の概要

GetDeviceCaps

GetSystemPaletteEntries

PALETTEENTRY

SetPaletteEntries