GdiComment

関数

拡張メタファイルに任意のコメントデータを記録する。

DLLGDI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

BOOL GdiComment(
    HDC hdc,
    DWORD nSize,
    const BYTE* lpData
);

パラメーター

名前	型	方向	説明
hdc	HDC	in	拡張メタファイルデバイスコンテキストへのハンドル。
nSize	DWORD	in	コメントバッファの長さ(バイト単位)。
lpData	BYTE*	in	コメントを格納したバッファへのポインタ。

戻り値の型: BOOL

公式ドキュメント

GdiComment 関数は、バッファ内のコメントを指定された拡張形式メタファイルにコピーします。

戻り値

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

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

解説(Remarks)

コメントには、たとえば画像の出典や作成日など、任意の種類の独自情報を含めることができます。コメントは、アプリケーションのシグネチャで始まり、その後にデータを続ける必要があります。

コメントには、アプリケーション固有のデータや位置固有のデータを含めるべきではありません。位置固有のデータはレコードの場所を指定するものであり、あるメタファイルが別のメタファイルに埋め込まれる可能性があるため、含めるべきではありません。

パブリックコメントとは、コメントシグネチャ識別子 GDICOMMENT_IDENTIFIER で始まるコメントです。次のパブリックコメントが定義されています。

GDICOMMENT_WINDOWS_METAFILE

GDICOMMENT_WINDOWS_METAFILE パブリックコメントには、拡張形式メタファイルと同等の Windows 形式メタファイルが含まれます。このコメントは SetWinMetaFileBits 関数によってのみ書き込まれます。コメントレコードは、存在する場合、ENHMETAHEADER メタファイルレコードの後に続きます。コメントは次の形式を持ちます。


DWORD ident;         // This contains GDICOMMENT_IDENTIFIER.  
DWORD iComment;      // This contains GDICOMMENT_WINDOWS_METAFILE.  
DWORD nVersion;      // This contains the version number of the  
                     // Windows-format metafile.  
DWORD nChecksum;     // This is the additive DWORD checksum for  
                     // the enhanced metafile.  The checksum  
                     // for the enhanced metafile data including  
                     // this comment record must be zero.  
                     // Otherwise, the enhanced metafile has been  
                     //  modified and the Windows-format  
                     // metafile is no longer valid.  
DWORD fFlags;        // This must be zero.  
DWORD cbWinMetaFile; // This is the size, in bytes. of the  
                     // Windows-format metafile data that follows.

GDICOMMENT_BEGINGROUP

GDICOMMENT_BEGINGROUP パブリックコメントは、描画レコードのグループの開始を示します。これは拡張メタファイル内のオブジェクトを識別します。コメントは次の形式を持ちます。


DWORD   ident;         // This contains GDICOMMENT_IDENTIFIER.  
DWORD   iComment;      // This contains GDICOMMENT_BEGINGROUP.  
RECTL   rclOutput;     // This is the bounding rectangle for the  
                       // object in logical coordinates.  
DWORD   nDescription;  // This is the number of characters in the  
                       // optional Unicode description string that  
                       // follows. This is zero if there is no  
                       // description string.

GDICOMMENT_ENDGROUP

GDICOMMENT_ENDGROUP パブリックコメントは、描画レコードのグループの終了を示します。GDICOMMENT_BEGINGROUP コメントと GDICOMMENT_ENDGROUP コメントは必ずペアで含める必要があり、ネストすることもできます。コメントは次の形式を持ちます。


DWORD   ident;       // This contains GDICOMMENT_IDENTIFIER.  
DWORD   iComment;    // This contains GDICOMMENT_ENDGROUP.

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

各言語での呼び出し定義

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

BOOL GdiComment(
    HDC hdc,
    DWORD nSize,
    const BYTE* lpData
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll", ExactSpelling = true)]
static extern bool GdiComment(
    IntPtr hdc,   // HDC
    uint nSize,   // DWORD
    IntPtr lpData   // BYTE*
);

<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function GdiComment(
    hdc As IntPtr,   ' HDC
    nSize As UInteger,   ' DWORD
    lpData As IntPtr   ' BYTE*
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hdc : HDC
' nSize : DWORD
' lpData : BYTE*
Declare PtrSafe Function GdiComment Lib "gdi32" ( _
    ByVal hdc As LongPtr, _
    ByVal nSize As Long, _
    ByVal lpData As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GdiComment = ctypes.windll.gdi32.GdiComment
GdiComment.restype = wintypes.BOOL
GdiComment.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    wintypes.DWORD,  # nSize : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # lpData : BYTE*
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
GdiComment = Fiddle::Function.new(
  lib['GdiComment'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    -Fiddle::TYPE_INT,  # nSize : DWORD
    Fiddle::TYPE_VOIDP,  # lpData : BYTE*
  ],
  Fiddle::TYPE_INT)

#[link(name = "gdi32")]
extern "system" {
    fn GdiComment(
        hdc: *mut core::ffi::c_void,  // HDC
        nSize: u32,  // DWORD
        lpData: *const u8  // BYTE*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll")]
public static extern bool GdiComment(IntPtr hdc, uint nSize, IntPtr lpData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_GdiComment' -Namespace Win32 -PassThru
# $api::GdiComment(hdc, nSize, lpData)

#uselib "GDI32.dll"
#func global GdiComment "GdiComment" sptr, sptr, sptr
; GdiComment hdc, nSize, varptr(lpData)   ; 戻り値は stat
; hdc : HDC -> "sptr"
; nSize : DWORD -> "sptr"
; lpData : BYTE* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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