ホーム › Graphics.Gdi › GetEnhMetaFilePaletteEntries

GetEnhMetaFilePaletteEntries

関数

拡張メタファイルのパレットエントリを取得する。

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

シグネチャ

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

DWORD GetEnhMetaFilePaletteEntries(
    HENHMETAFILE hemf,
    DWORD nNumEntries,
    PALETTEENTRY* lpPaletteEntries   // optional
);

パラメーター

名前	型	方向	説明
hemf	HENHMETAFILE	in	拡張メタファイルへのハンドルです。
nNumEntries	DWORD	in	オプションのパレットから取得するエントリの数です。
lpPaletteEntries	PALETTEENTRY*	outoptional	パレットの色を受け取る PALETTEENTRY 構造体の配列へのポインターです。この配列には、少なくとも cEntries パラメーターで指定されたエントリ数と同じ数の構造体が含まれている必要があります。

戻り値の型: DWORD

公式ドキュメント

GetEnhMetaFilePaletteEntries 関数は、指定された拡張メタファイルからオプションのパレットエントリを取得します。

戻り値

配列ポインターが NULL で、拡張メタファイルにオプションのパレットが含まれている場合、戻り値は拡張メタファイルのパレット内のエントリ数です。配列ポインターが有効なポインターで、拡張メタファイルにオプションのパレットが含まれている場合、戻り値はコピーされたエントリ数です。メタファイルにオプションのパレットが含まれていない場合、戻り値は 0 です。それ以外の場合、戻り値は GDI_ERROR です。

解説(Remarks)

アプリケーションは、画像を作成してメタファイルに格納する前に CreatePalette 関数および SetPaletteEntries 関数を呼び出すことで、オプションのパレットを拡張メタファイルに格納できます。これにより、画像をさまざまなデバイスで表示する際に一貫した色を実現できます。

拡張メタファイルに格納された画像を表示するアプリケーションは、GetEnhMetaFilePaletteEntries 関数を呼び出して、オプションのパレットが存在するかどうかを判断できます。存在する場合、アプリケーションは GetEnhMetaFilePaletteEntries 関数をもう一度呼び出してパレットエントリを取得し、論理パレットを作成して(CreatePalette 関数を使用)、デバイスコンテキストに選択し(SelectPalette 関数を使用)、それを実現できます(RealizePalette 関数を使用)。論理パレットが実現された後、PlayEnhMetaFile 関数を呼び出すと、画像が元の色で表示されます。

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

各言語での呼び出し定義

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

DWORD GetEnhMetaFilePaletteEntries(
    HENHMETAFILE hemf,
    DWORD nNumEntries,
    PALETTEENTRY* lpPaletteEntries   // optional
);

[DllImport("GDI32.dll", ExactSpelling = true)]
static extern uint GetEnhMetaFilePaletteEntries(
    IntPtr hemf,   // HENHMETAFILE
    uint nNumEntries,   // DWORD
    IntPtr lpPaletteEntries   // PALETTEENTRY* optional, out
);

<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function GetEnhMetaFilePaletteEntries(
    hemf As IntPtr,   ' HENHMETAFILE
    nNumEntries As UInteger,   ' DWORD
    lpPaletteEntries As IntPtr   ' PALETTEENTRY* optional, out
) As UInteger
End Function

' hemf : HENHMETAFILE
' nNumEntries : DWORD
' lpPaletteEntries : PALETTEENTRY* optional, out
Declare PtrSafe Function GetEnhMetaFilePaletteEntries Lib "gdi32" ( _
    ByVal hemf As LongPtr, _
    ByVal nNumEntries As Long, _
    ByVal lpPaletteEntries As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetEnhMetaFilePaletteEntries = ctypes.windll.gdi32.GetEnhMetaFilePaletteEntries
GetEnhMetaFilePaletteEntries.restype = wintypes.DWORD
GetEnhMetaFilePaletteEntries.argtypes = [
    wintypes.HANDLE,  # hemf : HENHMETAFILE
    wintypes.DWORD,  # nNumEntries : DWORD
    ctypes.c_void_p,  # lpPaletteEntries : PALETTEENTRY* optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
GetEnhMetaFilePaletteEntries = Fiddle::Function.new(
  lib['GetEnhMetaFilePaletteEntries'],
  [
    Fiddle::TYPE_VOIDP,  # hemf : HENHMETAFILE
    -Fiddle::TYPE_INT,  # nNumEntries : DWORD
    Fiddle::TYPE_VOIDP,  # lpPaletteEntries : PALETTEENTRY* optional, out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "gdi32")]
extern "system" {
    fn GetEnhMetaFilePaletteEntries(
        hemf: *mut core::ffi::c_void,  // HENHMETAFILE
        nNumEntries: u32,  // DWORD
        lpPaletteEntries: *mut PALETTEENTRY  // PALETTEENTRY* optional, out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("GDI32.dll")]
public static extern uint GetEnhMetaFilePaletteEntries(IntPtr hemf, uint nNumEntries, IntPtr lpPaletteEntries);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_GetEnhMetaFilePaletteEntries' -Namespace Win32 -PassThru
# $api::GetEnhMetaFilePaletteEntries(hemf, nNumEntries, lpPaletteEntries)

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

出力引数:

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