GetDIBColorTable

関数

DIBセクションのカラーテーブルからRGB値を取得する。

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

シグネチャ

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

DWORD GetDIBColorTable(
    HDC hdc,
    DWORD iStart,
    DWORD cEntries,
    RGBQUAD* prgbq
);

パラメーター

名前	型	方向	説明
hdc	HDC	in	デバイスコンテキストへのハンドル。このデバイスコンテキストには DIB セクションビットマップが選択されている必要があります。
iStart	DWORD	in	取得を開始する最初のカラーテーブルエントリを指定する、ゼロから始まるカラーテーブルのインデックス。
cEntries	DWORD	in	取得するカラーテーブルエントリの数。
prgbq	RGBQUAD*	out	DIB カラーテーブルのカラー情報を格納した RGBQUAD データ構造体の配列を受け取るバッファーへのポインター。このバッファーは、cEntries の値と同じ数の RGBQUAD データ構造体を格納できる十分な大きさである必要があります。

戻り値の型: DWORD

公式ドキュメント

GetDIBColorTable 関数は、指定したデバイスコンテキストに現在選択されている DIB セクションビットマップのカラーテーブルにおいて、ある範囲のエントリから RGB (赤、緑、青) のカラー値を取得します。

戻り値

関数が成功した場合、戻り値は関数が取得したカラーテーブルエントリの数です。

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

解説(Remarks)

GetDIBColorTable 関数は、1、4、または 8 bpp を使用する DIB セクションビットマップのカラーテーブルを取得するために呼び出します。ビットマップに関連付けられた BITMAPINFOHEADER 構造体の biBitCount メンバーは、1 ピクセルあたりのビット数を指定します。biBitCount 値が 8 より大きい DIB セクションビットマップにはカラーテーブルはありませんが、関連付けられたカラーマスクを持ちます。これらのカラーマスクを取得するには、GetObject 関数を呼び出してください。

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

各言語での呼び出し定義

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

DWORD GetDIBColorTable(
    HDC hdc,
    DWORD iStart,
    DWORD cEntries,
    RGBQUAD* prgbq
);

[DllImport("GDI32.dll", ExactSpelling = true)]
static extern uint GetDIBColorTable(
    IntPtr hdc,   // HDC
    uint iStart,   // DWORD
    uint cEntries,   // DWORD
    IntPtr prgbq   // RGBQUAD* out
);

<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function GetDIBColorTable(
    hdc As IntPtr,   ' HDC
    iStart As UInteger,   ' DWORD
    cEntries As UInteger,   ' DWORD
    prgbq As IntPtr   ' RGBQUAD* out
) As UInteger
End Function

' hdc : HDC
' iStart : DWORD
' cEntries : DWORD
' prgbq : RGBQUAD* out
Declare PtrSafe Function GetDIBColorTable Lib "gdi32" ( _
    ByVal hdc As LongPtr, _
    ByVal iStart As Long, _
    ByVal cEntries As Long, _
    ByVal prgbq As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetDIBColorTable = ctypes.windll.gdi32.GetDIBColorTable
GetDIBColorTable.restype = wintypes.DWORD
GetDIBColorTable.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    wintypes.DWORD,  # iStart : DWORD
    wintypes.DWORD,  # cEntries : DWORD
    ctypes.c_void_p,  # prgbq : RGBQUAD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
GetDIBColorTable = Fiddle::Function.new(
  lib['GetDIBColorTable'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    -Fiddle::TYPE_INT,  # iStart : DWORD
    -Fiddle::TYPE_INT,  # cEntries : DWORD
    Fiddle::TYPE_VOIDP,  # prgbq : RGBQUAD* out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "gdi32")]
extern "system" {
    fn GetDIBColorTable(
        hdc: *mut core::ffi::c_void,  // HDC
        iStart: u32,  // DWORD
        cEntries: u32,  // DWORD
        prgbq: *mut RGBQUAD  // RGBQUAD* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

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

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

出力引数:

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