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

GdipComment

関数
メタファイルにコメントデータを記録する。
DLLgdiplus.dll呼出規約winapi

シグネチャ

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

Status GdipComment(
    GpGraphics* graphics,
    DWORD sizeData,
    const BYTE* data
);

パラメーター

名前方向説明
graphicsGpGraphics*inout対象グラフィックスオブジェクトへのポインタ。メタファイル記録時に使用する。
sizeDataDWORDindataが指すコメントデータのバイト数。
dataBYTE*inメタファイルへ埋め込むコメントのバイナリデータへのポインタ。

戻り値の型: Status

各言語での呼び出し定義

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

Status GdipComment(
    GpGraphics* graphics,
    DWORD sizeData,
    const BYTE* data
);
[DllImport("gdiplus.dll", ExactSpelling = true)]
static extern int GdipComment(
    IntPtr graphics,   // GpGraphics* in/out
    uint sizeData,   // DWORD
    IntPtr data   // BYTE*
);
<DllImport("gdiplus.dll", ExactSpelling:=True)>
Public Shared Function GdipComment(
    graphics As IntPtr,   ' GpGraphics* in/out
    sizeData As UInteger,   ' DWORD
    data As IntPtr   ' BYTE*
) As Integer
End Function
' graphics : GpGraphics* in/out
' sizeData : DWORD
' data : BYTE*
Declare PtrSafe Function GdipComment Lib "gdiplus" ( _
    ByVal graphics As LongPtr, _
    ByVal sizeData As Long, _
    ByVal data As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GdipComment = ctypes.windll.gdiplus.GdipComment
GdipComment.restype = ctypes.c_int
GdipComment.argtypes = [
    ctypes.c_void_p,  # graphics : GpGraphics* in/out
    wintypes.DWORD,  # sizeData : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # data : BYTE*
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('gdiplus.dll')
GdipComment = Fiddle::Function.new(
  lib['GdipComment'],
  [
    Fiddle::TYPE_VOIDP,  # graphics : GpGraphics* in/out
    -Fiddle::TYPE_INT,  # sizeData : DWORD
    Fiddle::TYPE_VOIDP,  # data : BYTE*
  ],
  Fiddle::TYPE_INT)
#[link(name = "gdiplus")]
extern "system" {
    fn GdipComment(
        graphics: *mut GpGraphics,  // GpGraphics* in/out
        sizeData: u32,  // DWORD
        data: *const u8  // BYTE*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("gdiplus.dll")]
public static extern int GdipComment(IntPtr graphics, uint sizeData, IntPtr data);
"@
$api = Add-Type -MemberDefinition $sig -Name 'gdiplus_GdipComment' -Namespace Win32 -PassThru
# $api::GdipComment(graphics, sizeData, data)
#uselib "gdiplus.dll"
#func global GdipComment "GdipComment" sptr, sptr, sptr
; GdipComment varptr(graphics), sizeData, varptr(data)   ; 戻り値は stat
; graphics : GpGraphics* in/out -> "sptr"
; sizeData : DWORD -> "sptr"
; data : BYTE* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "gdiplus.dll"
#cfunc global GdipComment "GdipComment" var, int, var
; res = GdipComment(graphics, sizeData, data)
; graphics : GpGraphics* in/out -> "var"
; sizeData : DWORD -> "int"
; data : BYTE* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; Status GdipComment(GpGraphics* graphics, DWORD sizeData, BYTE* data)
#uselib "gdiplus.dll"
#cfunc global GdipComment "GdipComment" var, int, var
; res = GdipComment(graphics, sizeData, data)
; graphics : GpGraphics* in/out -> "var"
; sizeData : DWORD -> "int"
; data : BYTE* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	gdiplus = windows.NewLazySystemDLL("gdiplus.dll")
	procGdipComment = gdiplus.NewProc("GdipComment")
)

// graphics (GpGraphics* in/out), sizeData (DWORD), data (BYTE*)
r1, _, err := procGdipComment.Call(
	uintptr(graphics),
	uintptr(sizeData),
	uintptr(data),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // Status
function GdipComment(
  graphics: Pointer;   // GpGraphics* in/out
  sizeData: DWORD;   // DWORD
  data: Pointer   // BYTE*
): Integer; stdcall;
  external 'gdiplus.dll' name 'GdipComment';
result := DllCall("gdiplus\GdipComment"
    , "Ptr", graphics   ; GpGraphics* in/out
    , "UInt", sizeData   ; DWORD
    , "Ptr", data   ; BYTE*
    , "Int")   ; return: Status
●GdipComment(graphics, sizeData, data) = DLL("gdiplus.dll", "int GdipComment(void*, dword, void*)")
# 呼び出し: GdipComment(graphics, sizeData, data)
# graphics : GpGraphics* in/out -> "void*"
# sizeData : DWORD -> "dword"
# data : BYTE* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "gdiplus" fn GdipComment(
    graphics: [*c]GpGraphics, // GpGraphics* in/out
    sizeData: u32, // DWORD
    data: [*c]u8 // BYTE*
) callconv(std.os.windows.WINAPI) i32;
proc GdipComment(
    graphics: ptr GpGraphics,  # GpGraphics* in/out
    sizeData: uint32,  # DWORD
    data: ptr uint8  # BYTE*
): int32 {.importc: "GdipComment", stdcall, dynlib: "gdiplus.dll".}
pragma(lib, "gdiplus");
extern(Windows)
int GdipComment(
    GpGraphics* graphics,   // GpGraphics* in/out
    uint sizeData,   // DWORD
    ubyte* data   // BYTE*
);
ccall((:GdipComment, "gdiplus.dll"), stdcall, Int32,
      (Ptr{GpGraphics}, UInt32, Ptr{UInt8}),
      graphics, sizeData, data)
# graphics : GpGraphics* in/out -> Ptr{GpGraphics}
# sizeData : DWORD -> UInt32
# data : BYTE* -> Ptr{UInt8}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t GdipComment(
    void* graphics,
    uint32_t sizeData,
    uint8_t* data);
]]
local gdiplus = ffi.load("gdiplus")
-- gdiplus.GdipComment(graphics, sizeData, data)
-- graphics : GpGraphics* in/out
-- sizeData : DWORD
-- data : BYTE*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('gdiplus.dll');
const GdipComment = lib.func('__stdcall', 'GdipComment', 'int32_t', ['void *', 'uint32_t', 'uint8_t *']);
// GdipComment(graphics, sizeData, data)
// graphics : GpGraphics* in/out -> 'void *'
// sizeData : DWORD -> 'uint32_t'
// data : BYTE* -> 'uint8_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("gdiplus.dll", {
  GdipComment: { parameters: ["pointer", "u32", "pointer"], result: "i32" },
});
// lib.symbols.GdipComment(graphics, sizeData, data)
// graphics : GpGraphics* in/out -> "pointer"
// sizeData : DWORD -> "u32"
// data : BYTE* -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t GdipComment(
    void* graphics,
    uint32_t sizeData,
    uint8_t* data);
C, "gdiplus.dll");
// $ffi->GdipComment(graphics, sizeData, data);
// graphics : GpGraphics* in/out
// sizeData : DWORD
// data : BYTE*
// 構造体/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 Gdiplus extends StdCallLibrary {
    Gdiplus INSTANCE = Native.load("gdiplus", Gdiplus.class);
    int GdipComment(
        Pointer graphics,   // GpGraphics* in/out
        int sizeData,   // DWORD
        byte[] data   // BYTE*
    );
}
@[Link("gdiplus")]
lib Libgdiplus
  fun GdipComment = GdipComment(
    graphics : GpGraphics*,   # GpGraphics* in/out
    sizeData : UInt32,   # DWORD
    data : UInt8*   # BYTE*
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GdipCommentNative = Int32 Function(Pointer<Void>, Uint32, Pointer<Uint8>);
typedef GdipCommentDart = int Function(Pointer<Void>, int, Pointer<Uint8>);
final GdipComment = DynamicLibrary.open('gdiplus.dll')
    .lookupFunction<GdipCommentNative, GdipCommentDart>('GdipComment');
// graphics : GpGraphics* in/out -> Pointer<Void>
// sizeData : DWORD -> Uint32
// data : BYTE* -> Pointer<Uint8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GdipComment(
  graphics: Pointer;   // GpGraphics* in/out
  sizeData: DWORD;   // DWORD
  data: Pointer   // BYTE*
): Integer; stdcall;
  external 'gdiplus.dll' name 'GdipComment';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GdipComment"
  c_GdipComment :: Ptr () -> Word32 -> Ptr Word8 -> IO Int32
-- graphics : GpGraphics* in/out -> Ptr ()
-- sizeData : DWORD -> Word32
-- data : BYTE* -> Ptr Word8
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let gdipcomment =
  foreign "GdipComment"
    ((ptr void) @-> uint32_t @-> (ptr uint8_t) @-> returning int32_t)
(* graphics : GpGraphics* in/out -> (ptr void) *)
(* sizeData : DWORD -> uint32_t *)
(* data : BYTE* -> (ptr uint8_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library gdiplus (t "gdiplus.dll"))
(cffi:use-foreign-library gdiplus)

(cffi:defcfun ("GdipComment" gdip-comment :convention :stdcall) :int32
  (graphics :pointer)   ; GpGraphics* in/out
  (size-data :uint32)   ; DWORD
  (data :pointer))   ; BYTE*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GdipComment = Win32::API::More->new('gdiplus',
    'int GdipComment(LPVOID graphics, DWORD sizeData, LPVOID data)');
# my $ret = $GdipComment->Call($graphics, $sizeData, $data);
# graphics : GpGraphics* in/out -> LPVOID
# sizeData : DWORD -> DWORD
# data : BYTE* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型