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

SetClipboardViewer

関数
クリップボードビューアチェーンにウィンドウを登録する。
DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

HWND SetClipboardViewer(
    HWND hWndNewViewer
);

パラメーター

名前方向説明
hWndNewViewerHWNDinクリップボードチェーンに追加するウィンドウのハンドルです。

戻り値の型: HWND

公式ドキュメント

指定したウィンドウをクリップボードビューアのチェーンに追加します。クリップボードビューアウィンドウは、クリップボードの内容が変更されるたびに WM_DRAWCLIPBOARD メッセージを受け取ります。この関数は、以前のバージョンの Windows との下位互換性のために使用されます。

戻り値

型: HWND

関数が成功した場合、戻り値はクリップボードビューアチェーン内の次のウィンドウを示します。エラーが発生した場合、またはクリップボードビューアチェーンに他のウィンドウが存在しない場合、戻り値は NULL になります。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

クリップボードビューアチェーンに属するウィンドウ(クリップボードビューアウィンドウと呼ばれます)は、クリップボードメッセージ WM_CHANGECBCHAIN および WM_DRAWCLIPBOARD を処理する必要があります。各クリップボードビューアウィンドウは、SendMessage 関数を呼び出して、これらのメッセージをクリップボードビューアチェーン内の次のウィンドウに渡します。

クリップボードビューアウィンドウは、最終的に ChangeClipboardChain 関数を呼び出して、自身をクリップボードビューアチェーンから削除する必要があります。たとえば、WM_DESTROY メッセージへの応答として削除します。

SetClipboardViewer 関数は、以前のバージョンの Windows との下位互換性を提供するために存在します。クリップボードビューアチェーンは、クリップボードチェーンメッセージを適切に処理しないアプリケーションによって途切れることがあります。新しいアプリケーションでは、クリップボードシーケンス番号やクリップボードフォーマットリスナーの登録など、より堅牢な手法を使用すべきです。これらの代替手法の詳細については、クリップボードの内容の監視を参照してください。

例については、クリップボードビューアチェーンへのウィンドウの追加を参照してください。

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

各言語での呼び出し定義

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

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

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

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

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procSetClipboardViewer = user32.NewProc("SetClipboardViewer")
)

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

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

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

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

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

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

関連項目

公式の関連項目