GetPaletteEntries

関数

論理パレットのエントリ情報を取得する。

DLLGDI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// GDI32.dll
#include <windows.h>

DWORD GetPaletteEntries(
    HPALETTE hpal,
    DWORD iStart,
    DWORD cEntries,
    PALETTEENTRY* pPalEntries   // optional
);

パラメーター

名前	型	方向	説明
hpal	HPALETTE	in	論理パレットへのハンドル。
iStart	DWORD	in	取得対象とする論理パレット内の最初のエントリ。
cEntries	DWORD	in	取得対象とする論理パレット内のエントリ数。
pPalEntries	PALETTEENTRY*	outoptional	パレットエントリを受け取る PALETTEENTRY 構造体の配列へのポインター。配列には、nEntries パラメーターで指定された数以上の構造体が含まれている必要があります。

戻り値の型: DWORD

公式ドキュメント

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

戻り値

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

関数が失敗した場合、戻り値は 0 です。

解説(Remarks)

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

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

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// GDI32.dll
#include <windows.h>

DWORD GetPaletteEntries(
    HPALETTE hpal,
    DWORD iStart,
    DWORD cEntries,
    PALETTEENTRY* pPalEntries   // optional
);

[DllImport("GDI32.dll", ExactSpelling = true)]
static extern uint GetPaletteEntries(
    IntPtr hpal,   // HPALETTE
    uint iStart,   // DWORD
    uint cEntries,   // DWORD
    IntPtr pPalEntries   // PALETTEENTRY* optional, out
);

<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function GetPaletteEntries(
    hpal As IntPtr,   ' HPALETTE
    iStart As UInteger,   ' DWORD
    cEntries As UInteger,   ' DWORD
    pPalEntries As IntPtr   ' PALETTEENTRY* optional, out
) As UInteger
End Function

' hpal : HPALETTE
' iStart : DWORD
' cEntries : DWORD
' pPalEntries : PALETTEENTRY* optional, out
Declare PtrSafe Function GetPaletteEntries Lib "gdi32" ( _
    ByVal hpal As LongPtr, _
    ByVal iStart As Long, _
    ByVal cEntries As Long, _
    ByVal pPalEntries As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetPaletteEntries = ctypes.windll.gdi32.GetPaletteEntries
GetPaletteEntries.restype = wintypes.DWORD
GetPaletteEntries.argtypes = [
    wintypes.HANDLE,  # hpal : HPALETTE
    wintypes.DWORD,  # iStart : DWORD
    wintypes.DWORD,  # cEntries : DWORD
    ctypes.c_void_p,  # pPalEntries : PALETTEENTRY* optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
GetPaletteEntries = Fiddle::Function.new(
  lib['GetPaletteEntries'],
  [
    Fiddle::TYPE_VOIDP,  # hpal : HPALETTE
    -Fiddle::TYPE_INT,  # iStart : DWORD
    -Fiddle::TYPE_INT,  # cEntries : DWORD
    Fiddle::TYPE_VOIDP,  # pPalEntries : PALETTEENTRY* optional, out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "gdi32")]
extern "system" {
    fn GetPaletteEntries(
        hpal: *mut core::ffi::c_void,  // HPALETTE
        iStart: u32,  // DWORD
        cEntries: u32,  // DWORD
        pPalEntries: *mut PALETTEENTRY  // PALETTEENTRY* optional, out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("GDI32.dll")]
public static extern uint GetPaletteEntries(IntPtr hpal, uint iStart, uint cEntries, IntPtr pPalEntries);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_GetPaletteEntries' -Namespace Win32 -PassThru
# $api::GetPaletteEntries(hpal, iStart, cEntries, pPalEntries)

#uselib "GDI32.dll"
#func global GetPaletteEntries "GetPaletteEntries" sptr, sptr, sptr, sptr
; GetPaletteEntries hpal, iStart, cEntries, varptr(pPalEntries)   ; 戻り値は stat
; hpal : HPALETTE -> "sptr"
; iStart : DWORD -> "sptr"
; cEntries : DWORD -> "sptr"
; pPalEntries : PALETTEENTRY* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "GDI32.dll"
#cfunc global GetPaletteEntries "GetPaletteEntries" sptr, int, int, var
; res = GetPaletteEntries(hpal, iStart, cEntries, pPalEntries)
; hpal : HPALETTE -> "sptr"
; iStart : DWORD -> "int"
; cEntries : DWORD -> "int"
; pPalEntries : PALETTEENTRY* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "GDI32.dll"
#cfunc global GetPaletteEntries "GetPaletteEntries" sptr, int, int, sptr
; res = GetPaletteEntries(hpal, iStart, cEntries, varptr(pPalEntries))
; hpal : HPALETTE -> "sptr"
; iStart : DWORD -> "int"
; cEntries : DWORD -> "int"
; pPalEntries : PALETTEENTRY* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。