GetEnhMetaFileDescriptionA 関数 (wingdi.h)

  • [アーティクル]

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

構文

UINT GetEnhMetaFileDescriptionA(
  [in]  HENHMETAFILE hemf,
  [in]  UINT         cchBuffer,
  [out] LPSTR        lpDescription
);

パラメーター

[in] hemf

拡張メタファイルへのハンドル。

[in] cchBuffer

データを受信するバッファーのサイズ (文字数)。 この多くの文字のみがコピーされます。

[out] lpDescription

省略可能なテキストの説明を受け取るバッファーへのポインター。

戻り値

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

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

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

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

解説

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

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

注意

wingdi.h ヘッダーは、GetEnhMetaFileDescription をエイリアスとして定義し、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

   
サポートされている最小のクライアント Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー wingdi.h (Windows.h を含む)
Library Gdi32.lib
[DLL] Gdi32.dll

関連項目

CreateEnhMetaFile

メタファイル関数

メタファイルの概要