GetEnhMetaFileBits

関数

拡張メタファイルの内容をバッファにコピーする。

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

シグネチャ

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

DWORD GetEnhMetaFileBits(
    HENHMETAFILE hEMF,
    DWORD nSize,
    BYTE* lpData   // optional
);

パラメーター

名前	型	方向	説明
hEMF	HENHMETAFILE	in	拡張メタファイルへのハンドル。
nSize	DWORD	in	データを受け取るバッファーのサイズ (バイト単位)。
lpData	BYTE*	outoptional	メタファイルデータを受け取るバッファーへのポインター。バッファーはデータを格納するのに十分な大きさである必要があります。lpbBuffer が NULL の場合、関数はデータの格納に必要なサイズを返します。

戻り値の型: DWORD

公式ドキュメント

GetEnhMetaFileBits 関数は、指定された拡張形式メタファイルの内容を取得し、バッファーにコピーします。

戻り値

関数が成功し、バッファーポインターが NULL の場合、戻り値は拡張メタファイルのサイズ (バイト単位) です。

関数が成功し、バッファーポインターが有効なポインターの場合、戻り値はバッファーにコピーされたバイト数です。

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

解説(Remarks)

拡張メタファイルのビットを取得した後、SetEnhMetaFileBits 関数を呼び出すことで、それらを使用してメモリベースのメタファイルを作成できます。

GetEnhMetaFileBits 関数は、拡張メタファイルのハンドルを無効にしません。アプリケーションは、ハンドルが不要になったときに DeleteEnhMetaFile 関数を呼び出してハンドルを削除する必要があります。

この関数によって取得されるメタファイルの内容は、拡張形式です。メタファイルの内容を Windows 形式で取得するには、GetWinMetaFileBits 関数を使用します。

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

各言語での呼び出し定義

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

DWORD GetEnhMetaFileBits(
    HENHMETAFILE hEMF,
    DWORD nSize,
    BYTE* lpData   // optional
);

[DllImport("GDI32.dll", ExactSpelling = true)]
static extern uint GetEnhMetaFileBits(
    IntPtr hEMF,   // HENHMETAFILE
    uint nSize,   // DWORD
    IntPtr lpData   // BYTE* optional, out
);

<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function GetEnhMetaFileBits(
    hEMF As IntPtr,   ' HENHMETAFILE
    nSize As UInteger,   ' DWORD
    lpData As IntPtr   ' BYTE* optional, out
) As UInteger
End Function

' hEMF : HENHMETAFILE
' nSize : DWORD
' lpData : BYTE* optional, out
Declare PtrSafe Function GetEnhMetaFileBits Lib "gdi32" ( _
    ByVal hEMF As LongPtr, _
    ByVal nSize As Long, _
    ByVal lpData As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetEnhMetaFileBits = ctypes.windll.gdi32.GetEnhMetaFileBits
GetEnhMetaFileBits.restype = wintypes.DWORD
GetEnhMetaFileBits.argtypes = [
    wintypes.HANDLE,  # hEMF : HENHMETAFILE
    wintypes.DWORD,  # nSize : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # lpData : BYTE* optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
GetEnhMetaFileBits = Fiddle::Function.new(
  lib['GetEnhMetaFileBits'],
  [
    Fiddle::TYPE_VOIDP,  # hEMF : HENHMETAFILE
    -Fiddle::TYPE_INT,  # nSize : DWORD
    Fiddle::TYPE_VOIDP,  # lpData : BYTE* optional, out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "gdi32")]
extern "system" {
    fn GetEnhMetaFileBits(
        hEMF: *mut core::ffi::c_void,  // HENHMETAFILE
        nSize: u32,  // DWORD
        lpData: *mut u8  // BYTE* optional, out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("GDI32.dll")]
public static extern uint GetEnhMetaFileBits(IntPtr hEMF, uint nSize, IntPtr lpData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_GetEnhMetaFileBits' -Namespace Win32 -PassThru
# $api::GetEnhMetaFileBits(hEMF, nSize, lpData)

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

出力引数:

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