CreateEnhMetaFileA

関数

拡張メタファイル記録用のデバイスコンテキストを作成する(ANSI版)。

DLLGDI32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// GDI32.dll  (ANSI / -A)
#include <windows.h>

HDC CreateEnhMetaFileA(
    HDC hdc,   // optional
    LPCSTR lpFilename,   // optional
    const RECT* lprc,   // optional
    LPCSTR lpDesc   // optional
);

パラメーター

名前	型	方向	説明
hdc	HDC	inoptional	拡張メタファイルの参照デバイスへのハンドル。このパラメーターは NULL にできます。詳細については「解説」を参照してください。
lpFilename	LPCSTR	inoptional	作成する拡張メタファイルのファイル名へのポインター。このパラメーターが NULL の場合、拡張メタファイルはメモリベースとなり、DeleteEnhMetaFile 関数で削除されると、その内容は失われます。
lprc	RECT*	inoptional	拡張メタファイルに格納する画像の寸法(0.01 ミリメートル単位)を指定する RECT 構造体へのポインター。
lpDesc	LPCSTR	inoptional	画像を作成したアプリケーションの名前および画像のタイトルを指定する文字列へのポインター。このパラメーターは NULL にできます。詳細については「解説」を参照してください。

戻り値の型: HDC

公式ドキュメント

CreateEnhMetaFile 関数は、拡張形式メタファイル用のデバイスコンテキストを作成します。このデバイスコンテキストは、デバイスに依存しない画像を格納するために使用できます。(ANSI)

戻り値

関数が成功すると、戻り値は拡張メタファイル用のデバイスコンテキストへのハンドルになります。

関数が失敗すると、戻り値は NULL になります。

解説(Remarks)

テキスト引数に Unicode 文字を使用する必要がある場合は、CreateEnhMetaFile 関数をワイド文字版として使用します。テキスト引数に Windows 文字セットの文字を使用する必要がある場合は、この関数を ANSI 版として使用します。

システムは、hdcRef パラメーターで指定された参照デバイスを使用して、画像が元々表示されたデバイスの解像度と単位を記録します。hdcRef パラメーターが NULL の場合は、現在の表示デバイスが参照として使用されます。

lpRect パラメーターが指す RECT 構造体の left および top メンバーは、それぞれ right および bottom メンバーより小さくなければなりません。四角形の辺上の点は画像に含まれます。lpRect が NULL の場合、グラフィックスデバイスインターフェイス (GDI) は、アプリケーションが描画した画像を囲む最小の四角形の寸法を計算します。lpRect パラメーターは可能な限り指定してください。

lpDescription パラメーターが指す文字列は、アプリケーション名と画像名の間に null 文字を含み、2 つの null 文字で終了する必要があります。たとえば "XYZ Graphics Editor\0Bald Eagle\0\0" のようになり、ここで \0 は null 文字を表します。lpDescription が NULL の場合、拡張メタファイルヘッダーに対応するエントリは作成されません。

アプリケーションは、この関数で作成したデバイスコンテキストを使用して、グラフィックス画像を拡張メタファイルに格納します。このデバイスコンテキストを識別するハンドルは、任意の GDI 関数に渡すことができます。

アプリケーションが画像を拡張メタファイルに格納した後は、PlayEnhMetaFile 関数を呼び出すことで、その画像を任意の出力デバイスに表示できます。画像を表示する際、システムは lpRect パラメーターが指す四角形と参照デバイスの解像度データを使用して、画像の位置とスケールを決定します。

この関数が返すデバイスコンテキストには、新しいデバイスコンテキストに関連付けられるものと同じ既定の属性が含まれます。

アプリケーションは、拡張メタファイルを古い Windows メタファイル形式に変換するために、GetWinMetaFileBits 関数を使用する必要があります。

拡張メタファイルのファイル名には .emf 拡張子を使用してください。

例

例については「Creating an Enhanced Metafile」を参照してください。

メモ

wingdi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして CreateEnhMetaFile を定義します。エンコーディング中立のエイリアスの使用と、エンコーディング中立でないコードを混在させると、不一致が生じてコンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については「Conventions for Function Prototypes」を参照してください。

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

各言語での呼び出し定義

// GDI32.dll  (ANSI / -A)
#include <windows.h>

HDC CreateEnhMetaFileA(
    HDC hdc,   // optional
    LPCSTR lpFilename,   // optional
    const RECT* lprc,   // optional
    LPCSTR lpDesc   // optional
);

[DllImport("GDI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern IntPtr CreateEnhMetaFileA(
    IntPtr hdc,   // HDC optional
    [MarshalAs(UnmanagedType.LPStr)] string lpFilename,   // LPCSTR optional
    IntPtr lprc,   // RECT* optional
    [MarshalAs(UnmanagedType.LPStr)] string lpDesc   // LPCSTR optional
);

<DllImport("GDI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function CreateEnhMetaFileA(
    hdc As IntPtr,   ' HDC optional
    <MarshalAs(UnmanagedType.LPStr)> lpFilename As String,   ' LPCSTR optional
    lprc As IntPtr,   ' RECT* optional
    <MarshalAs(UnmanagedType.LPStr)> lpDesc As String   ' LPCSTR optional
) As IntPtr
End Function

' hdc : HDC optional
' lpFilename : LPCSTR optional
' lprc : RECT* optional
' lpDesc : LPCSTR optional
Declare PtrSafe Function CreateEnhMetaFileA Lib "gdi32" ( _
    ByVal hdc As LongPtr, _
    ByVal lpFilename As String, _
    ByVal lprc As LongPtr, _
    ByVal lpDesc As String) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CreateEnhMetaFileA = ctypes.windll.gdi32.CreateEnhMetaFileA
CreateEnhMetaFileA.restype = ctypes.c_void_p
CreateEnhMetaFileA.argtypes = [
    wintypes.HANDLE,  # hdc : HDC optional
    wintypes.LPCSTR,  # lpFilename : LPCSTR optional
    ctypes.c_void_p,  # lprc : RECT* optional
    wintypes.LPCSTR,  # lpDesc : LPCSTR optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
CreateEnhMetaFileA = Fiddle::Function.new(
  lib['CreateEnhMetaFileA'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC optional
    Fiddle::TYPE_VOIDP,  # lpFilename : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # lprc : RECT* optional
    Fiddle::TYPE_VOIDP,  # lpDesc : LPCSTR optional
  ],
  Fiddle::TYPE_VOIDP)

#[link(name = "gdi32")]
extern "system" {
    fn CreateEnhMetaFileA(
        hdc: *mut core::ffi::c_void,  // HDC optional
        lpFilename: *const u8,  // LPCSTR optional
        lprc: *const RECT,  // RECT* optional
        lpDesc: *const u8  // LPCSTR optional
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("GDI32.dll", CharSet = CharSet.Ansi)]
public static extern IntPtr CreateEnhMetaFileA(IntPtr hdc, [MarshalAs(UnmanagedType.LPStr)] string lpFilename, IntPtr lprc, [MarshalAs(UnmanagedType.LPStr)] string lpDesc);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_CreateEnhMetaFileA' -Namespace Win32 -PassThru
# $api::CreateEnhMetaFileA(hdc, lpFilename, lprc, lpDesc)

#uselib "GDI32.dll"
#func global CreateEnhMetaFileA "CreateEnhMetaFileA" sptr, sptr, sptr, sptr
; CreateEnhMetaFileA hdc, lpFilename, varptr(lprc), lpDesc   ; 戻り値は stat
; hdc : HDC optional -> "sptr"
; lpFilename : LPCSTR optional -> "sptr"
; lprc : RECT* optional -> "sptr"
; lpDesc : LPCSTR optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "GDI32.dll"
#cfunc global CreateEnhMetaFileA "CreateEnhMetaFileA" sptr, str, var, str
; res = CreateEnhMetaFileA(hdc, lpFilename, lprc, lpDesc)
; hdc : HDC optional -> "sptr"
; lpFilename : LPCSTR optional -> "str"
; lprc : RECT* optional -> "var"
; lpDesc : LPCSTR optional -> "str"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "GDI32.dll"
#cfunc global CreateEnhMetaFileA "CreateEnhMetaFileA" sptr, str, sptr, str
; res = CreateEnhMetaFileA(hdc, lpFilename, varptr(lprc), lpDesc)
; hdc : HDC optional -> "sptr"
; lpFilename : LPCSTR optional -> "str"
; lprc : RECT* optional -> "sptr"
; lpDesc : LPCSTR optional -> "str"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。