Win32 API 日本語リファレンス
ホームUI.WindowsAndMessaging › CopyImage

CopyImage

関数
アイコン・カーソル・ビットマップの複製を作成する。
DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

HANDLE CopyImage(
    HANDLE h,
    GDI_IMAGE_TYPE type,
    INT cx,
    INT cy,
    IMAGE_FLAGS flags
);

パラメーター

名前方向説明
hHANDLEinコピーするイメージのハンドルです。
typeGDI_IMAGE_TYPEin

コピーするイメージの種類です。このパラメーターには、次のいずれかの値を指定できます。

意味
IMAGE_BITMAP
0
ビットマップをコピーします。
IMAGE_CURSOR
2
カーソルをコピーします。
IMAGE_ICON
1
アイコンをコピーします。
cxINTinイメージの希望する幅(ピクセル単位)です。これがゼロの場合、返されるイメージは元の hImage と同じ幅になります。
cyINTinイメージの希望する高さ(ピクセル単位)です。これがゼロの場合、返されるイメージは元の hImage と同じ高さになります。
flagsIMAGE_FLAGSin

このパラメーターには、次の値の 1 つ以上を指定できます。

意味
LR_COPYDELETEORG
0x00000008
コピーを作成した後、元のイメージを削除します。
LR_COPYFROMRESOURCE
0x00004000
現在のイメージを単純にコピーするのではなく、元のリソース ファイルからアイコンまたはカーソルのリソースを再読み込みしようとします。これは、リソース ファイルに複数のサイズのリソースが含まれている場合に、異なるサイズのコピーを作成するのに役立ちます。このフラグを指定しない場合、CopyImage は元のイメージを新しいサイズに引き伸ばします。このフラグが設定されている場合、CopyImage はリソース ファイル内の希望するサイズに最も近いサイズを使用します。これは、hImageLoadIcon もしくは LoadCursor によって、または LR_SHARED フラグ付きの LoadImage によって読み込まれた場合にのみ成功します。
LR_COPYRETURNORG
0x00000004
hImage がコピーの条件(つまり正しい寸法と色深度)を満たす場合は、元の hImage を返します。この場合、LR_COPYDELETEORG フラグは無視されます。このフラグを指定しない場合は、常に新しいオブジェクトが作成されます。
LR_CREATEDIBSECTION
0x00002000
これが設定されていて新しいビットマップが作成される場合、ビットマップは DIB セクションとして作成されます。それ以外の場合、ビットマップ イメージはデバイス依存ビットマップとして作成されます。このフラグは、uTypeIMAGE_BITMAP の場合にのみ有効です。
LR_DEFAULTCOLOR
0x00000000
既定の色形式を使用します。
LR_DEFAULTSIZE
0x00000040
cx または cy の値がゼロに設定されている場合に、カーソルまたはアイコンのシステム メトリック値で指定された幅または高さを使用します。このフラグが指定されておらず、cxcy がゼロに設定されている場合、関数は実際のリソース サイズを使用します。リソースに複数のイメージが含まれている場合、関数は最初のイメージのサイズを使用します。
LR_MONOCHROME
0x00000001
新しいモノクロ イメージを作成します。

戻り値の型: HANDLE

公式ドキュメント

新しいイメージ(アイコン、カーソル、またはビットマップ)を作成し、指定したイメージの属性を新しいイメージにコピーします。必要に応じて、この関数は新しいイメージの希望するサイズに合わせてビットを引き伸ばします。

戻り値

型: HANDLE

関数が成功した場合、戻り値は新しく作成されたイメージのハンドルです。

関数が失敗した場合、戻り値は NULL です。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

リソースの使用が終わったら、次の表に示す関数のいずれかを呼び出すことで、関連付けられたメモリを解放できます。

リソース 解放関数
ビットマップ DeleteObject
カーソル DestroyCursor
アイコン DestroyIcon

プロセスが終了するとシステムは自動的にリソースを削除しますが、適切な関数を呼び出すことでメモリを節約し、プロセスのワーキング セットのサイズを減らすことができます。

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

各言語での呼び出し定義

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

HANDLE CopyImage(
    HANDLE h,
    GDI_IMAGE_TYPE type,
    INT cx,
    INT cy,
    IMAGE_FLAGS flags
);
[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr CopyImage(
    IntPtr h,   // HANDLE
    uint type,   // GDI_IMAGE_TYPE
    int cx,   // INT
    int cy,   // INT
    uint flags   // IMAGE_FLAGS
);
<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CopyImage(
    h As IntPtr,   ' HANDLE
    type As UInteger,   ' GDI_IMAGE_TYPE
    cx As Integer,   ' INT
    cy As Integer,   ' INT
    flags As UInteger   ' IMAGE_FLAGS
) As IntPtr
End Function
' h : HANDLE
' type : GDI_IMAGE_TYPE
' cx : INT
' cy : INT
' flags : IMAGE_FLAGS
Declare PtrSafe Function CopyImage Lib "user32" ( _
    ByVal h As LongPtr, _
    ByVal type As Long, _
    ByVal cx As Long, _
    ByVal cy As Long, _
    ByVal flags As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CopyImage = ctypes.windll.user32.CopyImage
CopyImage.restype = ctypes.c_void_p
CopyImage.argtypes = [
    wintypes.HANDLE,  # h : HANDLE
    wintypes.DWORD,  # type : GDI_IMAGE_TYPE
    ctypes.c_int,  # cx : INT
    ctypes.c_int,  # cy : INT
    wintypes.DWORD,  # flags : IMAGE_FLAGS
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
CopyImage = Fiddle::Function.new(
  lib['CopyImage'],
  [
    Fiddle::TYPE_VOIDP,  # h : HANDLE
    -Fiddle::TYPE_INT,  # type : GDI_IMAGE_TYPE
    Fiddle::TYPE_INT,  # cx : INT
    Fiddle::TYPE_INT,  # cy : INT
    -Fiddle::TYPE_INT,  # flags : IMAGE_FLAGS
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "user32")]
extern "system" {
    fn CopyImage(
        h: *mut core::ffi::c_void,  // HANDLE
        type: u32,  // GDI_IMAGE_TYPE
        cx: i32,  // INT
        cy: i32,  // INT
        flags: u32  // IMAGE_FLAGS
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("USER32.dll", SetLastError = true)]
public static extern IntPtr CopyImage(IntPtr h, uint type, int cx, int cy, uint flags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_CopyImage' -Namespace Win32 -PassThru
# $api::CopyImage(h, type, cx, cy, flags)
#uselib "USER32.dll"
#func global CopyImage "CopyImage" sptr, sptr, sptr, sptr, sptr
; CopyImage h, type, cx, cy, flags   ; 戻り値は stat
; h : HANDLE -> "sptr"
; type : GDI_IMAGE_TYPE -> "sptr"
; cx : INT -> "sptr"
; cy : INT -> "sptr"
; flags : IMAGE_FLAGS -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global CopyImage "CopyImage" sptr, int, int, int, int
; res = CopyImage(h, type, cx, cy, flags)
; h : HANDLE -> "sptr"
; type : GDI_IMAGE_TYPE -> "int"
; cx : INT -> "int"
; cy : INT -> "int"
; flags : IMAGE_FLAGS -> "int"
; HANDLE CopyImage(HANDLE h, GDI_IMAGE_TYPE type, INT cx, INT cy, IMAGE_FLAGS flags)
#uselib "USER32.dll"
#cfunc global CopyImage "CopyImage" intptr, int, int, int, int
; res = CopyImage(h, type, cx, cy, flags)
; h : HANDLE -> "intptr"
; type : GDI_IMAGE_TYPE -> "int"
; cx : INT -> "int"
; cy : INT -> "int"
; flags : IMAGE_FLAGS -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procCopyImage = user32.NewProc("CopyImage")
)

// h (HANDLE), type (GDI_IMAGE_TYPE), cx (INT), cy (INT), flags (IMAGE_FLAGS)
r1, _, err := procCopyImage.Call(
	uintptr(h),
	uintptr(type),
	uintptr(cx),
	uintptr(cy),
	uintptr(flags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HANDLE
function CopyImage(
  h: THandle;   // HANDLE
  type: DWORD;   // GDI_IMAGE_TYPE
  cx: Integer;   // INT
  cy: Integer;   // INT
  flags: DWORD   // IMAGE_FLAGS
): THandle; stdcall;
  external 'USER32.dll' name 'CopyImage';
result := DllCall("USER32\CopyImage"
    , "Ptr", h   ; HANDLE
    , "UInt", type   ; GDI_IMAGE_TYPE
    , "Int", cx   ; INT
    , "Int", cy   ; INT
    , "UInt", flags   ; IMAGE_FLAGS
    , "Ptr")   ; return: HANDLE
●CopyImage(h, type, cx, cy, flags) = DLL("USER32.dll", "void* CopyImage(void*, dword, int, int, dword)")
# 呼び出し: CopyImage(h, type, cx, cy, flags)
# h : HANDLE -> "void*"
# type : GDI_IMAGE_TYPE -> "dword"
# cx : INT -> "int"
# cy : INT -> "int"
# flags : IMAGE_FLAGS -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef CopyImageNative = Pointer<Void> Function(Pointer<Void>, Uint32, Int32, Int32, Uint32);
typedef CopyImageDart = Pointer<Void> Function(Pointer<Void>, int, int, int, int);
final CopyImage = DynamicLibrary.open('USER32.dll')
    .lookupFunction<CopyImageNative, CopyImageDart>('CopyImage');
// h : HANDLE -> Pointer<Void>
// type : GDI_IMAGE_TYPE -> Uint32
// cx : INT -> Int32
// cy : INT -> Int32
// flags : IMAGE_FLAGS -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CopyImage(
  h: THandle;   // HANDLE
  type: DWORD;   // GDI_IMAGE_TYPE
  cx: Integer;   // INT
  cy: Integer;   // INT
  flags: DWORD   // IMAGE_FLAGS
): THandle; stdcall;
  external 'USER32.dll' name 'CopyImage';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CopyImage"
  c_CopyImage :: Ptr () -> Word32 -> Int32 -> Int32 -> Word32 -> IO (Ptr ())
-- h : HANDLE -> Ptr ()
-- type : GDI_IMAGE_TYPE -> Word32
-- cx : INT -> Int32
-- cy : INT -> Int32
-- flags : IMAGE_FLAGS -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let copyimage =
  foreign "CopyImage"
    ((ptr void) @-> uint32_t @-> int32_t @-> int32_t @-> uint32_t @-> returning (ptr void))
(* h : HANDLE -> (ptr void) *)
(* type : GDI_IMAGE_TYPE -> uint32_t *)
(* cx : INT -> int32_t *)
(* cy : INT -> int32_t *)
(* flags : IMAGE_FLAGS -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("CopyImage" copy-image :convention :stdcall) :pointer
  (h :pointer)   ; HANDLE
  (type :uint32)   ; GDI_IMAGE_TYPE
  (cx :int32)   ; INT
  (cy :int32)   ; INT
  (flags :uint32))   ; IMAGE_FLAGS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CopyImage = Win32::API::More->new('USER32',
    'HANDLE CopyImage(HANDLE h, DWORD type, int cx, int cy, DWORD flags)');
# my $ret = $CopyImage->Call($h, $type, $cx, $cy, $flags);
# h : HANDLE -> HANDLE
# type : GDI_IMAGE_TYPE -> DWORD
# cx : INT -> int
# cy : INT -> int
# flags : IMAGE_FLAGS -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型