CreateEnhMetaFileW

関数

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

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

シグネチャ

// GDI32.dll  (Unicode / -W)
#include <windows.h>

HDC CreateEnhMetaFileW(
    HDC hdc,   // optional
    LPCWSTR lpFilename,   // optional
    const RECT* lprc,   // optional
    LPCWSTR lpDesc   // optional
);

パラメーター

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

戻り値の型: HDC

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

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

システムは、hdc パラメーターで識別される参照デバイスを使用して、図が元々表示されたデバイスの解像度と単位を記録します。hdc パラメーターが NULL の場合は、現在のディスプレイデバイスが参照として使用されます。

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

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

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

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

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

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

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

例

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

メモ

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

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

各言語での呼び出し定義

// GDI32.dll  (Unicode / -W)
#include <windows.h>

HDC CreateEnhMetaFileW(
    HDC hdc,   // optional
    LPCWSTR lpFilename,   // optional
    const RECT* lprc,   // optional
    LPCWSTR lpDesc   // optional
);

[DllImport("GDI32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern IntPtr CreateEnhMetaFileW(
    IntPtr hdc,   // HDC optional
    [MarshalAs(UnmanagedType.LPWStr)] string lpFilename,   // LPCWSTR optional
    IntPtr lprc,   // RECT* optional
    [MarshalAs(UnmanagedType.LPWStr)] string lpDesc   // LPCWSTR optional
);

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

' hdc : HDC optional
' lpFilename : LPCWSTR optional
' lprc : RECT* optional
' lpDesc : LPCWSTR optional
Declare PtrSafe Function CreateEnhMetaFileW Lib "gdi32" ( _
    ByVal hdc As LongPtr, _
    ByVal lpFilename As LongPtr, _
    ByVal lprc As LongPtr, _
    ByVal lpDesc As LongPtr) As LongPtr
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
CreateEnhMetaFileW = Fiddle::Function.new(
  lib['CreateEnhMetaFileW'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC optional
    Fiddle::TYPE_VOIDP,  # lpFilename : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # lprc : RECT* optional
    Fiddle::TYPE_VOIDP,  # lpDesc : LPCWSTR optional
  ],
  Fiddle::TYPE_VOIDP)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

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

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

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

出力引数:

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