GetEnhMetaFileDescriptionW

GetEnhMetaFileDescription 関数は、拡張形式メタファイルから任意のテキスト記述を取得し、指定バッファへコピーする。(Unicode)

GetEnhMetaFileDescriptionW hemf, cchBuffer, lpDescription

hemf : [intptr] 拡張メタファイルのハンドル。
cchBuffer : [int] データを受け取るバッファのサイズ(文字単位)。この文字数までがコピーされる。
lpDescription : [wstr] 任意のテキスト記述を受け取るバッファへのポインタ。

(プラグイン / モジュール : gdi32.dll)

解説

GetEnhMetaFileDescription
関数は、拡張形式メタファイルから任意のテキスト記述を取得し、指定バッファへコピーする。(Unicode)

[戻り値]
任意のテキスト記述が存在しバッファポインタが NULL
の場合、戻り値はテキスト文字列の長さ(文字単位)である。存在しバッファポインタが有効な場合、戻り値はバッファへコピーされた文字数である。テキスト記述が存在しない場合、戻り値は
0 である。関数が失敗した場合、戻り値は GDI_ERROR である。

[備考]
任意のテキスト記述は 2 つの文字列で構成される。1 つ目は拡張メタファイルを作成したアプリケーションを示し、2
つ目はメタファイルに含まれる画像を示す。文字列は NULL 文字で区切られ、2 つの NULL 文字で終端される。例:"XYZ
Graphics Editor\0Bald Eagle\0\0"(\0 は NULL 文字を表す)。テキスト引数に Unicode
文字を使う必要がある場合はワイド文字版として、Windows 文字セットを使う必要がある場合は ANSI 版として使用する。
> [!NOTE] > wingdi.h ヘッダは GetEnhMetaFileDescription
をエイリアスとして定義しており、UNICODE プリプロセッサ定数の有無に応じてこの関数の ANSI 版または Unicode
版が自動的に選択される。エンコーディング中立なエイリアスと非中立コードを混在させると、コンパイルまたは実行時エラーの原因となる不整合を引き起こすことがある。詳細は
[関数プロトタイプの規則](/windows/win32/intl/conventions-for-function-prototypes)
を参照。

情報