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

EmptyClipboard

関数
クリップボードを空にし所有権を呼び出し元ウィンドウに移す。
DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL EmptyClipboard(void);

パラメーターなし。戻り値: BOOL

公式ドキュメント

クリップボードを空にし、クリップボード内のデータへのハンドルを解放します。続いて、現在クリップボードを開いているウィンドウにクリップボードの所有権を割り当てます。

戻り値

型: BOOL

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

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

解説(Remarks)

EmptyClipboard を呼び出す前に、アプリケーションは OpenClipboard 関数を使用してクリップボードを開く必要があります。クリップボードを開く際にアプリケーションがウィンドウハンドルとして NULL を指定した場合、EmptyClipboard は成功しますが、クリップボードの所有者を NULL に設定します。この場合、SetClipboardData が失敗することに注意してください。

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

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

各言語での呼び出し定義

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

BOOL EmptyClipboard(void);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool EmptyClipboard();
<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function EmptyClipboard() As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
Declare PtrSafe Function EmptyClipboard Lib "user32" () As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

EmptyClipboard = ctypes.windll.user32.EmptyClipboard
EmptyClipboard.restype = wintypes.BOOL
EmptyClipboard.argtypes = []
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
EmptyClipboard = Fiddle::Function.new(
  lib['EmptyClipboard'],
  [],
  Fiddle::TYPE_INT)
#[link(name = "user32")]
extern "system" {
    fn EmptyClipboard() -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true)]
public static extern bool EmptyClipboard();
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_EmptyClipboard' -Namespace Win32 -PassThru
# $api::EmptyClipboard()
#uselib "USER32.dll"
#func global EmptyClipboard "EmptyClipboard"
; EmptyClipboard   ; 戻り値は stat
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global EmptyClipboard "EmptyClipboard"
; res = EmptyClipboard()
; BOOL EmptyClipboard()
#uselib "USER32.dll"
#cfunc global EmptyClipboard "EmptyClipboard"
; res = EmptyClipboard()
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procEmptyClipboard = user32.NewProc("EmptyClipboard")
)

r1, _, err := procEmptyClipboard.Call()
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function EmptyClipboard: BOOL; stdcall;
  external 'USER32.dll' name 'EmptyClipboard';
result := DllCall("USER32\EmptyClipboard", "Int")
●EmptyClipboard() = DLL("USER32.dll", "bool EmptyClipboard()")
# 呼び出し: EmptyClipboard()
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef EmptyClipboardNative = Int32 Function();
typedef EmptyClipboardDart = int Function();
final EmptyClipboard = DynamicLibrary.open('USER32.dll')
    .lookupFunction<EmptyClipboardNative, EmptyClipboardDart>('EmptyClipboard');
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function EmptyClipboard: BOOL; stdcall;
  external 'USER32.dll' name 'EmptyClipboard';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "EmptyClipboard"
  c_EmptyClipboard :: IO CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let emptyclipboard =
  foreign "EmptyClipboard"
    (void @-> returning int32_t)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("EmptyClipboard" empty-clipboard :convention :stdcall) :int32)
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $EmptyClipboard = Win32::API::More->new('USER32',
    'BOOL EmptyClipboard()');
# my $ret = $EmptyClipboard->Call();
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目