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

OpenClipboard

関数
クリップボードを開いて操作のためにアクセスを取得する。
DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL OpenClipboard(
    HWND hWndNewOwner   // optional
);

パラメーター

名前方向説明
hWndNewOwnerHWNDinoptional開いたクリップボードに関連付けるウィンドウへのハンドルです。このパラメーターが NULL の場合、開いたクリップボードは現在のタスクに関連付けられます。

戻り値の型: BOOL

公式ドキュメント

クリップボードを検査用に開き、他のアプリケーションがクリップボードの内容を変更できないようにします。

戻り値

型: BOOL

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

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

解説(Remarks)

他のウィンドウがクリップボードを開いている場合、OpenClipboard は失敗します。

アプリケーションは、OpenClipboard の呼び出しが成功するたびに、その後 CloseClipboard 関数を呼び出す必要があります。

hWndNewOwner パラメーターで指定されたウィンドウは、EmptyClipboard 関数が呼び出されない限り、クリップボードの所有者にはなりません。

アプリケーションが hwnd を NULL に設定して OpenClipboard を呼び出した場合、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 OpenClipboard(
    HWND hWndNewOwner   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool OpenClipboard(
    IntPtr hWndNewOwner   // HWND optional
);
<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function OpenClipboard(
    hWndNewOwner As IntPtr   ' HWND optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hWndNewOwner : HWND optional
Declare PtrSafe Function OpenClipboard Lib "user32" ( _
    ByVal hWndNewOwner As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

OpenClipboard = ctypes.windll.user32.OpenClipboard
OpenClipboard.restype = wintypes.BOOL
OpenClipboard.argtypes = [
    wintypes.HANDLE,  # hWndNewOwner : HWND optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procOpenClipboard = user32.NewProc("OpenClipboard")
)

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

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

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

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

let openclipboard =
  foreign "OpenClipboard"
    ((ptr void) @-> returning int32_t)
(* hWndNewOwner : HWND 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 ("OpenClipboard" open-clipboard :convention :stdcall) :int32
  (h-wnd-new-owner :pointer))   ; HWND optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $OpenClipboard = Win32::API::More->new('USER32',
    'BOOL OpenClipboard(HANDLE hWndNewOwner)');
# my $ret = $OpenClipboard->Call($hWndNewOwner);
# hWndNewOwner : HWND optional -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目