Win32 API 日本語リファレンス
ホームGraphics.Gdi › PlayEnhMetaFile

PlayEnhMetaFile

関数
拡張メタファイルを指定矩形内に再生して描画する。
DLLGDI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

BOOL PlayEnhMetaFile(
    HDC hdc,
    HENHMETAFILE hmf,
    const RECT* lprect
);

パラメーター

名前方向説明
hdcHDCin図を表示する出力デバイスのデバイスコンテキストへのハンドル。
hmfHENHMETAFILEin拡張メタファイルへのハンドル。
lprectRECT*in図の表示に使用される境界矩形の座標を含む RECT 構造体へのポインター。座標は論理単位で指定します。

戻り値の型: BOOL

公式ドキュメント

PlayEnhMetaFile 関数は、指定された拡張形式メタファイルに格納されている図を表示します。

戻り値

関数が成功した場合、戻り値は 0 以外です。

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

解説(Remarks)

アプリケーションが PlayEnhMetaFile 関数を呼び出すと、システムは拡張メタファイルヘッダー内のピクチャフレームを使用して、図を lpRect パラメーターが指す矩形にマッピングします。(PlayEnhMetaFile を呼び出す前に出力デバイスでワールド変換を設定することで、この図をせん断したり回転させたりできます。)矩形の辺上の点は図に含まれます。

拡張メタファイルの図は、拡張メタファイルを再生する前に出力デバイスでクリッピング領域を定義することにより、クリップできます。

拡張メタファイルにオプションのパレットが含まれている場合、アプリケーションは PlayEnhMetaFile を呼び出す前に出力デバイスでカラーパレットを設定することで、一貫した色を実現できます。オプションのパレットを取得するには、GetEnhMetaFilePaletteEntries 関数を使用します。

PlayEnhMetaFile を呼び出し、ソースとなる拡張メタファイルを新しい拡張メタファイルのデバイスコンテキストに再生することで、拡張メタファイルを新しく作成した拡張メタファイルに埋め込むことができます。

この関数によって出力デバイスコンテキストの状態は保持されます。拡張メタファイル内で作成されたが削除されなかったオブジェクトは、すべてこの関数によって削除されます。

この関数を停止するには、アプリケーションは別のスレッドから CancelDC 関数を呼び出して操作を終了できます。この場合、関数は FALSE を返します。

例については、「Opening an Enhanced Metafile and Displaying Its Contents」を参照してください。

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

各言語での呼び出し定義

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

BOOL PlayEnhMetaFile(
    HDC hdc,
    HENHMETAFILE hmf,
    const RECT* lprect
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll", ExactSpelling = true)]
static extern bool PlayEnhMetaFile(
    IntPtr hdc,   // HDC
    IntPtr hmf,   // HENHMETAFILE
    IntPtr lprect   // RECT*
);
<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function PlayEnhMetaFile(
    hdc As IntPtr,   ' HDC
    hmf As IntPtr,   ' HENHMETAFILE
    lprect As IntPtr   ' RECT*
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hdc : HDC
' hmf : HENHMETAFILE
' lprect : RECT*
Declare PtrSafe Function PlayEnhMetaFile Lib "gdi32" ( _
    ByVal hdc As LongPtr, _
    ByVal hmf As LongPtr, _
    ByVal lprect As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

PlayEnhMetaFile = ctypes.windll.gdi32.PlayEnhMetaFile
PlayEnhMetaFile.restype = wintypes.BOOL
PlayEnhMetaFile.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    wintypes.HANDLE,  # hmf : HENHMETAFILE
    ctypes.c_void_p,  # lprect : RECT*
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
PlayEnhMetaFile = Fiddle::Function.new(
  lib['PlayEnhMetaFile'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    Fiddle::TYPE_VOIDP,  # hmf : HENHMETAFILE
    Fiddle::TYPE_VOIDP,  # lprect : RECT*
  ],
  Fiddle::TYPE_INT)
#[link(name = "gdi32")]
extern "system" {
    fn PlayEnhMetaFile(
        hdc: *mut core::ffi::c_void,  // HDC
        hmf: *mut core::ffi::c_void,  // HENHMETAFILE
        lprect: *const RECT  // RECT*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll")]
public static extern bool PlayEnhMetaFile(IntPtr hdc, IntPtr hmf, IntPtr lprect);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_PlayEnhMetaFile' -Namespace Win32 -PassThru
# $api::PlayEnhMetaFile(hdc, hmf, lprect)
#uselib "GDI32.dll"
#func global PlayEnhMetaFile "PlayEnhMetaFile" sptr, sptr, sptr
; PlayEnhMetaFile hdc, hmf, varptr(lprect)   ; 戻り値は stat
; hdc : HDC -> "sptr"
; hmf : HENHMETAFILE -> "sptr"
; lprect : RECT* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "GDI32.dll"
#cfunc global PlayEnhMetaFile "PlayEnhMetaFile" sptr, sptr, var
; res = PlayEnhMetaFile(hdc, hmf, lprect)
; hdc : HDC -> "sptr"
; hmf : HENHMETAFILE -> "sptr"
; lprect : RECT* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL PlayEnhMetaFile(HDC hdc, HENHMETAFILE hmf, RECT* lprect)
#uselib "GDI32.dll"
#cfunc global PlayEnhMetaFile "PlayEnhMetaFile" intptr, intptr, var
; res = PlayEnhMetaFile(hdc, hmf, lprect)
; hdc : HDC -> "intptr"
; hmf : HENHMETAFILE -> "intptr"
; lprect : RECT* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	gdi32 = windows.NewLazySystemDLL("GDI32.dll")
	procPlayEnhMetaFile = gdi32.NewProc("PlayEnhMetaFile")
)

// hdc (HDC), hmf (HENHMETAFILE), lprect (RECT*)
r1, _, err := procPlayEnhMetaFile.Call(
	uintptr(hdc),
	uintptr(hmf),
	uintptr(lprect),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function PlayEnhMetaFile(
  hdc: THandle;   // HDC
  hmf: THandle;   // HENHMETAFILE
  lprect: Pointer   // RECT*
): BOOL; stdcall;
  external 'GDI32.dll' name 'PlayEnhMetaFile';
result := DllCall("GDI32\PlayEnhMetaFile"
    , "Ptr", hdc   ; HDC
    , "Ptr", hmf   ; HENHMETAFILE
    , "Ptr", lprect   ; RECT*
    , "Int")   ; return: BOOL
●PlayEnhMetaFile(hdc, hmf, lprect) = DLL("GDI32.dll", "bool PlayEnhMetaFile(void*, void*, void*)")
# 呼び出し: PlayEnhMetaFile(hdc, hmf, lprect)
# hdc : HDC -> "void*"
# hmf : HENHMETAFILE -> "void*"
# lprect : RECT* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "gdi32" fn PlayEnhMetaFile(
    hdc: ?*anyopaque, // HDC
    hmf: ?*anyopaque, // HENHMETAFILE
    lprect: [*c]RECT // RECT*
) callconv(std.os.windows.WINAPI) i32;
proc PlayEnhMetaFile(
    hdc: pointer,  # HDC
    hmf: pointer,  # HENHMETAFILE
    lprect: ptr RECT  # RECT*
): int32 {.importc: "PlayEnhMetaFile", stdcall, dynlib: "GDI32.dll".}
pragma(lib, "gdi32");
extern(Windows)
int PlayEnhMetaFile(
    void* hdc,   // HDC
    void* hmf,   // HENHMETAFILE
    RECT* lprect   // RECT*
);
ccall((:PlayEnhMetaFile, "GDI32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{Cvoid}, Ptr{RECT}),
      hdc, hmf, lprect)
# hdc : HDC -> Ptr{Cvoid}
# hmf : HENHMETAFILE -> Ptr{Cvoid}
# lprect : RECT* -> Ptr{RECT}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t PlayEnhMetaFile(
    void* hdc,
    void* hmf,
    void* lprect);
]]
local gdi32 = ffi.load("gdi32")
-- gdi32.PlayEnhMetaFile(hdc, hmf, lprect)
-- hdc : HDC
-- hmf : HENHMETAFILE
-- lprect : RECT*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('GDI32.dll');
const PlayEnhMetaFile = lib.func('__stdcall', 'PlayEnhMetaFile', 'int32_t', ['void *', 'void *', 'void *']);
// PlayEnhMetaFile(hdc, hmf, lprect)
// hdc : HDC -> 'void *'
// hmf : HENHMETAFILE -> 'void *'
// lprect : RECT* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("GDI32.dll", {
  PlayEnhMetaFile: { parameters: ["pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.PlayEnhMetaFile(hdc, hmf, lprect)
// hdc : HDC -> "pointer"
// hmf : HENHMETAFILE -> "pointer"
// lprect : RECT* -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t PlayEnhMetaFile(
    void* hdc,
    void* hmf,
    void* lprect);
C, "GDI32.dll");
// $ffi->PlayEnhMetaFile(hdc, hmf, lprect);
// hdc : HDC
// hmf : HENHMETAFILE
// lprect : RECT*
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Gdi32 extends StdCallLibrary {
    Gdi32 INSTANCE = Native.load("gdi32", Gdi32.class);
    boolean PlayEnhMetaFile(
        Pointer hdc,   // HDC
        Pointer hmf,   // HENHMETAFILE
        Pointer lprect   // RECT*
    );
}
@[Link("gdi32")]
lib LibGDI32
  fun PlayEnhMetaFile = PlayEnhMetaFile(
    hdc : Void*,   # HDC
    hmf : Void*,   # HENHMETAFILE
    lprect : RECT*   # RECT*
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef PlayEnhMetaFileNative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Void>);
typedef PlayEnhMetaFileDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Void>);
final PlayEnhMetaFile = DynamicLibrary.open('GDI32.dll')
    .lookupFunction<PlayEnhMetaFileNative, PlayEnhMetaFileDart>('PlayEnhMetaFile');
// hdc : HDC -> Pointer<Void>
// hmf : HENHMETAFILE -> Pointer<Void>
// lprect : RECT* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PlayEnhMetaFile(
  hdc: THandle;   // HDC
  hmf: THandle;   // HENHMETAFILE
  lprect: Pointer   // RECT*
): BOOL; stdcall;
  external 'GDI32.dll' name 'PlayEnhMetaFile';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "PlayEnhMetaFile"
  c_PlayEnhMetaFile :: Ptr () -> Ptr () -> Ptr () -> IO CInt
-- hdc : HDC -> Ptr ()
-- hmf : HENHMETAFILE -> Ptr ()
-- lprect : RECT* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let playenhmetafile =
  foreign "PlayEnhMetaFile"
    ((ptr void) @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* hdc : HDC -> (ptr void) *)
(* hmf : HENHMETAFILE -> (ptr void) *)
(* lprect : RECT* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library gdi32 (t "GDI32.dll"))
(cffi:use-foreign-library gdi32)

(cffi:defcfun ("PlayEnhMetaFile" play-enh-meta-file :convention :stdcall) :int32
  (hdc :pointer)   ; HDC
  (hmf :pointer)   ; HENHMETAFILE
  (lprect :pointer))   ; RECT*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PlayEnhMetaFile = Win32::API::More->new('GDI32',
    'BOOL PlayEnhMetaFile(HANDLE hdc, HANDLE hmf, LPVOID lprect)');
# my $ret = $PlayEnhMetaFile->Call($hdc, $hmf, $lprect);
# hdc : HDC -> HANDLE
# hmf : HENHMETAFILE -> HANDLE
# lprect : RECT* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型