Win32 API 日本語リファレンス
ホームSystem.DataExchange › SetClipboardData

SetClipboardData

関数
指定形式のデータをクリップボードに格納する。
DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

HANDLE SetClipboardData(
    DWORD uFormat,
    HANDLE hMem   // optional
);

パラメーター

名前方向説明
uFormatDWORDinクリップボード形式。このパラメーターには、登録済みの形式または標準のクリップボード形式のいずれかを指定できます。詳細については、標準のクリップボード形式および登録済みのクリップボード形式を参照してください。
hMemHANDLEinoptional

指定した形式のデータへのハンドル。このパラメーターには NULL を指定できます。これは、要求に応じてウィンドウが指定したクリップボード形式でデータを提供する(形式をレンダリングする)ことを示し、遅延レンダリングと呼ばれます。ウィンドウがレンダリングを遅延する場合は、WM_RENDERFORMAT メッセージと WM_RENDERALLFORMATS メッセージを処理する必要があります。

SetClipboardData が成功すると、hMem パラメーターで識別されるオブジェクトの所有権はシステムに移ります。所有権がシステムに移った後、アプリケーションはそのデータに書き込んだり解放したりすることはできませんが、CloseClipboard 関数が呼び出されるまでは、データをロックして読み取ることができます。(クリップボードを閉じる前に、メモリのロックを解除する必要があります。)hMem パラメーターがメモリオブジェクトを識別する場合、そのオブジェクトは GMEM_MOVEABLE フラグを指定した関数を使用して割り当てられている必要があります。

戻り値の型: HANDLE

公式ドキュメント

指定したクリップボード形式でデータをクリップボードに配置します。

戻り値

型: HANDLE

関数が成功した場合、戻り値はデータへのハンドルです。

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

解説(Remarks)

Windows 8: Windows ストアアプリと共有するビットマップは、CF_BITMAP 形式(デバイス依存ビットマップ)である必要があります。

アプリケーションが WM_RENDERFORMAT または WM_RENDERALLFORMATS に応答して SetClipboardData を呼び出す場合、SetClipboardData の呼び出し後にそのハンドルを使用しないでください。

アプリケーションが hwnd を NULL に設定して OpenClipboard を呼び出すと、EmptyClipboard はクリップボードの所有者を NULL に設定します。これにより SetClipboardData は失敗します。

アプリケーションが GetClipboardData 関数を呼び出すと、システムは特定のクリップボード形式間で暗黙的なデータ形式変換を行います。たとえば、CF_OEMTEXT 形式がクリップボードにある場合、ウィンドウは CF_TEXT 形式でデータを取得できます。クリップボード上の形式は、要求に応じて要求された形式に変換されます。詳細については、合成されたクリップボード形式を参照してください。

例については、クリップボードへの情報のコピーを参照してください。

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

各言語での呼び出し定義

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

HANDLE SetClipboardData(
    DWORD uFormat,
    HANDLE hMem   // optional
);
[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr SetClipboardData(
    uint uFormat,   // DWORD
    IntPtr hMem   // HANDLE optional
);
<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetClipboardData(
    uFormat As UInteger,   ' DWORD
    hMem As IntPtr   ' HANDLE optional
) As IntPtr
End Function
' uFormat : DWORD
' hMem : HANDLE optional
Declare PtrSafe Function SetClipboardData Lib "user32" ( _
    ByVal uFormat As Long, _
    ByVal hMem As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetClipboardData = ctypes.windll.user32.SetClipboardData
SetClipboardData.restype = ctypes.c_void_p
SetClipboardData.argtypes = [
    wintypes.DWORD,  # uFormat : DWORD
    wintypes.HANDLE,  # hMem : HANDLE optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
SetClipboardData = Fiddle::Function.new(
  lib['SetClipboardData'],
  [
    -Fiddle::TYPE_INT,  # uFormat : DWORD
    Fiddle::TYPE_VOIDP,  # hMem : HANDLE optional
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "user32")]
extern "system" {
    fn SetClipboardData(
        uFormat: u32,  // DWORD
        hMem: *mut core::ffi::c_void  // HANDLE optional
    ) -> *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 SetClipboardData(uint uFormat, IntPtr hMem);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_SetClipboardData' -Namespace Win32 -PassThru
# $api::SetClipboardData(uFormat, hMem)
#uselib "USER32.dll"
#func global SetClipboardData "SetClipboardData" sptr, sptr
; SetClipboardData uFormat, hMem   ; 戻り値は stat
; uFormat : DWORD -> "sptr"
; hMem : HANDLE optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global SetClipboardData "SetClipboardData" int, sptr
; res = SetClipboardData(uFormat, hMem)
; uFormat : DWORD -> "int"
; hMem : HANDLE optional -> "sptr"
; HANDLE SetClipboardData(DWORD uFormat, HANDLE hMem)
#uselib "USER32.dll"
#cfunc global SetClipboardData "SetClipboardData" int, intptr
; res = SetClipboardData(uFormat, hMem)
; uFormat : DWORD -> "int"
; hMem : HANDLE optional -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procSetClipboardData = user32.NewProc("SetClipboardData")
)

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

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

typedef SetClipboardDataNative = Pointer<Void> Function(Uint32, Pointer<Void>);
typedef SetClipboardDataDart = Pointer<Void> Function(int, Pointer<Void>);
final SetClipboardData = DynamicLibrary.open('USER32.dll')
    .lookupFunction<SetClipboardDataNative, SetClipboardDataDart>('SetClipboardData');
// uFormat : DWORD -> Uint32
// hMem : HANDLE optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetClipboardData(
  uFormat: DWORD;   // DWORD
  hMem: THandle   // HANDLE optional
): THandle; stdcall;
  external 'USER32.dll' name 'SetClipboardData';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetClipboardData"
  c_SetClipboardData :: Word32 -> Ptr () -> IO (Ptr ())
-- uFormat : DWORD -> Word32
-- hMem : HANDLE optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setclipboarddata =
  foreign "SetClipboardData"
    (uint32_t @-> (ptr void) @-> returning (ptr void))
(* uFormat : DWORD -> uint32_t *)
(* hMem : HANDLE optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("SetClipboardData" set-clipboard-data :convention :stdcall) :pointer
  (u-format :uint32)   ; DWORD
  (h-mem :pointer))   ; HANDLE optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetClipboardData = Win32::API::More->new('USER32',
    'HANDLE SetClipboardData(DWORD uFormat, HANDLE hMem)');
# my $ret = $SetClipboardData->Call($uFormat, $hMem);
# uFormat : DWORD -> DWORD
# hMem : HANDLE optional -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目