ホーム › Graphics.Gdi › GetEnhMetaFileDescriptionW

GetEnhMetaFileDescriptionW

関数

拡張メタファイルの説明テキストを取得する(Unicode版)。

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

シグネチャ

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

DWORD GetEnhMetaFileDescriptionW(
    HENHMETAFILE hemf,
    DWORD cchBuffer,
    LPWSTR lpDescription   // optional
);

パラメーター

名前	型	方向	説明
hemf	HENHMETAFILE	in	拡張メタファイルへのハンドルです。
cchBuffer	DWORD	in	データを受け取るバッファのサイズを文字数で指定します。この文字数分だけがコピーされます。
lpDescription	LPWSTR	outoptional	省略可能なテキスト説明を受け取るバッファへのポインターです。

戻り値の型: DWORD

公式ドキュメント

GetEnhMetaFileDescription 関数は、拡張形式メタファイルから省略可能なテキスト説明を取得し、その文字列を指定されたバッファにコピーします。(Unicode)

戻り値

省略可能なテキスト説明が存在し、バッファポインターが NULL の場合、戻り値はテキスト文字列の長さ(文字数)です。

省略可能なテキスト説明が存在し、バッファポインターが有効なポインターの場合、戻り値はバッファにコピーされた文字数です。

省略可能なテキスト説明が存在しない場合、戻り値は 0 です。

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

解説(Remarks)

省略可能なテキスト説明には 2 つの文字列が含まれます。1 つ目は拡張メタファイルを作成したアプリケーションを示し、2 つ目はメタファイルに含まれる絵を示します。これらの文字列は null 文字で区切られ、2 つの null 文字で終端されます。たとえば、"XYZ Graphics Editor\0Bald Eagle\0\0" のようになります(\0 は null 文字を表します)。

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

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

DWORD GetEnhMetaFileDescriptionW(
    HENHMETAFILE hemf,
    DWORD cchBuffer,
    LPWSTR lpDescription   // optional
);

[DllImport("GDI32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint GetEnhMetaFileDescriptionW(
    IntPtr hemf,   // HENHMETAFILE
    uint cchBuffer,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpDescription   // LPWSTR optional, out
);

<DllImport("GDI32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function GetEnhMetaFileDescriptionW(
    hemf As IntPtr,   ' HENHMETAFILE
    cchBuffer As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> lpDescription As System.Text.StringBuilder   ' LPWSTR optional, out
) As UInteger
End Function

' hemf : HENHMETAFILE
' cchBuffer : DWORD
' lpDescription : LPWSTR optional, out
Declare PtrSafe Function GetEnhMetaFileDescriptionW Lib "gdi32" ( _
    ByVal hemf As LongPtr, _
    ByVal cchBuffer As Long, _
    ByVal lpDescription As LongPtr) As Long
' 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

GetEnhMetaFileDescriptionW = ctypes.windll.gdi32.GetEnhMetaFileDescriptionW
GetEnhMetaFileDescriptionW.restype = wintypes.DWORD
GetEnhMetaFileDescriptionW.argtypes = [
    wintypes.HANDLE,  # hemf : HENHMETAFILE
    wintypes.DWORD,  # cchBuffer : DWORD
    wintypes.LPWSTR,  # lpDescription : LPWSTR optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
GetEnhMetaFileDescriptionW = Fiddle::Function.new(
  lib['GetEnhMetaFileDescriptionW'],
  [
    Fiddle::TYPE_VOIDP,  # hemf : HENHMETAFILE
    -Fiddle::TYPE_INT,  # cchBuffer : DWORD
    Fiddle::TYPE_VOIDP,  # lpDescription : LPWSTR optional, out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

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

$sig = @"
[DllImport("GDI32.dll", CharSet = CharSet.Unicode)]
public static extern uint GetEnhMetaFileDescriptionW(IntPtr hemf, uint cchBuffer, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpDescription);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_GetEnhMetaFileDescriptionW' -Namespace Win32 -PassThru
# $api::GetEnhMetaFileDescriptionW(hemf, cchBuffer, lpDescription)

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

出力引数:

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